Difference between revisions of "Component: Pedestrian Crossing (Scenarios)"

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/wikicopy/componentsource/FC_Comp_Source_PedestrianCrossing.fcfx FC_Comp_Source_PedestrianCrossing.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_PedestrianCrossing.fcfx FC_Comp_Source_PedestrianCrossing.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PedestrianCrossing.fcfx FC_Comp_Source_PedestrianCrossing.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PedestrianCrossing.fcfx FC_Comp_Source_PedestrianCrossing.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 32: Line 34:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 42: Line 46:
  
 
==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;" | '''ReadSwitch'''
 +
|-
 +
| colspan="2" | Check to see if switch is currently pressed. Return: 0 = Not Pressed, 1 = Pressed 
 +
|-
 +
|-
 +
| 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+Wait, 2=Green, 3=FlashingGreen, 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%" | Green
 +
|-
 +
| colspan="2" | 0 = Off, 1 = On 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Wait
 +
|-
 +
| 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 pedestrian crossing light sequence. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | SequenceNumber
 +
|-
 +
| colspan="2" | 0 = Red, 1 = Red+Wait, 2 = Green, 3 = Green Flashing 
 +
|-
 +
| 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%" | 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%" | Wait Colour
 +
|-
 +
| colspan="2" | Colour Picker to set the Colour of the Wait 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%" | Wait Time
 +
|-
 +
| colspan="2" | Amount of time to wait in milliseconds the pedestrians have to wait before being allowed to cross. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Crossing Time
 +
|-
 +
| colspan="2" | Amount of time to wait in milliseconds for the pedestrians to cross the road. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Flash Time
 +
|-
 +
| colspan="2" | Amount of time to wait in milliseconds to warn pedestrians to finish crossing the road. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Switch
 +
|-
 +
| colspan="2" | Pin connection assigned to the pedestrian waiting to cross switch. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:59, 27 January 2023

Author Matrix TSL
Version 1.0
Category Scenarios


Pedestrian Crossing component

A set of pedestrian crossing 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_PedestrianCrossing.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_PedestrianCrossing.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

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 Return


Fc9-comp-macro.png ReadSwitch
Check to see if switch is currently pressed. Return: 0 = Not Pressed, 1 = Pressed 
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 GetLightState
Reads the state of one of the light sets. Returns the state as a number. 0=Red, 1=Red+Wait, 2=Green, 3=FlashingGreen, 4=Unknown State 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetLights
Direct control over all 3 of the lights. 
Fc9-bool-icon.png - BOOL Red
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Green
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Wait
0 = Off, 1 = On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLightState
Follows the standard pedestrian crossing light sequence. 
Fc9-u8-icon.png - BYTE SequenceNumber
0 = Red, 1 = Red+Wait, 2 = Green, 3 = Green Flashing 
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 indicator.  
Fc9-type-1-icon.png Green Colour
Colour Picker to set the Colour of the Green indicator.  
Fc9-type-1-icon.png Wait Colour
Colour Picker to set the Colour of the Wait indicator.  
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 Wait Time
Amount of time to wait in milliseconds the pedestrians have to wait before being allowed to cross. 
Fc9-type-21-icon.png Crossing Time
Amount of time to wait in milliseconds for the pedestrians to cross the road. 
Fc9-type-21-icon.png Flash Time
Amount of time to wait in milliseconds to warn pedestrians to finish crossing the road. 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Switch
Pin connection assigned to the pedestrian waiting to cross switch. 

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


Fc9-comp-macro.png ReadSwitch
Check to see if switch is currently pressed. Return: 0 = Not Pressed, 1 = Pressed 
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 GetLightState
Reads the state of one of the light sets. Returns the state as a number. 0=Red, 1=Red+Wait, 2=Green, 3=FlashingGreen, 4=Unknown State 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetLights
Direct control over all 3 of the lights. 
Fc9-bool-icon.png - BOOL Red
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Green
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Wait
0 = Off, 1 = On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLightState
Follows the standard pedestrian crossing light sequence. 
Fc9-u8-icon.png - BYTE SequenceNumber
0 = Red, 1 = Red+Wait, 2 = Green, 3 = Green Flashing 
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 indicator.  
Fc9-type-1-icon.png Green Colour
Colour Picker to set the Colour of the Green indicator.  
Fc9-type-1-icon.png Wait Colour
Colour Picker to set the Colour of the Wait indicator.  
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 Wait Time
Amount of time to wait in milliseconds the pedestrians have to wait before being allowed to cross. 
Fc9-type-21-icon.png Crossing Time
Amount of time to wait in milliseconds for the pedestrians to cross the road. 
Fc9-type-21-icon.png Flash Time
Amount of time to wait in milliseconds to warn pedestrians to finish crossing the road. 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Switch
Pin connection assigned to the pedestrian waiting to cross switch. 

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


Fc9-comp-macro.png ReadSwitch
Check to see if switch is currently pressed. Return: 0 = Not Pressed, 1 = Pressed 
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 GetLightState
Reads the state of one of the light sets. Returns the state as a number. 0=Red, 1=Red+Wait, 2=Green, 3=FlashingGreen, 4=Unknown State 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetLights
Direct control over all 3 of the lights. 
Fc9-bool-icon.png - BOOL Red
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Green
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Wait
0 = Off, 1 = On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLightState
Follows the standard pedestrian crossing light sequence. 
Fc9-u8-icon.png - BYTE SequenceNumber
0 = Red, 1 = Red+Wait, 2 = Green, 3 = Green Flashing 
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 indicator.  
Fc9-type-1-icon.png Green Colour
Colour Picker to set the Colour of the Green indicator.  
Fc9-type-1-icon.png Wait Colour
Colour Picker to set the Colour of the Wait indicator.  
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 Wait Time
Amount of time to wait in milliseconds the pedestrians have to wait before being allowed to cross. 
Fc9-type-21-icon.png Crossing Time
Amount of time to wait in milliseconds for the pedestrians to cross the road. 
Fc9-type-21-icon.png Flash Time
Amount of time to wait in milliseconds to warn pedestrians to finish crossing the road. 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Switch
Pin connection assigned to the pedestrian waiting to cross switch. 

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


Fc9-comp-macro.png ReadSwitch
Check to see if switch is currently pressed. Return: 0 = Not Pressed, 1 = Pressed 
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 GetLightState
Reads the state of one of the light sets. Returns the state as a number. 0=Red, 1=Red+Wait, 2=Green, 3=FlashingGreen, 4=Unknown State 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetLights
Direct control over all 3 of the lights. 
Fc9-bool-icon.png - BOOL Red
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Green
0 = Off, 1 = On 
Fc9-bool-icon.png - BOOL Wait
0 = Off, 1 = On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLightState
Follows the standard pedestrian crossing light sequence. 
Fc9-u8-icon.png - BYTE SequenceNumber
0 = Red, 1 = Red+Wait, 2 = Green, 3 = Green Flashing 
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 indicator.  
Fc9-type-1-icon.png Green Colour
Colour Picker to set the Colour of the Green indicator.  
Fc9-type-1-icon.png Wait Colour
Colour Picker to set the Colour of the Wait indicator.  
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 Wait Time
Amount of time to wait in milliseconds the pedestrians have to wait before being allowed to cross. 
Fc9-type-21-icon.png Crossing Time
Amount of time to wait in milliseconds for the pedestrians to cross the road. 
Fc9-type-21-icon.png Flash Time
Amount of time to wait in milliseconds to warn pedestrians to finish crossing the road. 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Switch
Pin connection assigned to the pedestrian waiting to cross switch. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Pedestrian_Crossing_(Scenarios)&oldid=34454"