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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Scenarios
 
| 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.
  
−
==[[File:Component Icon dbf602c1_cb49_4149_bcd3_4a5afeae9a7a.png|Image]] Traffic Light 2_Way component==
+
==Component Pack==
−
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.
 
  
−
==Examples==
+
FREE
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
+
''No detailed description exists yet for this component''
  
−
===<span style="font-weight: normal;"><u><tt>GetStopGo</tt></u></span>===
+
==Examples==
−
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.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''LightSet''
 
−
::0 = Light Set 1, 1 = Light Set 2
 
  
 +
There is a detailed walk through of the scenario detailed at the link below to go with this component.
  
−
'''Return value'''
+
[[Traffic_Light_2-Way|Traffic Light Scenario]]
  
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
+
==Downloadable 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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>AutomaticMode</tt></u></span>===
 
−
Enables or Disables automatic mode where the lights will automatically cycle between modes.
 
  
−
'''Parameters'''
+
{| 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.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" | 0 = Auto Mode Disabled, 1 = Auto Mode Enabled&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''
 +
|}
  
−
:[[Variable Types|BOOL]] ''Mode''
 
−
::0 = Auto Mode Disabled, 1 = Auto Mode Enabled
 
  
 +
{| 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;" | '''SetSingleLight'''
 +
|-
 +
| colspan="2" | Direct control over one set of lights.&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" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| 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" | 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''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| 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&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-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>GetLightState</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Reads the state of one of the light sets.
+
|-
 +
| 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 6 of the lights.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Red0
 +
|-
 +
| colspan="2" | 0 = Off, 1 = On&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Amber0
 +
|-
 +
| colspan="2" | 0 = Off, 1 = On&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Green0
 +
|-
 +
| colspan="2" | 0 = Off, 1 = On&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Red1
 +
|-
 +
| colspan="2" | 0 = Off, 1 = On&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Amber1
 +
|-
 +
| colspan="2" | 0 = Off, 1 = On&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Green1
 +
|-
 +
| colspan="2" | 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''
 +
|}
  
−
Returns the state as a number.
 
  
−
0=Red, 1=Red+Amber, 2=Green, 3=Amber, 4=Unknown State
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
'''Parameters'''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLightState'''
−
:[[Variable Types|BOOL]] ''LightSet''
+
|-
−
::0 = Light Set 1, 1 = Light Set 2
+
| colspan="2" | Follows the standard traffic light sequence.&nbsp;
−
 
+
|-
−
 
+
|-
−
'''Return value'''
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
−
 
+
| width="90%" | LightSet
−
:[[Variable Types|BYTE]]
+
|-
−
 
+
| colspan="2" | 0 = Light Set 1, 1 = Light Set 2&nbsp;
−
 
+
|-
−
===<span style="font-weight: normal;"><u><tt>SetSingleLight</tt></u></span>===
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
Direct control over one set of lights.
+
| width="90%" | SequenceNumber
−
 
+
|-
−
'''Parameters'''
+
| colspan="2" | 0 = Red, 1 = Red+Amber, 2 = Green, 3 = Amber&nbsp;
−
 
+
|-
−
:[[Variable Types|BOOL]] ''LightSet''
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
::0 = Light Set 1, 1 = Light Set 2
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
 
+
|}
−
:[[Variable Types|BOOL]] ''Red''
 
−
::Red - 0 = Off, 1 = On
 
−
 
 
−
:[[Variable Types|BOOL]] ''Amber''
 
−
::Amber - 0 = Off, 1 = On
 
−
 
 
−
:[[Variable Types|BOOL]] ''Green''
 
−
::Green - 0 = Off, 1 = On
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetLights</tt></u></span>===
 
−
Direct control over all 6 of the lights.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BOOL]] ''Red0''
 
−
::0 = Off, 1 = On
 
−
 
 
−
:[[Variable Types|BOOL]] ''Amber0''
 
−
::0 = Off, 1 = On
 
−
 
 
−
:[[Variable Types|BOOL]] ''Green0''
 
−
::0 = Off, 1 = On
 
−
 
 
−
:[[Variable Types|BOOL]] ''Red1''
 
−
::0 = Off, 1 = On
 
−
 
 
−
:[[Variable Types|BOOL]] ''Amber1''
 
−
::0 = Off, 1 = On
 
−
 
 
−
:[[Variable Types|BOOL]] ''Green1''
 
−
::0 = Off, 1 = On
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetLightState</tt></u></span>===
 
−
Follows the standard traffic light sequence.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BOOL]] ''LightSet''
 
−
::0 = Light Set 1, 1 = Light Set 2
 
−
 
 
−
:[[Variable Types|BYTE]] ''SequenceNumber''
 
−
::0 = Red, 1 = Red+Amber, 2 = Green, 3 = Amber
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
  
  
Line 149: Line 192:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Red Colour</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''Red''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Amber Colour</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colours
−
This property is of type ''Color picker'' and can be referenced with the variable name ''Amber''.
+
|-
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| 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 indicators when they are switched on.&nbsp;
−
<span style="font-weight: normal;"><u>Green Colour</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
This property is of type ''Color picker'' and can be referenced with the variable name ''Green''.
+
| width="90%" | Amber Colour
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | Colour Picker to set the Colour of the Amber indicators when they are switched on.&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Green Colour
−
<span style="font-weight: normal;"><u>Off Colour</u></span>
+
|-
−
 
+
| colspan="2" | Colour Picker to set the Colour of the Green indicators when they are switched on.&nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''Off''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Off Colour
−
 
+
|-
−
 
+
| colspan="2" | Colour Picker to set the Colour of all indicators when they are switched off.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Flow Time</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timings - Automatic Mode
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Flow''.
+
|-
−
 
+
|-
−
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%" | Flow Time
−
<span style="font-weight: normal;"><u>Transition Time</u></span>
+
|-
−
 
+
| colspan="2" | Amount of time to wait in milliseconds when the lights are red or green.&nbsp;
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Trans''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
Amount of time to wait in milliseconds when the lights are transitioning between flows.
+
| width="90%" | Transition Time
 +
|-
 +
| colspan="2" | Amount of time to wait in milliseconds when the lights are transitioning between flows.&nbsp;
 +
|}

Latest revision as of 17:24, 9 November 2022

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 Pack

FREE

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

Downloadable macro reference

Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL LightSet
0 = Light Set 1, 1 = Light Set 2 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png AutomaticMode
Enables or Disables automatic mode where the lights will automatically cycle between modes. 
Fc9-bool-icon.png - BOOL Mode
0 = Auto Mode Disabled, 1 = Auto Mode Enabled 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetSingleLight
Direct control over one set of lights. 
Fc9-bool-icon.png - BOOL LightSet
0 = Light Set 1, 1 = Light Set 2 
Fc9-bool-icon.png - BOOL Red
Red - 0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Amber
Amber - 0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Green
Green - 0 = Off, 1 = On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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 
Fc9-bool-icon.png - BOOL LightSet
0 = Light Set 1, 1 = Light Set 2 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetLights
Direct control over all 6 of the lights. 
Fc9-bool-icon.png - BOOL Red0
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Amber0
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Green0
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Red1
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Amber1
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Green1
0 = Off, 1 = On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLightState
Follows the standard traffic light sequence. 
Fc9-bool-icon.png - BOOL LightSet
0 = Light Set 1, 1 = Light Set 2 
Fc9-u8-icon.png - BYTE SequenceNumber
0 = Red, 1 = Red+Amber, 2 = Green, 3 = Amber 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Colours
Fc9-type-1-icon.png Red Colour
Colour Picker to set the Colour of the Red indicators when they are switched on. 
Fc9-type-1-icon.png Amber Colour
Colour Picker to set the Colour of the Amber indicators when they are switched on. 
Fc9-type-1-icon.png Green Colour
Colour Picker to set the Colour of the Green indicators when they are switched on. 
Fc9-type-1-icon.png Off Colour
Colour Picker to set the Colour of all indicators when they are switched off. 
Fc9-conn-icon.png Timings - Automatic Mode
Fc9-type-21-icon.png Flow Time
Amount of time to wait in milliseconds when the lights are red or green. 
Fc9-type-21-icon.png Transition Time
Amount of time to wait in milliseconds when the lights are transitioning between flows. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Traffic_Light_2_Way_(Scenarios)&oldid=28863"