Component: Visi (4DSystems) (Comms: System)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd. |
| Version | 2.0 |
| Category | Comms: System |
Contents
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
|
VisiWriteString |
| Writes a string to a specific Visi object. Returns 0 for a succesful write operation. | |
 - BYTE
|
StringIndex |
 - STRING
|
StringData |
| - BYTE
|
Return |
|
|
VisiWriteObject |
| Writes a value to a specific Visi object. Returns 0 for a succesful write operation. | |
| - BYTE
|
ObjectID |
| - BYTE
|
ObjectIndex |
 - UINT
|
Value |
| - BYTE
|
Return |
|
|
ChangeHWBaud |
| Changes the hardware UART baud rate allowing for dynamic speed changes. | |
| - BYTE
|
NewBaud |
| 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 | |
 - VOID
|
Return |
|
|
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. | |
| - BYTE
|
Return |
|
|
VisiWriteContrast |
| Updates the display contrast. Returns 0 for a succesful write operation. | |
| - BYTE
|
Contrast |
| Range 0-15, 0=Backlight Off | |
| - BYTE
|
Return |
|
|
VisiWriteVolume |
| Updates the display volume. Returns 0 for a succesful write operation. | |
| - BYTE
|
Volume |
| Range 8-127 | |
| - BYTE
|
Return |
|
|
VisiReadByteFromMessage |
| Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB | |
| - BYTE
|
Index |
| - BYTE
|
Return |
|
|
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. | |
| - BYTE
|
ObjectID |
| - BYTE
|
ObjectIndex |
| - BYTE
|
Return |
|
|
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. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Comms Settings |
|
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. | |
|
|
Baud Options |
| Baud rate option selector | |
|
Baud Rate |
|
|
Connections |
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Simulation |
|
Label |
| Label shown on the communications flasher component | |
|
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. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
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==
|
|
VisiWriteString |
| Writes a string to a specific Visi object. Returns 0 for a succesful write operation. | |
| - BYTE
|
StringIndex |
| - STRING
|
StringData |
| - BYTE
|
Return |
|
|
VisiWriteObject |
| Writes a value to a specific Visi object. Returns 0 for a succesful write operation. | |
| - BYTE
|
ObjectID |
| - BYTE
|
ObjectIndex |
| - UINT
|
Value |
| - BYTE
|
Return |
|
|
ChangeHWBaud |
| Changes the hardware UART baud rate allowing for dynamic speed changes. | |
| - BYTE
|
NewBaud |
| 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 | |
| - VOID
|
Return |
|
|
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. | |
| - BYTE
|
Return |
|
|
VisiWriteContrast |
| Updates the display contrast. Returns 0 for a succesful write operation. | |
| - BYTE
|
Contrast |
| Range 0-15, 0=Backlight Off | |
| - BYTE
|
Return |
|
|
VisiWriteVolume |
| Updates the display volume. Returns 0 for a succesful write operation. | |
| - BYTE
|
Volume |
| Range 8-127 | |
| - BYTE
|
Return |
|
|
VisiReadByteFromMessage |
| Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB | |
| - BYTE
|
Index |
| - BYTE
|
Return |
|
|
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. | |
| - BYTE
|
ObjectID |
| - BYTE
|
ObjectIndex |
| - BYTE
|
Return |
|
|
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. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Comms Settings |
|
|
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. | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
Connections |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Simulation |
|
|
Label |
| Label shown on the communications flasher component | |
|
|
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. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
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==
|
|
VisiWriteString |
| Writes a string to a specific Visi object. Returns 0 for a succesful write operation. | |
| - BYTE
|
StringIndex |
| - STRING
|
StringData |
| - BYTE
|
Return |
|
|
VisiWriteObject |
| Writes a value to a specific Visi object. Returns 0 for a succesful write operation. | |
| - BYTE
|
ObjectID |
| - BYTE
|
ObjectIndex |
| - UINT
|
Value |
| - BYTE
|
Return |
|
|
ChangeHWBaud |
| Changes the hardware UART baud rate allowing for dynamic speed changes. | |
| - BYTE
|
NewBaud |
| 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 | |
| - VOID
|
Return |
|
|
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. | |
| - BYTE
|
Return |
|
|
VisiWriteContrast |
| Updates the display contrast. Returns 0 for a succesful write operation. | |
| - BYTE
|
Contrast |
| Range 0-15, 0=Backlight Off | |
| - BYTE
|
Return |
|
|
VisiWriteVolume |
| Updates the display volume. Returns 0 for a succesful write operation. | |
| - BYTE
|
Volume |
| Range 8-127 | |
| - BYTE
|
Return |
|
|
VisiReadByteFromMessage |
| Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB | |
| - BYTE
|
Index |
| - BYTE
|
Return |
|
|
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. | |
| - BYTE
|
ObjectID |
| - BYTE
|
ObjectIndex |
| - BYTE
|
Return |
|
|
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. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Comms Settings |
|
|
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. | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
Connections |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Simulation |
|
|
Label |
| Label shown on the communications flasher component | |
|
|
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. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
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==
|
|
VisiWriteString |
| Writes a string to a specific Visi object. Returns 0 for a succesful write operation. | |
| - BYTE
|
StringIndex |
| - STRING
|
StringData |
| - BYTE
|
Return |
|
|
VisiWriteObject |
| Writes a value to a specific Visi object. Returns 0 for a succesful write operation. | |
| - BYTE
|
ObjectID |
| - BYTE
|
ObjectIndex |
| - UINT
|
Value |
| - BYTE
|
Return |
|
|
ChangeHWBaud |
| Changes the hardware UART baud rate allowing for dynamic speed changes. | |
| - BYTE
|
NewBaud |
| 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 | |
| - VOID
|
Return |
|
|
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. | |
| - BYTE
|
Return |
|
|
VisiWriteContrast |
| Updates the display contrast. Returns 0 for a succesful write operation. | |
| - BYTE
|
Contrast |
| Range 0-15, 0=Backlight Off | |
| - BYTE
|
Return |
|
|
VisiWriteVolume |
| Updates the display volume. Returns 0 for a succesful write operation. | |
| - BYTE
|
Volume |
| Range 8-127 | |
| - BYTE
|
Return |
|
|
VisiReadByteFromMessage |
| Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB | |
| - BYTE
|
Index |
| - BYTE
|
Return |
|
|
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. | |
| - BYTE
|
ObjectID |
| - BYTE
|
ObjectIndex |
| - BYTE
|
Return |
|
|
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. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Comms Settings |
|
|
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. | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
Connections |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Simulation |
|
|
Label |
| Label shown on the communications flasher component | |
|
|
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. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
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. | |
