Component: Traffic Light 2-Way (Scenarios): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix TSL
Version	1.0
Category	Scenarios

Traffic Light 2-Way component

A set of two way traffic lights complete with manual light control, a simple state machine and an automatic mode to allow the lights to take care of themselves.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_TrafficLight-2Way.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_TrafficLight-2Way.fcfx

Detailed description

No detailed description exists yet for this component

Examples

There is a detailed walk through of the scenario detailed at the link below to go with this component.

Traffic Light Scenario

Macro reference

AutomaticMode

	AutomaticMode
Enables or Disables automatic mode where the lights will automatically cycle between modes.
- BOOL	Mode
0 = Auto Mode Disabled, 1 = Auto Mode Enabled
- VOID	Return

GetLightState

	GetLightState
Reads the state of one of the light sets. Returns the state as a number. 0=Red, 1=Red+Amber, 2=Green, 3=Amber, 4=Unknown State
- BOOL	LightSet
0 = Light Set 1, 1 = Light Set 2
- BYTE	Return

GetStopGo

	GetStopGo
Reads one of the light sets to determine if it is safe to go through the lights. Returns 1 for a Green light, otherwise returns 0.
- BOOL	LightSet
0 = Light Set 1, 1 = Light Set 2
- BOOL	Return

SetLightState

	SetLightState
Follows the standard traffic light sequence.
- BOOL	LightSet
0 = Light Set 1, 1 = Light Set 2
- BYTE	SequenceNumber
0 = Red, 1 = Red+Amber, 2 = Green, 3 = Amber
- VOID	Return

SetLights

	SetLights
Direct control over all 6 of the lights.
- BOOL	Red0
0 = Off, 1 = On
- BOOL	Amber0
0 = Off, 1 = On
- BOOL	Green0
0 = Off, 1 = On
- BOOL	Red1
0 = Off, 1 = On
- BOOL	Amber1
0 = Off, 1 = On
- BOOL	Green1
0 = Off, 1 = On
- VOID	Return

SetSingleLight

	SetSingleLight
Direct control over one set of lights.
- BOOL	LightSet
0 = Light Set 1, 1 = Light Set 2
- BOOL	Red
Red - 0 = Off, 1 = On
- BOOL	Amber
Amber - 0 = Off, 1 = On
- BOOL	Green
Green - 0 = Off, 1 = On
- VOID	Return

Property reference

	Properties
	Colours
	Red Colour
Colour Picker to set the Colour of the Red indicators when they are switched on.
	Amber Colour
Colour Picker to set the Colour of the Amber indicators when they are switched on.
	Green Colour
Colour Picker to set the Colour of the Green indicators when they are switched on.
	Off Colour
Colour Picker to set the Colour of all indicators when they are switched off.
	Timings - Automatic Mode
	Flow Time
Amount of time to wait in milliseconds when the lights are red or green.
	Transition Time
Amount of time to wait in milliseconds when the lights are transitioning between flows.

@@ Line 62: / Line 62: @@
-==Macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStopGo'''
-|-
-| colspan="2" | Reads one of the light sets to determine if it is safe to go through the lights. Returns 1 for a Green light, otherwise returns 0.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | LightSet
-|-
-| colspan="2" | 0 = Light Set 1, 1 = Light Set 2&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
+===AutomaticMode===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AutomaticMode'''
+| width="90%" class="mtx-class-macrohead" | '''AutomaticMode'''
 |-
 | colspan="2" | Enables or Disables automatic mode where the lights will automatically cycle between modes.&nbsp;
@@ Line 100: / Line 91: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===GetLightState===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetSingleLight'''
+| width="90%" class="mtx-class-macrohead" | '''GetLightState'''
 |-
-| colspan="2" | Direct control over one set of lights.&nbsp;
+| colspan="2" | Reads the state of one of the light sets. Returns the state as a number.  0=Red, 1=Red+Amber, 2=Green, 3=Amber, 4=Unknown State&nbsp;
 |-
 |-
@@ Line 113: / Line 105: @@
 | colspan="2" | 0 = Light Set 1, 1 = Light Set 2&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Red
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===GetStopGo===
+{| class="mtx-class-macrotable wikitable"
 |-
-| colspan="2" | Red - 0 = Off, 1 = On&nbsp;
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetStopGo'''
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| colspan="2" | Reads one of the light sets to determine if it is safe to go through the lights. Returns 1 for a Green light, otherwise returns 0.&nbsp;
-| width="90%" | Amber
 |-
-| colspan="2" | Amber - 0 = Off, 1 = On&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | Green
+| width="90%" | LightSet
 |-
-| colspan="2" | Green - 0 = Off, 1 = On&nbsp;
+| colspan="2" | 0 = Light Set 1, 1 = Light Set 2&nbsp;
 |-
-| 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-bool-icon.png]] - BOOL
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===SetLightState===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLightState'''
+| width="90%" class="mtx-class-macrohead" | '''SetLightState'''
 |-
-| colspan="2" | Reads the state of one of the light sets. Returns the state as a number.  0=Red, 1=Red+Amber, 2=Green, 3=Amber, 4=Unknown State&nbsp;
+| colspan="2" | Follows the standard traffic light sequence.&nbsp;
 |-
 |-
@@ Line 146: / Line 143: @@
 | colspan="2" | 0 = Light Set 1, 1 = Light Set 2&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | SequenceNumber
+|-
+| colspan="2" | 0 = Red, 1 = Red+Amber, 2 = Green, 3 = Amber&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===SetLights===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLights'''
+| width="90%" class="mtx-class-macrohead" | '''SetLights'''
 |-
 | colspan="2" | Direct control over all 6 of the lights.&nbsp;
@@ Line 194: / Line 197: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===SetSingleLight===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLightState'''
+| width="90%" class="mtx-class-macrohead" | '''SetSingleLight'''
 |-
-| colspan="2" | Follows the standard traffic light sequence.&nbsp;
+| colspan="2" | Direct control over one set of lights.&nbsp;
 |-
 |-
@@ Line 207: / Line 211: @@
 | colspan="2" | 0 = Light Set 1, 1 = Light Set 2&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | SequenceNumber
+| width="90%" | Red
+|-
+| colspan="2" | Red - 0 = Off, 1 = On&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Amber
+|-
+| colspan="2" | Amber - 0 = Off, 1 = On&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Green
 |-
-| colspan="2" | 0 = Red, 1 = Red+Amber, 2 = Green, 3 = Amber&nbsp;
+| colspan="2" | Green - 0 = Off, 1 = On&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colours
+| width="90%" class="mtx-class-propfolder" | Colours
 |-
 |-
@@ Line 251: / Line 263: @@
 | colspan="2" | Colour Picker to set the Colour of all indicators when they are switched off.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timings - Automatic Mode
+| width="90%" class="mtx-class-propfolder" | Timings - Automatic Mode
 |-
 |-

SteveT (talk | contribs)