Difference between revisions of "Component: Traffic Light 2-Way (Scenarios)"
From Flowcode Help
Jump to navigationJump to search| (7 intermediate revisions by the same user not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TrafficLight-2Way.fcfx FC_Comp_Source_TrafficLight-2Way.fcfx] |
| + | |||
| + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TrafficLight-2Way.fcfx FC_Comp_Source_TrafficLight-2Way.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 30: | Line 40: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 41: | Line 59: | ||
[[Traffic_Light_2-Way|Traffic Light Scenario]] | [[Traffic_Light_2-Way|Traffic Light Scenario]] | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
==Macro reference== | ==Macro reference== | ||
| + | ===AutomaticMode=== | ||
{| 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AutomaticMode''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Enables or Disables automatic mode where the lights will automatically cycle between modes. |
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| − | | width="90%" | | + | | width="90%" | Mode |
|- | |- | ||
| − | | colspan="2" | 0 = | + | | colspan="2" | 0 = Auto Mode Disabled, 1 = Auto Mode Enabled |
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===GetLightState=== | ||
{| 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLightState''' |
|- | |- | ||
| − | | colspan="2" | | + | | 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 |
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| − | | width="90%" | | + | | width="90%" | LightSet |
|- | |- | ||
| − | | colspan="2" | 0 = | + | | colspan="2" | 0 = Light Set 1, 1 = Light Set 2 |
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE |
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===GetStopGo=== | ||
{| 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStopGo''' |
|- | |- | ||
| − | | colspan="2" | | + | | 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. |
|- | |- | ||
|- | |- | ||
| Line 93: | Line 124: | ||
| colspan="2" | 0 = Light Set 1, 1 = Light Set 2 | | colspan="2" | 0 = Light Set 1, 1 = Light Set 2 | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===SetLightState=== | ||
{| 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLightState''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Follows the standard traffic light sequence. |
|- | |- | ||
|- | |- | ||
| Line 126: | Line 143: | ||
| colspan="2" | 0 = Light Set 1, 1 = Light Set 2 | | colspan="2" | 0 = Light Set 1, 1 = Light Set 2 | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| + | | width="90%" | SequenceNumber | ||
| + | |- | ||
| + | | colspan="2" | 0 = Red, 1 = Red+Amber, 2 = Green, 3 = Amber | ||
| + | |- | ||
| + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===SetLights=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 174: | Line 197: | ||
| + | ===SetSingleLight=== | ||
{| 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetSingleLight''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Direct control over one set of lights. |
|- | |- | ||
|- | |- | ||
| Line 187: | Line 211: | ||
| colspan="2" | 0 = Light Set 1, 1 = Light Set 2 | | colspan="2" | 0 = Light Set 1, 1 = Light Set 2 | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL |
| − | | width="90%" | | + | | width="90%" | Red |
| + | |- | ||
| + | | colspan="2" | Red - 0 = Off, 1 = On | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Amber | ||
| + | |- | ||
| + | | colspan="2" | Amber - 0 = Off, 1 = On | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Green | ||
|- | |- | ||
| − | | colspan="2" | 0 = | + | | colspan="2" | Green - 0 = Off, 1 = On |
|- | |- | ||
| 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 | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
Latest revision as of 13:13, 7 February 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Scenarios |
Contents
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.
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. | |
