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

Latest revision as of 17:24, 9 November 2022

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 Pack

MODELS

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.

Pedestrian Crossing Scenario

Downloadable 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

	ReadSwitch
Check to see if switch is currently pressed. Return: 0 = Not Pressed, 1 = Pressed
- 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+Wait, 2=Green, 3=FlashingGreen, 4=Unknown State
- BYTE	Return

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

	SetLightState
Follows the standard pedestrian crossing light sequence.
- BYTE	SequenceNumber
0 = Red, 1 = Red+Wait, 2 = Green, 3 = Green Flashing
- VOID	Return

Property reference

	Properties
	Colours
	Red Colour
Colour Picker to set the Colour of the Red indicator.
	Green Colour
Colour Picker to set the Colour of the Green indicator.
	Wait Colour
Colour Picker to set the Colour of the Wait indicator.
	Off Colour
Colour Picker to set the Colour of all indicators when they are switched off.
	Timings - Automatic Mode
	Wait Time
Amount of time to wait in milliseconds the pedestrians have to wait before being allowed to cross.
	Crossing Time
Amount of time to wait in milliseconds for the pedestrians to cross the road.
	Flash Time
Amount of time to wait in milliseconds to warn pedestrians to finish crossing the road.
	Connections
	Switch
Pin connection assigned to the pedestrian waiting to cross switch.

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

Latest revision as of 17:24, 9 November 2022

Contents

Pedestrian Crossing component

Component Pack

Detailed description

Examples

Downloadable macro reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | 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
 |}
+==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.
-==[[File:Component Icon c46023c5_27e5_4122_bf3e_4519f23cfa0c.png|Image]] Pedestrian Crossing component==
+==Component Pack==
-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.
-==Examples==
+MODELS
-''<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'''
-:''This macro has no parameters''
+There is a detailed walk through of the scenario detailed at the link below to go with this component.
-'''Return value'''
+[[Pedestrian_Crossing|Pedestrian Crossing 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" 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>ReadSwitch</tt></u></span>===
-Check to see if switch is currently pressed.
-Return: 0 = Not Pressed, 1 = Pressed
+{| 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&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''
+|}
-'''Parameters'''
-:''This macro has no 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''
+|}
-'''Return 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+Wait, 2=Green, 3=FlashingGreen, 4=Unknown State&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''
+|}
-:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
+{| 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.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Red
+|-
+| colspan="2" | 0 = Off, 1 = On&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Green
+|-
+| colspan="2" | 0 = Off, 1 = On&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Wait
+|-
+| 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''
+|}
-===<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'''
-:[[Variable Types|BOOL]] ''Mode''
-::0 = Auto Mode Disabled, 1 = Auto Mode Enabled
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>GetLightState</tt></u></span>===
-Reads the state of one of the light sets.
-Returns the state as a number.
-=Red, 1=Red+Wait, 2=Green, 3=FlashingGreen, 4=Unknown State
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|BYTE]]
-===<span style="font-weight: normal;"><u><tt>SetLights</tt></u></span>===
-Direct control over all 3 of the lights.
-'''Parameters'''
-:[[Variable Types|BOOL]] ''Red''
-::0 = Off, 1 = On
-:[[Variable Types|BOOL]] ''Green''
-::0 = Off, 1 = On
-:[[Variable Types|BOOL]] ''Wait''
-::0 = Off, 1 = On
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-'''Return value'''
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-:''This call does not return a value''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLightState'''
+|-
+| colspan="2" | Follows the standard pedestrian crossing light sequence.&nbsp;
-===<span style="font-weight: normal;"><u><tt>SetLightState</tt></u></span>===
+|-
-Follows the standard pedestrian crossing light sequence.
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-'''Parameters'''
+| width="90%" | SequenceNumber
+|-
-:[[Variable Types|BYTE]] ''SequenceNumber''
+| colspan="2" | 0 = Red, 1 = Red+Wait, 2 = Green, 3 = Green Flashing&nbsp;
-::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''
-'''Return value'''
+|}
-:''This call does not return a value''
@@ Line 127: / Line 142: @@
 ==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>Green 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 ''Green''.
+|-
+|-
-''<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 indicator. &nbsp;
-<span style="font-weight: normal;"><u>Wait 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 ''Wait''.
+| width="90%" | Green Colour
+|-
-''<span style="color:red;">No additional information</span>''
+| colspan="2" | Colour Picker to set the Colour of the Green indicator. &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
+| width="90%" | Wait Colour
-<span style="font-weight: normal;"><u>Off Colour</u></span>
+|-
+| colspan="2" | Colour Picker to set the Colour of the Wait indicator. &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>Wait 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 ''WaitTime''.
+|-
+|-
-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%" | Wait Time
-<span style="font-weight: normal;"><u>Crossing Time</u></span>
+|-
+| colspan="2" | Amount of time to wait in milliseconds the pedestrians have to wait before being allowed to cross.&nbsp;
-This property is of type ''Unsigned integer'' and can be referenced with the variable name ''CrossTime''.
+|-
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-Amount of time to wait in milliseconds for the pedestrians to cross the road.
+| width="90%" | Crossing Time
+|-
-<span style="font-weight: normal;"><u>Flash Time</u></span>
+| colspan="2" | Amount of time to wait in milliseconds for the pedestrians to cross the road.&nbsp;
+|-
-This property is of type ''Unsigned integer'' and can be referenced with the variable name ''FlashTime''.
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+| width="90%" | Flash Time
-Amount of time to wait in milliseconds to warn pedestrians to finish crossing the road.
+|-
+| colspan="2" | Amount of time to wait in milliseconds to warn pedestrians to finish crossing the road.&nbsp;
-<span style="font-weight: normal;"><u>Switch</u></span>
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''Switch''.
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+|-
-''<span style="color:red;">No additional information</span>''
+|-
+| 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.&nbsp;
+|}