Component: DMX-512 Master (Comms: System)
From Flowcode Help
Jump to navigationJump to search| Author | MatrixTSL |
| Version | 2.0 |
| Category | Comms: System |
Contents
DMX-512 Master component
A serial based communications protocol designed for controlling theatrical equipment such as dimmers, fog machines and intelligent lights. DMX-512 Slave devices are daisy chained together with a final 180R terminating resistor at the end of the chail. DMX requires the signal to be level shifted from VCC and GND to +2.5V and -2.5V.
Component Source Code
Please click here to view the component source code (Beta): FC_Comp_Source_DMX-512_Master.fcfx
Detailed description
No detailed description exists yet for this component
Examples
DMX Master Example, reads the value of two ports using switch arrays to set the values and then transmits the data in a DMX packet.
For DMX 512 slave example see: DMX Slave
Macro reference
|
SetDataChannel |
| Sets the data byte in a data channel | |
 - UINT
|
Channel |
 - BYTE
|
DataValue |
 - VOID
|
Return |
|
|
SendDataChain |
| Transmits the BREAK, MAB and StartCode followed by the contents of the data channels. | |
| - BYTE
|
StartCode |
| - VOID
|
Return |
|
|
Initialise |
| Configures the UART serial interface. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Serial Properties |
|
COM Port |
| Selects which port to communicate with, only lists ports which are currently available. | |
|
Refresh COM Ports |
| When set to yes the COM port list is rescanned for newly connected or available ports. Note that refreshing the ports list may take a few seconds depending on the number of connected ports. | |
|
Baud |
| Baud rate passed to the COM port to control the rate of data. | |
|
|
Timeout Value |
| Value to specify what is returned when no incoming receive data is present. | |
|
|
Console Data |
|
|
DMX Properties |
|
Data Channels |
| Number of data bytes used by the DMX chain, Max 512 bytes per transmission. 24 Bytes minimum to match minimum 1204us timing requirements, not all channels need to be used. | |
==Macro reference==
|
|
SetDataChannel |
| Sets the data byte in a data channel | |
| - UINT
|
Channel |
| - BYTE
|
DataValue |
| - VOID
|
Return |
|
|
SendDataChain |
| Transmits the BREAK, MAB and StartCode followed by the contents of the data channels. | |
| - BYTE
|
StartCode |
| - VOID
|
Return |
|
|
Initialise |
| Configures the UART serial interface. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Serial Properties |
|
|
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 |
|
TX |
| Pin to be used for Transmit data | |
|
|
DMX Properties |
|
|
Data Channels |
| Number of data bytes used by the DMX chain, Max 512 bytes per transmission. 24 Bytes minimum to match minimum 1204us timing requirements, not all channels need to be used. | |
|
|
Simulation |
|
|
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==
|
|
SetDataChannel |
| Sets the data byte in a data channel | |
| - UINT
|
Channel |
| - BYTE
|
DataValue |
| - VOID
|
Return |
|
|
SendDataChain |
| Transmits the BREAK, MAB and StartCode followed by the contents of the data channels. | |
| - BYTE
|
StartCode |
| - VOID
|
Return |
|
|
Initialise |
| Configures the UART serial interface. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Serial Properties |
|
|
COM Port |
| Selects which port to communicate with, only lists ports which are currently available. | |
|
|
Refresh COM Ports |
| When set to yes the COM port list is rescanned for newly connected or available ports. Note that refreshing the ports list may take a few seconds depending on the number of connected ports. | |
|
|
Baud |
| Baud rate passed to the COM port to control the rate of data. | |
|
|
Timeout Value |
| Value to specify what is returned when no incoming receive data is present. | |
|
|
Console Data |
|
|
DMX Properties |
|
|
Data Channels |
| Number of data bytes used by the DMX chain, Max 512 bytes per transmission. 24 Bytes minimum to match minimum 1204us timing requirements, not all channels need to be used. | |
==Macro reference==
|
|
SetDataChannel |
| Sets the data byte in a data channel | |
| - UINT
|
Channel |
| - BYTE
|
DataValue |
| - VOID
|
Return |
|
|
SendDataChain |
| Transmits the BREAK, MAB and StartCode followed by the contents of the data channels. | |
| - BYTE
|
StartCode |
| - VOID
|
Return |
|
|
Initialise |
| Configures the UART serial interface. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Serial Properties |
|
|
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 |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
DMX Properties |
|
|
Data Channels |
| Number of data bytes used by the DMX chain, Max 512 bytes per transmission. 24 Bytes minimum to match minimum 1204us timing requirements, not all channels need to be used. | |
|
|
Simulation |
|
|
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. | |
