Difference between revisions of "Component: Visi (4DSystems) (Comms: System)"

From Flowcode Help
Jump to navigationJump to search
Line 22: Line 22:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 34: Line 36:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 46: Line 50:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''VisiWriteString'''
 +
|-
 +
| colspan="2" | Writes a string to a specific Visi object. Returns 0 for a succesful write operation. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | StringIndex
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | StringData
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''VisiWriteObject'''
 +
|-
 +
| colspan="2" | Writes a value to a specific Visi object. Returns 0 for a succesful write operation. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ObjectID
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ObjectIndex
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ChangeHWBaud'''
 +
|-
 +
| colspan="2" | Changes the hardware UART baud rate allowing for dynamic speed changes.  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | NewBaud
 +
|-
 +
| colspan="2" | 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''VisiReceive'''
 +
|-
 +
| colspan="2" | Waits for an incoming Visi Report Object or Report Event to be sent from the display. A detected incoming message returns 0 and can be read using the VisiReadByteFromMessage macro.  
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''VisiWriteContrast'''
 +
|-
 +
| colspan="2" | Updates the display contrast. Returns 0 for a succesful write operation. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Contrast
 +
|-
 +
| colspan="2" | Range 0-15, 0=Backlight Off 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''VisiWriteVolume'''
 +
|-
 +
| colspan="2" | Updates the display volume. Returns 0 for a succesful write operation. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Volume
 +
|-
 +
| colspan="2" | Range 8-127 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''VisiReadByteFromMessage'''
 +
|-
 +
| colspan="2" | Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''VisiReadObject'''
 +
|-
 +
| colspan="2" | Reads the value from a specific Visi object. Returns 0 for a sucessful read. Use the VisiReadByteFromMessage macro to pull out the incoming data. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ObjectID
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ObjectIndex
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Sets up the RS232 peripheral, must be called at the start of your program or at least before you start calling any other RS232 macros. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Comms Settings
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Baud Options
 +
|-
 +
| colspan="2" | Baud rate option selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Baud Rate
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | TX
 +
|-
 +
| colspan="2" | Pin to be used for Transmit data 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | RX
 +
|-
 +
| colspan="2" | Pin to be used for Receive data 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Label
 +
|-
 +
| colspan="2" | Label shown on the communications flasher component 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Scope Traces
 +
|-
 +
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not.    Simulation - draws an approximation of the UART data onto the scope trace.    ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Console Data
 +
|-
 +
| colspan="2" | Selects if the console data is automatically generated or not 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Console Columns
 +
|-
 +
| colspan="2" | Number of characters that can be displayed on a single line of the console. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Data Source
 +
|-
 +
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices    Nothing - Simulation data is ignored    COM port - Routes the communication data to and from a physical or virtual COM port      Injector - Routes the communication data via a data injector component on the Panel. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:54, 27 January 2023

Author Matrix Ltd.
Version 2.0
Category Comms: System


Visi (4DSystems) component

A way of interacting with the VISI interface designed by 4D systems. VISI firmware must be pre-loaded onto the SD card connected to the display to allow everything to work correctly.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_API_Display_Visi4D.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_API_Display_Visi4D.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Fc9-comp-macro.png VisiWriteString
Writes a string to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE StringIndex
 
Fc9-string-icon.png - STRING StringData
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteObject
Writes a value to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u16-icon.png - UINT Value
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ChangeHWBaud
Changes the hardware UART baud rate allowing for dynamic speed changes.  
Fc9-u8-icon.png - BYTE NewBaud
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png VisiReceive
Waits for an incoming Visi Report Object or Report Event to be sent from the display. A detected incoming message returns 0 and can be read using the VisiReadByteFromMessage macro.  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteContrast
Updates the display contrast. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Contrast
Range 0-15, 0=Backlight Off 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteVolume
Updates the display volume. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Volume
Range 8-127 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadByteFromMessage
Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadObject
Reads the value from a specific Visi object. Returns 0 for a sucessful read. Use the VisiReadByteFromMessage macro to pull out the incoming data. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Initialise
Sets up the RS232 peripheral, must be called at the start of your program or at least before you start calling any other RS232 macros. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Comms Settings
Fc9-type-16-icon.png Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png TX
Pin to be used for Transmit data 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
Label shown on the communications flasher component 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. 

==Macro reference==

Fc9-comp-macro.png VisiWriteString
Writes a string to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE StringIndex
 
Fc9-string-icon.png - STRING StringData
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteObject
Writes a value to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u16-icon.png - UINT Value
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ChangeHWBaud
Changes the hardware UART baud rate allowing for dynamic speed changes.  
Fc9-u8-icon.png - BYTE NewBaud
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png VisiReceive
Waits for an incoming Visi Report Object or Report Event to be sent from the display. A detected incoming message returns 0 and can be read using the VisiReadByteFromMessage macro.  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteContrast
Updates the display contrast. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Contrast
Range 0-15, 0=Backlight Off 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteVolume
Updates the display volume. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Volume
Range 8-127 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadByteFromMessage
Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadObject
Reads the value from a specific Visi object. Returns 0 for a sucessful read. Use the VisiReadByteFromMessage macro to pull out the incoming data. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Initialise
Sets up the RS232 peripheral, must be called at the start of your program or at least before you start calling any other RS232 macros. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Comms Settings
Fc9-type-16-icon.png Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png TX
Pin to be used for Transmit data 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
Label shown on the communications flasher component 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. 

==Macro reference==

Fc9-comp-macro.png VisiWriteString
Writes a string to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE StringIndex
 
Fc9-string-icon.png - STRING StringData
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteObject
Writes a value to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u16-icon.png - UINT Value
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ChangeHWBaud
Changes the hardware UART baud rate allowing for dynamic speed changes.  
Fc9-u8-icon.png - BYTE NewBaud
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png VisiReceive
Waits for an incoming Visi Report Object or Report Event to be sent from the display. A detected incoming message returns 0 and can be read using the VisiReadByteFromMessage macro.  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteContrast
Updates the display contrast. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Contrast
Range 0-15, 0=Backlight Off 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteVolume
Updates the display volume. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Volume
Range 8-127 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadByteFromMessage
Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadObject
Reads the value from a specific Visi object. Returns 0 for a sucessful read. Use the VisiReadByteFromMessage macro to pull out the incoming data. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Initialise
Sets up the RS232 peripheral, must be called at the start of your program or at least before you start calling any other RS232 macros. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Comms Settings
Fc9-type-16-icon.png Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png TX
Pin to be used for Transmit data 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
Label shown on the communications flasher component 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. 

==Macro reference==

Fc9-comp-macro.png VisiWriteString
Writes a string to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE StringIndex
 
Fc9-string-icon.png - STRING StringData
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteObject
Writes a value to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u16-icon.png - UINT Value
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ChangeHWBaud
Changes the hardware UART baud rate allowing for dynamic speed changes.  
Fc9-u8-icon.png - BYTE NewBaud
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png VisiReceive
Waits for an incoming Visi Report Object or Report Event to be sent from the display. A detected incoming message returns 0 and can be read using the VisiReadByteFromMessage macro.  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteContrast
Updates the display contrast. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Contrast
Range 0-15, 0=Backlight Off 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteVolume
Updates the display volume. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Volume
Range 8-127 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadByteFromMessage
Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadObject
Reads the value from a specific Visi object. Returns 0 for a sucessful read. Use the VisiReadByteFromMessage macro to pull out the incoming data. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Initialise
Sets up the RS232 peripheral, must be called at the start of your program or at least before you start calling any other RS232 macros. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Comms Settings
Fc9-type-16-icon.png Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png TX
Pin to be used for Transmit data 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
Label shown on the communications flasher component 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. 

==Macro reference==

Fc9-comp-macro.png VisiWriteString
Writes a string to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE StringIndex
 
Fc9-string-icon.png - STRING StringData
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteObject
Writes a value to a specific Visi object. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u16-icon.png - UINT Value
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ChangeHWBaud
Changes the hardware UART baud rate allowing for dynamic speed changes.  
Fc9-u8-icon.png - BYTE NewBaud
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png VisiReceive
Waits for an incoming Visi Report Object or Report Event to be sent from the display. A detected incoming message returns 0 and can be read using the VisiReadByteFromMessage macro.  
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteContrast
Updates the display contrast. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Contrast
Range 0-15, 0=Backlight Off 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiWriteVolume
Updates the display volume. Returns 0 for a succesful write operation. 
Fc9-u8-icon.png - BYTE Volume
Range 8-127 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadByteFromMessage
Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png VisiReadObject
Reads the value from a specific Visi object. Returns 0 for a sucessful read. Use the VisiReadByteFromMessage macro to pull out the incoming data. 
Fc9-u8-icon.png - BYTE ObjectID
 
Fc9-u8-icon.png - BYTE ObjectIndex
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Initialise
Sets up the RS232 peripheral, must be called at the start of your program or at least before you start calling any other RS232 macros. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Comms Settings
Fc9-type-16-icon.png Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png TX
Pin to be used for Transmit data 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
Label shown on the communications flasher component 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel.