Difference between revisions of "Component: Visi (4DSystems) (Comms: System)"
(XML import) |
|||
| Line 20: | Line 20: | ||
==Examples== | ==Examples== | ||
| − | + | ||
| + | These examples are designed to work with a 4D systems display pre-programmed with the VISI Genie runtime files. These files are also included in the example archives to allow you to easily replicate the project. | ||
| + | |||
| + | The 4D display can either be connected to the PC running Flowcode using the 4D USB cable or connected to an embedded Microcontroller using a hardware or software UART. If you are using the Flowcode simulation to communicate with the Visi component then be sure to set the Visi COM port property to the COM port assigned by Windows to the 4D USB Cable. | ||
| + | |||
| + | The Console window should also show some helpful information to aid in debugging any problems. | ||
| + | |||
| + | |||
| + | The first example demonstrates a simple rocker switch Visi component. | ||
| + | |||
| + | {{fcfile|RockerSwitch.zip|RockerSwitch}} | ||
| + | |||
| + | |||
| + | The second example demonstrates controlling the colour of an RGB LED using the Visi colour picker component. | ||
| + | |||
| + | {{fcfile|ColourPicker.zip|ColourPicker}} | ||
| + | |||
Revision as of 09:12, 28 July 2016
| Author | Matrix Ltd. |
| Version | 1.2 (Release) |
| 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.
Examples
These examples are designed to work with a 4D systems display pre-programmed with the VISI Genie runtime files. These files are also included in the example archives to allow you to easily replicate the project.
The 4D display can either be connected to the PC running Flowcode using the 4D USB cable or connected to an embedded Microcontroller using a hardware or software UART. If you are using the Flowcode simulation to communicate with the Visi component then be sure to set the Visi COM port property to the COM port assigned by Windows to the 4D USB Cable.
The Console window should also show some helpful information to aid in debugging any problems.
The first example demonstrates a simple rocker switch Visi component.
The second example demonstrates controlling the colour of an RGB LED using the Visi colour picker component.
Downloadable macro reference
VisiWriteString
Writes a string to a specific Visi object.
Returns 0 for a succesful write operation.
Parameters
- BYTE StringIndex
- <- STRING StringData
- This parameter may be returned back to the caller
Return value
VisiWriteObject
Writes a value to a specific Visi object.
Returns 0 for a succesful write operation.
Parameters
- BYTE ObjectID
- BYTE ObjectIndex
- UINT Value
Return value
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.
Parameters
- This macro has no parameters
Return value
VisiWriteContrast
Updates the display contrast.
Returns 0 for a succesful write operation.
Parameters
- BYTE Contrast
- Range 0-15, 0=Backlight Off
Return value
VisiWriteVolume
Updates the display volume.
Returns 0 for a succesful write operation.
Parameters
- BYTE Volume
- Range 8-127
Return value
VisiReadByteFromMessage
Reads a byte from a succesful VisiReceive macro.
Index: 0=Command, 1=ObjectID, 2=ObjectIndex, 3=ValueMSB, 4=ValueLSB
Parameters
- BYTE Index
Return value
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.
Parameters
- BYTE ObjectID
- BYTE ObjectIndex
Return value
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.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Simulation macro reference
GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
Parameters
- This macro has no parameters
Return value
Property reference
Channel
This property is of type Fixed list of ints and can be referenced with the variable name CHANNEL.
UART communications channel to specify software mode or select a hardware peripheral
Baud Rate
This property is of type Fixed list of ints and can be referenced with the variable name BAUD_LIST.
Communications data rate in bits per second.
TX
This property is of type Single digital pin and can be referenced with the variable name TX.
Transmit pin which is configurable for software channels but fixed for hardware channels
RX
This property is of type Single digital pin and can be referenced with the variable name RX.
Receive pin which is configurable for software channels but fixed for hardware channels
Label
This property is of type Line of text and can be referenced with the variable name label.
Label shown on the communications flasher component
Console Columns
This property is of type Unsigned integer and can be referenced with the variable name ConsoleColumns.
Maximum number of characters to display on the console before moving to the next line.
COM Port
This property is of type Fixed list of ints and can be referenced with the variable name com_port.
Simulation COM Port to allow Visi devices to interact with the Flowcode simulation
