Component: Visi (4DSystems) (Comms: System): Difference between revisions
Appearance
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 60: | Line 60: | ||
===ChangeHWBaud=== | ===ChangeHWBaud=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ChangeHWBaud''' | ||
|- | |- | ||
| colspan="2" | Changes the hardware UART baud rate allowing for dynamic speed changes. | | colspan="2" | Changes the hardware UART baud rate allowing for dynamic speed changes. | ||
| Line 79: | Line 79: | ||
===Initialise=== | ===Initialise=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 93: | Line 93: | ||
===VisiReadByteFromMessage=== | ===VisiReadByteFromMessage=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''VisiReadByteFromMessage''' | ||
|- | |- | ||
| colspan="2" | Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB | | colspan="2" | Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB | ||
| Line 112: | Line 112: | ||
===VisiReadObject=== | ===VisiReadObject=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 136: | Line 136: | ||
===VisiReceive=== | ===VisiReceive=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 150: | Line 150: | ||
===VisiWriteContrast=== | ===VisiWriteContrast=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''VisiWriteContrast''' | ||
|- | |- | ||
| colspan="2" | Updates the display contrast. Returns 0 for a succesful write operation. | | colspan="2" | Updates the display contrast. Returns 0 for a succesful write operation. | ||
| Line 169: | Line 169: | ||
===VisiWriteObject=== | ===VisiWriteObject=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''VisiWriteObject''' | ||
|- | |- | ||
| colspan="2" | Writes a value to a specific Visi object. Returns 0 for a succesful write operation. | | colspan="2" | Writes a value to a specific Visi object. Returns 0 for a succesful write operation. | ||
| Line 198: | Line 198: | ||
===VisiWriteString=== | ===VisiWriteString=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''VisiWriteString''' | ||
|- | |- | ||
| colspan="2" | Writes a string to a specific Visi object. Returns 0 for a succesful write operation. | | colspan="2" | Writes a string to a specific Visi object. Returns 0 for a succesful write operation. | ||
| Line 222: | Line 222: | ||
===VisiWriteVolume=== | ===VisiWriteVolume=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''VisiWriteVolume''' | ||
|- | |- | ||
| colspan="2" | Updates the display volume. Returns 0 for a succesful write operation. | | colspan="2" | Updates the display volume. Returns 0 for a succesful write operation. | ||
| Line 242: | Line 242: | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Comms Settings | ||
|- | |- | ||
|- | |- | ||
| Line 267: | Line 267: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
| Line 281: | Line 281: | ||
| colspan="2" | Pin to be used for Receive data | | colspan="2" | Pin to be used for Receive data | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:37, 13 July 2026
| 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.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
ChangeHWBaud
| ChangeHWBaud | |
| Changes the hardware UART baud rate allowing for dynamic speed changes. | |
| NewBaud | |
| 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 | |
| Return | |
Initialise
| 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. | |
| Return | |
VisiReadByteFromMessage
| VisiReadByteFromMessage | |
| Reads a byte from a succesful VisiReceive macro. Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB | |
| Index | |
| Return | |
VisiReadObject
VisiReceive
VisiWriteContrast
| VisiWriteContrast | |
| Updates the display contrast. Returns 0 for a succesful write operation. | |
| Contrast | |
| Range 0-15, 0=Backlight Off | |
| Return | |
VisiWriteObject
| VisiWriteObject | |
| Writes a value to a specific Visi object. Returns 0 for a succesful write operation. | |
| ObjectID | |
| ObjectIndex | |
| Value | |
| Return | |
VisiWriteString
| VisiWriteString | |
| Writes a string to a specific Visi object. Returns 0 for a succesful write operation. | |
| StringIndex | |
| StringData | |
| Return | |
VisiWriteVolume
| VisiWriteVolume | |
| Updates the display volume. Returns 0 for a succesful write operation. | |
| Volume | |
| Range 8-127 | |
| Return | |
Property reference
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