Jump to content

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

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_TrafficLight-1Way.fcfx FC_Comp_Source_TrafficLight-1Way.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TrafficLight-1Way.fcfx FC_Comp_Source_TrafficLight-1Way.fcfx]


==Detailed description==
==Detailed description==




Line 38: Line 40:


==Examples==
==Examples==




Line 59: Line 63:


==Macro reference==
==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. 
|-
|-
| 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;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AutomaticMode'''
|-
| 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="90%" | Mode
|-
| colspan="2" | 0 = Auto Mode Disabled, 1 = Auto Mode Enabled 
|-
| 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;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLightState'''
|-
| 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" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| 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;" | '''SetLights'''
|-
| colspan="2" | Direct control over all 3 of the lights. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Red
|-
| colspan="2" | 0 = Off, 1 = On 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Amber
|-
| colspan="2" | 0 = Off, 1 = On 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Green
|-
| colspan="2" | 0 = Off, 1 = On 
|-
| 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;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLightState'''
|-
| colspan="2" | Follows the standard traffic light sequence. 
|-
|-
| 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''
|}
==Property reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colours
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Red Colour
|-
| colspan="2" | Colour Picker to set the Colour of the Red indicator. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Amber Colour
|-
| colspan="2" | Colour Picker to set the Colour of the Amber indicator. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Green Colour
|-
| colspan="2" | Colour Picker to set the Colour of the Green indicator. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Off Colour
|-
| colspan="2" | Colour Picker to set the Colour of all indicators when they are switched off. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timings - Automatic Mode
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Flow Time
|-
| colspan="2" | Amount of time to wait in milliseconds when the lights are red or green. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Transition Time
|-
| colspan="2" | Amount of time to wait in milliseconds when the lights are transitioning between flows. 
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:17, 20 January 2023

Author Matrix TSL
Version 1.0
Category Scenarios


Traffic Light 1-Way component

A set of one 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 view the component source code (Beta): FC_Comp_Source_TrafficLight-1Way.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

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 Return


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
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 
- BYTE Return


SetLights
Direct control over all 3 of the lights. 
- BOOL Red
0 = Off, 1 = On 
- BOOL Amber
0 = Off, 1 = On 
- BOOL Green
0 = Off, 1 = On 
- VOID Return


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



Property reference

Properties
Colours
Red Colour
Colour Picker to set the Colour of the Red indicator. 
Amber Colour
Colour Picker to set the Colour of the Amber indicator. 
Green Colour
Colour Picker to set the Colour of the Green indicator. 
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. 

==Macro reference==

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 Return


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
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 
- BYTE Return


SetLights
Direct control over all 3 of the lights. 
- BOOL Red
0 = Off, 1 = On 
- BOOL Amber
0 = Off, 1 = On 
- BOOL Green
0 = Off, 1 = On 
- VOID Return


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



Property reference

Properties
Colours
Red Colour
Colour Picker to set the Colour of the Red indicator. 
Amber Colour
Colour Picker to set the Colour of the Amber indicator. 
Green Colour
Colour Picker to set the Colour of the Green indicator. 
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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Traffic_Light_1-Way_(Scenarios)&oldid=32963"