Difference between revisions of "Component: DMX-512 Master (Comms: System)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DMX-512_Master.fcfx FC_Comp_Source_DMX-512_Master.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/DMX-512_Master_SCADA.fcsx FC_Comp_Source_temp/DMX-512_Master_SCADA.fcsx]
  
−
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DMX-512_Master.fcfx FC_Comp_Source_DMX-512_Master.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/DMX-512_Master_SCADA.fcsx FC_Comp_Source_temp/DMX-512_Master_SCADA.fcsx]
  
 
==Detailed description==
 
==Detailed description==
Line 95: Line 95:
  
 
For DMX 512 slave example see: [[Component:_ID_1be0ac44_3521_402e_a8b7_1faf86c09560|DMX Slave]]
 
For DMX 512 slave example see: [[Component:_ID_1be0ac44_3521_402e_a8b7_1faf86c09560|DMX Slave]]
 +
 +
  
  
Line 106: Line 108:
 
==Macro reference==
 
==Macro reference==
  
−
===SetDataChannel===
+
===Initialise===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDataChannel'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
|-
 
|-
−
| colspan="2" | Sets the data byte in a data channel 
+
| colspan="2" | Configures the UART serial interface. 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DataValue
 
 
|-
 
|-
−
| colspan="2" |  
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 149: Line 141:
  
  
−
===Initialise===
+
===SetDataChannel===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDataChannel'''
 +
|-
 +
| colspan="2" | Sets the data byte in a data channel 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" |  
 
|-
 
|-
−
| colspan="2" | Configures the UART serial interface. 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | DataValue
 
|-
 
|-
 +
| colspan="2" |  
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 178: Line 180:
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
| width="90%" | Channel
+
| width="90%" | COM Port
 +
|-
 +
| colspan="2" | Selects which port to communicate with, only lists ports which are currently available.  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Refresh COM Ports
 
|-
 
|-
−
| 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. 
+
| colspan="2" | 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. 
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
| width="90%" | Baud Options
+
| width="90%" | Baud
 
|-
 
|-
−
| colspan="2" | Baud rate option selector 
+
| colspan="2" | Baud rate passed to the COM port to control the rate of data. 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
| width="90%" | Baud Rate
+
| width="90%" | Timeout Value
 
|-
 
|-
−
| colspan="2" |  
+
| colspan="2" | Value to specify what is returned when no incoming receive data is present. 
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
| width="90%" | TX
+
| width="90%" | Console Data
 
|-
 
|-
−
| colspan="2" | Pin to be used for Transmit data 
+
| colspan="2" |  
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
Line 205: Line 212:
 
|-
 
|-
 
| colspan="2" | 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. 
 
| colspan="2" | 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. 
−
|-
 
−
| 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-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. 
 
 
|}
 
|}

Revision as of 11:59, 3 February 2023

Author MatrixTSL
Version 2.0
Category Comms: System


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 download the component source project: FC_Comp_Source_temp/DMX-512_Master_SCADA.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/DMX-512_Master_SCADA.fcsx

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.

FC6 Icon.png DMX Master Example1


For DMX 512 slave example see: DMX Slave






Macro reference

Initialise

Fc9-comp-macro.png Initialise
Configures the UART serial interface. 
Fc9-void-icon.png - VOID Return


SendDataChain

Fc9-comp-macro.png SendDataChain
Transmits the BREAK, MAB and StartCode followed by the contents of the data channels. 
Fc9-u8-icon.png - BYTE StartCode
 
Fc9-void-icon.png - VOID Return


SetDataChannel

Fc9-comp-macro.png SetDataChannel
Sets the data byte in a data channel 
Fc9-u16-icon.png - UINT Channel
 
Fc9-u8-icon.png - BYTE DataValue
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Serial Properties
Fc9-type-16-icon.png COM Port
Selects which port to communicate with, only lists ports which are currently available.  
Fc9-type-7-icon.png 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. 
Fc9-type-14-icon.png Baud
Baud rate passed to the COM port to control the rate of data. 
Fc9-type-14-icon.png Timeout Value
Value to specify what is returned when no incoming receive data is present. 
Fc9-type-7-icon.png Console Data
 
Fc9-conn-icon.png DMX Properties
Fc9-type-21-icon.png 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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_DMX-512_Master_(Comms:_System)&oldid=36359"