rsmp 0.43.2 → 0.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +11 -11
  3. data/README.md +19 -3
  4. data/Rakefile +2 -2
  5. data/config/supervisor.yaml +2 -1
  6. data/config/tlc.yaml +2 -2
  7. data/lib/rsmp/cli.rb +29 -5
  8. data/lib/rsmp/component/component.rb +0 -4
  9. data/lib/rsmp/component/component_base.rb +15 -2
  10. data/lib/rsmp/component/component_proxy.rb +1 -1
  11. data/lib/rsmp/component/components.rb +22 -1
  12. data/lib/rsmp/convert/export/json_schema/outputs.rb +1 -0
  13. data/lib/rsmp/convert/export/json_schema/values.rb +6 -4
  14. data/lib/rsmp/convert/export/json_schema.rb +7 -3
  15. data/lib/rsmp/helpers/deep_merge.rb +2 -2
  16. data/lib/rsmp/message.rb +32 -0
  17. data/lib/rsmp/node/site/site.rb +34 -10
  18. data/lib/rsmp/node/supervisor/modules/configuration.rb +32 -5
  19. data/lib/rsmp/node/supervisor/modules/connection.rb +0 -2
  20. data/lib/rsmp/node/supervisor/supervisor.rb +0 -7
  21. data/lib/rsmp/options/options.rb +55 -6
  22. data/lib/rsmp/options/schemas/site.json +6 -3
  23. data/lib/rsmp/options/schemas/supervisor.json +5 -2
  24. data/lib/rsmp/options/schemas/supervisor_site.json +5 -2
  25. data/lib/rsmp/options/site_options.rb +3 -2
  26. data/lib/rsmp/options/supervisor_options.rb +3 -1
  27. data/lib/rsmp/proxy/modules/acknowledgements.rb +2 -0
  28. data/lib/rsmp/proxy/modules/receive.rb +5 -2
  29. data/lib/rsmp/proxy/modules/state.rb +1 -0
  30. data/lib/rsmp/proxy/modules/versions.rb +90 -15
  31. data/lib/rsmp/proxy/proxy.rb +52 -3
  32. data/lib/rsmp/proxy/site/modules/status.rb +5 -3
  33. data/lib/rsmp/proxy/site/site_proxy.rb +68 -35
  34. data/lib/rsmp/proxy/site/sxl_selection.rb +54 -0
  35. data/lib/rsmp/proxy/supervisor/supervisor_proxy.rb +54 -18
  36. data/lib/rsmp/schema/message_resolution.rb +104 -0
  37. data/lib/rsmp/schema.rb +104 -22
  38. data/lib/rsmp/schema_error.rb +7 -1
  39. data/lib/rsmp/sxl/interface.rb +48 -0
  40. data/lib/rsmp/sxl/registry.rb +55 -0
  41. data/lib/rsmp/sxl/site_interface.rb +10 -0
  42. data/lib/rsmp/sxl/supervisor_interface.rb +21 -0
  43. data/lib/rsmp/tlc/detector_logic.rb +2 -2
  44. data/lib/rsmp/tlc/signal_group.rb +2 -2
  45. data/lib/rsmp/tlc/site_interface.rb +10 -0
  46. data/lib/rsmp/tlc/{traffic_controller_proxy.rb → supervisor_interface.rb} +19 -34
  47. data/lib/rsmp/tlc/traffic_controller.rb +10 -2
  48. data/lib/rsmp/tlc/traffic_controller_site.rb +4 -2
  49. data/lib/rsmp/tlc.rb +10 -0
  50. data/lib/rsmp/version.rb +1 -1
  51. data/lib/rsmp.rb +8 -1
  52. data/rsmp.gemspec +5 -5
  53. data/schemas/core/3.3.0/aggregated_status.json +25 -0
  54. data/schemas/core/3.3.0/aggregated_status_request.json +9 -0
  55. data/schemas/core/3.3.0/alarm.json +71 -0
  56. data/schemas/core/3.3.0/alarm_acknowledge.json +11 -0
  57. data/schemas/core/3.3.0/alarm_issue.json +44 -0
  58. data/schemas/core/3.3.0/alarm_request.json +3 -0
  59. data/schemas/core/3.3.0/alarm_suspend_resume.json +3 -0
  60. data/schemas/core/3.3.0/alarm_suspended_resumed.json +44 -0
  61. data/schemas/core/3.3.0/command_request.json +24 -0
  62. data/schemas/core/3.3.0/command_response.json +35 -0
  63. data/schemas/core/3.3.0/component_list.json +24 -0
  64. data/schemas/core/3.3.0/core.json +40 -0
  65. data/schemas/core/3.3.0/definitions.json +133 -0
  66. data/schemas/core/3.3.0/message_ack.json +11 -0
  67. data/schemas/core/3.3.0/message_not_ack.json +15 -0
  68. data/schemas/core/3.3.0/rsmp.json +142 -0
  69. data/schemas/core/3.3.0/status.json +21 -0
  70. data/schemas/core/3.3.0/status_request.json +5 -0
  71. data/schemas/core/3.3.0/status_response.json +41 -0
  72. data/schemas/core/3.3.0/status_subscribe.json +31 -0
  73. data/schemas/core/3.3.0/status_unsubscribe.json +5 -0
  74. data/schemas/core/3.3.0/status_update.json +41 -0
  75. data/schemas/core/3.3.0/version.json +144 -0
  76. data/schemas/core/3.3.0/watchdog.json +9 -0
  77. data/schemas/tlc/1.3.0/alarms/A0001.json +4 -0
  78. data/schemas/tlc/1.3.0/alarms/A0002.json +4 -0
  79. data/schemas/tlc/1.3.0/alarms/A0003.json +4 -0
  80. data/schemas/tlc/1.3.0/alarms/A0004.json +4 -0
  81. data/schemas/tlc/1.3.0/alarms/A0005.json +4 -0
  82. data/schemas/tlc/1.3.0/alarms/A0006.json +4 -0
  83. data/schemas/tlc/1.3.0/alarms/A0007.json +34 -0
  84. data/schemas/tlc/1.3.0/alarms/A0008.json +30 -0
  85. data/schemas/tlc/1.3.0/alarms/A0009.json +4 -0
  86. data/schemas/tlc/1.3.0/alarms/A0010.json +4 -0
  87. data/schemas/tlc/1.3.0/alarms/A0101.json +4 -0
  88. data/schemas/tlc/1.3.0/alarms/A0201.json +35 -0
  89. data/schemas/tlc/1.3.0/alarms/A0202.json +35 -0
  90. data/schemas/tlc/1.3.0/alarms/A0301.json +92 -0
  91. data/schemas/tlc/1.3.0/alarms/A0302.json +115 -0
  92. data/schemas/tlc/1.3.0/alarms/A0303.json +92 -0
  93. data/schemas/tlc/1.3.0/alarms/A0304.json +115 -0
  94. data/schemas/tlc/1.3.0/alarms/alarms.json +287 -0
  95. data/schemas/tlc/1.3.0/commands/M0001.json +92 -0
  96. data/schemas/tlc/1.3.0/commands/M0002.json +69 -0
  97. data/schemas/tlc/1.3.0/commands/M0003.json +69 -0
  98. data/schemas/tlc/1.3.0/commands/M0004.json +51 -0
  99. data/schemas/tlc/1.3.0/commands/M0005.json +69 -0
  100. data/schemas/tlc/1.3.0/commands/M0006.json +69 -0
  101. data/schemas/tlc/1.3.0/commands/M0007.json +51 -0
  102. data/schemas/tlc/1.3.0/commands/M0008.json +87 -0
  103. data/schemas/tlc/1.3.0/commands/M0010.json +51 -0
  104. data/schemas/tlc/1.3.0/commands/M0011.json +51 -0
  105. data/schemas/tlc/1.3.0/commands/M0012.json +51 -0
  106. data/schemas/tlc/1.3.0/commands/M0013.json +51 -0
  107. data/schemas/tlc/1.3.0/commands/M0014.json +69 -0
  108. data/schemas/tlc/1.3.0/commands/M0015.json +69 -0
  109. data/schemas/tlc/1.3.0/commands/M0016.json +51 -0
  110. data/schemas/tlc/1.3.0/commands/M0017.json +51 -0
  111. data/schemas/tlc/1.3.0/commands/M0018.json +69 -0
  112. data/schemas/tlc/1.3.0/commands/M0019.json +87 -0
  113. data/schemas/tlc/1.3.0/commands/M0020.json +87 -0
  114. data/schemas/tlc/1.3.0/commands/M0021.json +51 -0
  115. data/schemas/tlc/1.3.0/commands/M0022.json +249 -0
  116. data/schemas/tlc/1.3.0/commands/M0023.json +51 -0
  117. data/schemas/tlc/1.3.0/commands/M0024.json +33 -0
  118. data/schemas/tlc/1.3.0/commands/M0103.json +72 -0
  119. data/schemas/tlc/1.3.0/commands/M0104.json +141 -0
  120. data/schemas/tlc/1.3.0/commands/command_requests.json +8 -0
  121. data/schemas/tlc/1.3.0/commands/command_responses.json +8 -0
  122. data/schemas/tlc/1.3.0/commands/commands.json +415 -0
  123. data/schemas/tlc/1.3.0/defs/definitions.json +72 -0
  124. data/schemas/tlc/1.3.0/defs/guards.json +24 -0
  125. data/schemas/tlc/1.3.0/rsmp.json +74 -0
  126. data/schemas/tlc/1.3.0/statuses/S0001.json +109 -0
  127. data/schemas/tlc/1.3.0/statuses/S0002.json +36 -0
  128. data/schemas/tlc/1.3.0/statuses/S0003.json +36 -0
  129. data/schemas/tlc/1.3.0/statuses/S0004.json +36 -0
  130. data/schemas/tlc/1.3.0/statuses/S0005.json +72 -0
  131. data/schemas/tlc/1.3.0/statuses/S0006.json +54 -0
  132. data/schemas/tlc/1.3.0/statuses/S0007.json +73 -0
  133. data/schemas/tlc/1.3.0/statuses/S0008.json +73 -0
  134. data/schemas/tlc/1.3.0/statuses/S0009.json +73 -0
  135. data/schemas/tlc/1.3.0/statuses/S0010.json +73 -0
  136. data/schemas/tlc/1.3.0/statuses/S0011.json +73 -0
  137. data/schemas/tlc/1.3.0/statuses/S0012.json +73 -0
  138. data/schemas/tlc/1.3.0/statuses/S0013.json +54 -0
  139. data/schemas/tlc/1.3.0/statuses/S0014.json +55 -0
  140. data/schemas/tlc/1.3.0/statuses/S0015.json +55 -0
  141. data/schemas/tlc/1.3.0/statuses/S0016.json +36 -0
  142. data/schemas/tlc/1.3.0/statuses/S0017.json +36 -0
  143. data/schemas/tlc/1.3.0/statuses/S0018.json +61 -0
  144. data/schemas/tlc/1.3.0/statuses/S0019.json +36 -0
  145. data/schemas/tlc/1.3.0/statuses/S0020.json +54 -0
  146. data/schemas/tlc/1.3.0/statuses/S0021.json +37 -0
  147. data/schemas/tlc/1.3.0/statuses/S0022.json +36 -0
  148. data/schemas/tlc/1.3.0/statuses/S0023.json +37 -0
  149. data/schemas/tlc/1.3.0/statuses/S0024.json +36 -0
  150. data/schemas/tlc/1.3.0/statuses/S0025.json +162 -0
  151. data/schemas/tlc/1.3.0/statuses/S0026.json +36 -0
  152. data/schemas/tlc/1.3.0/statuses/S0027.json +36 -0
  153. data/schemas/tlc/1.3.0/statuses/S0028.json +36 -0
  154. data/schemas/tlc/1.3.0/statuses/S0029.json +36 -0
  155. data/schemas/tlc/1.3.0/statuses/S0030.json +36 -0
  156. data/schemas/tlc/1.3.0/statuses/S0031.json +36 -0
  157. data/schemas/tlc/1.3.0/statuses/S0032.json +73 -0
  158. data/schemas/tlc/1.3.0/statuses/S0033.json +77 -0
  159. data/schemas/tlc/1.3.0/statuses/S0034.json +36 -0
  160. data/schemas/tlc/1.3.0/statuses/S0035.json +49 -0
  161. data/schemas/tlc/1.3.0/statuses/S0091.json +40 -0
  162. data/schemas/tlc/1.3.0/statuses/S0092.json +40 -0
  163. data/schemas/tlc/1.3.0/statuses/S0095.json +36 -0
  164. data/schemas/tlc/1.3.0/statuses/S0096.json +126 -0
  165. data/schemas/tlc/1.3.0/statuses/S0097.json +54 -0
  166. data/schemas/tlc/1.3.0/statuses/S0098.json +72 -0
  167. data/schemas/tlc/1.3.0/statuses/S0201.json +54 -0
  168. data/schemas/tlc/1.3.0/statuses/S0202.json +54 -0
  169. data/schemas/tlc/1.3.0/statuses/S0203.json +54 -0
  170. data/schemas/tlc/1.3.0/statuses/S0204.json +198 -0
  171. data/schemas/tlc/1.3.0/statuses/S0205.json +54 -0
  172. data/schemas/tlc/1.3.0/statuses/S0206.json +54 -0
  173. data/schemas/tlc/1.3.0/statuses/S0207.json +54 -0
  174. data/schemas/tlc/1.3.0/statuses/S0208.json +198 -0
  175. data/schemas/tlc/1.3.0/statuses/statuses.json +787 -0
  176. data/schemas/tlc/1.3.0/sxl.yaml +2296 -0
  177. metadata +144 -12
@@ -0,0 +1,2296 @@
1
+ ---
2
+ meta:
3
+ name: tlc
4
+ description: Traffic Light Controllers
5
+ version: 1.3.0
6
+ objects:
7
+ Traffic Light Controller:
8
+ description:
9
+ aggregated_status:
10
+ 1:
11
+ title: Local mode
12
+ description: Traffic Light Controller is in local mode. NTS has no control.
13
+ 2:
14
+ title: No Communications
15
+ description: Not used
16
+ 3:
17
+ title: High Priority Fault
18
+ description: Traffic Light Controller is in fail-safe mode; e.g. yellow flash
19
+ or dark mode
20
+ 4:
21
+ title: Medium Priority Fault
22
+ description: |-
23
+ Traffic Light Controller has a medium priority fault, but not in fail-safe mode.
24
+ E.g. several lamp faults or detector fault
25
+ 5:
26
+ title: Low Priority Fault
27
+ description: Traffic Light Controller has a low priority fault. E.g. Detector
28
+ fault
29
+ 6:
30
+ title: Connected - In Use
31
+ description: Traffic Light Controller is not in dark mode or in yellow flash
32
+ 7:
33
+ title: Connected - Idle
34
+ description: Traffic Light Controller is in dark mode or in yellow flash
35
+ 8:
36
+ title: Not Connected
37
+ description: Not used
38
+ functional_position: null
39
+ functional_state: null
40
+ alarms:
41
+ A0001:
42
+ description: |-
43
+ Serious hardware error.
44
+ Is a "major fault" defined according to 3.8 in EN12675 which causes the controller to switch to a "failure mode" according to 3.6 in EN12675.
45
+ priority: 2
46
+ category: D
47
+ from_version: 1.0.0
48
+ A0002:
49
+ description: |-
50
+ Less serious hardware error.
51
+ Is a "minor fault" defined according to 3.11 in EN12675.
52
+ priority: 3
53
+ category: D
54
+ from_version: 1.0.0
55
+ A0003:
56
+ description: |-
57
+ Serious configuration error.
58
+ Is a "major fault" defined according to 3.8 in EN12675 which causes the controller to switch to a "failure mode" according to 3.6 in EN12675.
59
+ priority: 2
60
+ category: D
61
+ from_version: 1.0.0
62
+ A0004:
63
+ description: |-
64
+ Less serious configuration error.
65
+ Is a "minor fault" defined according to 3.11 in EN12675.
66
+ priority: 3
67
+ category: D
68
+ from_version: 1.0.0
69
+ A0005:
70
+ description: |-
71
+ Synchronisation error (coordination).
72
+ Is a "minor fault" defined according to 3.11 in EN12675.
73
+ priority: 3
74
+ category: D
75
+ from_version: 1.0.0
76
+ A0006:
77
+ description: |-
78
+ Safety error
79
+ Is a "major fault" defined according to 3.8 in EN12675 which causes the controller to switch to a "failure mode" according to 3.6 in EN12675.
80
+ priority: 2
81
+ category: D
82
+ from_version: 1.0.0
83
+ A0007:
84
+ description: |-
85
+ Communication error.
86
+ Used for communication errors with the central system. Includes NTP connection loss if the TLC is configured to use NTP.
87
+ Is a "minor fault" defined according to 3.11 in EN12675.
88
+ priority: 3
89
+ category: D
90
+ from_version: 1.0.0
91
+ arguments:
92
+ protocol:
93
+ type: string
94
+ description: Type of communication error, e.g. NTP or RSMP
95
+ values:
96
+ rsmp: RSMP
97
+ ntp: NTP
98
+ A0009:
99
+ description: |-
100
+ Other error.
101
+ Used for other errors not covered by any other alarm type.
102
+ Is a "minor fault" defined according to 3.11 in EN12675.
103
+ priority: 3
104
+ category: D
105
+ from_version: 1.0.0
106
+ A0010:
107
+ description: |-
108
+ Door open.
109
+ Used for open door (room or cabinet).
110
+ priority: 3
111
+ category: D
112
+ from_version: 1.0.15
113
+ statuses:
114
+ S0001:
115
+ description: |-
116
+ Signal group status.
117
+ Provides the status of each signal group, e.g. green, yellow, red,
118
+ or other states used in the signal program.
119
+ See the section on signal group states for more information about
120
+ the possible states.
121
+
122
+ Can be used to draw a live signal group diagram as well as to provide
123
+ diagnostic information about the performance of the controller.
124
+
125
+ The base cycle counter is computed based on the internal clock and
126
+ the cycle time. Controllers in active coordination will have
127
+ synchronized base cycle counters.
128
+
129
+ The cycle clock is based on the base cycle counter, but shifts the
130
+ phase using the offset set in the controller:
131
+
132
+ c = (b + o) modulo t
133
+
134
+ where: \
135
+ c = cycle counter \
136
+ b = base cycle counter \
137
+ o = offset \
138
+ t = cycle time
139
+
140
+ THe cycle counter and base cycle counter are both specified using whole seconds.
141
+
142
+ See the coordination section for more information about cycle
143
+ counters.
144
+
145
+ The millisecond attributes provides the high resolution cycle counter
146
+ (not base cycle counter) of the the last signal group change.
147
+ If the controller internally works with discrete ticks, the value must
148
+ be quantized to the tick where the signal groups changed.
149
+ E.g. if the controller uses 100ms ticks, the value must be
150
+ quantized to 0, 100, 200, 300...
151
+
152
+ The millisecond attribute updates only when one or more signal group states changes,
153
+ NOT every millisecond. Subscribing with **sendOnChange** will therefore not result in
154
+ updates every millisecond.
155
+ from_version: 1.0.0
156
+ arguments:
157
+ signalgroupstatus:
158
+ type: string
159
+ description: |-
160
+ Signal group status as text field.
161
+ Each character represents the state of the signal group in consecutive order,
162
+ where the leftmost character starts with signal group 1.
163
+ Signal group status is described in detail in the corresponding section.
164
+ A dash "-" is used for undefined/non-existing signal groups.
165
+ pattern: "^[a-hA-G0-9N-P]*$"
166
+ basecyclecounter:
167
+ type: integer_as_string
168
+ description: |-
169
+ Base cycle counter.
170
+ Updates once per second, counting from 0 and wrapping around when reaching the cycle time.
171
+ min: 0
172
+ max: 999
173
+ cyclecounter:
174
+ type: integer_as_string
175
+ description: |-
176
+ Cycle counter.
177
+ Updates once per second, counting from 0 and wrapping around when reaching the cycle time.
178
+ min: 0
179
+ max: 999
180
+ millisecond:
181
+ type: integer_as_string
182
+ min: 0
183
+ max: 999999
184
+ description: |-
185
+ Provides the cycle counter (not base cycle counter) in milliseconds
186
+ of when the last signal group state changed occured.
187
+ Updates only when the signalgroupstatus attribute changes.
188
+ stage:
189
+ type: integer_as_string
190
+ description: Current stage (isolated)
191
+ min: 0
192
+ max: 999
193
+ S0002:
194
+ description: |-
195
+ Detector logic status.
196
+ Provides the status of all detector logics of the controller.
197
+ Can be used to draw a live signal group diagram as well provide diagnostic information about the performance of the controller. Can also be used for bus priority, external control systems, and much more.
198
+ from_version: 1.0.2
199
+ arguments:
200
+ detectorlogicstatus:
201
+ type: string_list_as_string
202
+ description: |-
203
+ Detector logic status as text field.
204
+ Each character represent the state of the detector logic in consecutive order,
205
+ where the leftmost character starts with detector logic 1.
206
+ 0 : Detector logic is not active
207
+ 1 : Detector logic is active
208
+ - : Detector logic is undefined/does not exist
209
+ S0003:
210
+ description: |-
211
+ Input status.
212
+ Input (1-255) of the controllers general purpose I/O.
213
+ Input is used where the traffic light controller must react to external control. It could be external detectors, bus priority, and much more.
214
+ from_version: 1.0.2
215
+ arguments:
216
+ inputstatus:
217
+ type: string_list_as_string
218
+ description: |-
219
+ Input status as text field.
220
+ Each character represent the state of the input in consecutive order,
221
+ where the leftmost character starts with input 1.
222
+ 0 : Input is not active
223
+ 1 : Input is active
224
+ - : Input is undefined/does not exist
225
+ S0004:
226
+ description: |-
227
+ Output status.
228
+ Output (1-255) of the controllers general purpose I/O.
229
+ Can be used for all types of output where the traffic light controller needs to control other equipment. Can be used for bus priority, coordination between traffic controllers, external control systems, and much more.
230
+ from_version: 1.0.2
231
+ arguments:
232
+ outputstatus:
233
+ type: string
234
+ description: |-
235
+ Output status as text field.
236
+ Each character represent the state of the output status in consecutive order,
237
+ where the leftmost character starts with output 1.
238
+ 0 : Output is not active
239
+ 1 : Output is active
240
+ - : Output is undefined/does not exist
241
+ S0005:
242
+ description: |-
243
+ Traffic Light Controller starting.
244
+ The traffic signal is starting, e.g. it is in startup mode and has not begun working normally yet.
245
+ During startup mode the traffic controller shows dark, red, yellow flash or using the predetermined start cycle (minimum times).
246
+ from_version: 1.0.2
247
+ arguments:
248
+ status:
249
+ type: boolean_as_string
250
+ description: |-
251
+ False: Controller is not in start up mode
252
+ True: Controller is currently in start up mode
253
+ statusByIntersection:
254
+ description: |-
255
+ False: Intersection is not in start up mode
256
+ True: Intersection is currently in start up mode
257
+ type: array
258
+ items:
259
+ intersection:
260
+ type: integer_as_string
261
+ description: Intersection id
262
+ min: 0
263
+ max: 255
264
+ startup:
265
+ type: boolean_as_string
266
+ description: Start up mode
267
+ S0006:
268
+ description: |-
269
+ Emergency route.
270
+ The status is active during emergency prioritization.
271
+ Used in situations where full priority is given in the emergency vehicle program
272
+ or for other types of priority in some cases.
273
+
274
+ If no emergency route is active, status should be set to False, and emergencystage to zero.
275
+
276
+ Deprecated, use S0035 instead.
277
+ from_version: 1.0.2
278
+ arguments:
279
+ status:
280
+ type: boolean_as_string
281
+ deprecated: true
282
+ description: |-
283
+ False: Emergency route inactive
284
+ True: Emergency route active
285
+ emergencystage:
286
+ type: integer_as_string
287
+ deprecated: true
288
+ description: Number of emergency route (set to zero if no route is active)
289
+ min: 0
290
+ max: 255
291
+ S0007:
292
+ description: |-
293
+ Controller switched on.
294
+ The controller is active and is not in dark mode.
295
+ Used to determine if the there is output to the signal heads, e.g. it shows red, green or yellow to the vehicles.
296
+ During maintenance work the controller might be using dark mode (no output to the signal heads).
297
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. "0" and "True" (one intersection) or "1,2" and "True,False" (two intersections).
298
+ from_version: 1.0.2
299
+ arguments:
300
+ intersection:
301
+ type: integer_list_as_string
302
+ description: |-
303
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
304
+ Use “0” for all intersections of the TLC.
305
+ min: 0
306
+ max: 255
307
+ status:
308
+ type: boolean_list_as_string
309
+ description: |-
310
+ False: Traffic Light Controller in dark mode
311
+ True: Traffic Light Controller not in dark mode
312
+ source:
313
+ description: Source of the status change
314
+ type: string_list_as_string
315
+ values:
316
+ operator_panel: Operator panel
317
+ calendar_clock: Calendar/clock
318
+ control_block: Control block
319
+ forced: Forced due to external command e.g. supervisor
320
+ startup: Set after startup mode
321
+ other: Other reason
322
+ S0008:
323
+ description: |-
324
+ Manual control.
325
+ Traffic control deactivated in controller.
326
+ Signal timings is controlled manually by service personnel using the operating panel of the controller.
327
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. "0" and "True" (one intersection) or "1,2" and "True,False" (two intersections).
328
+ from_version: 1.0.2
329
+ arguments:
330
+ intersection:
331
+ type: integer_list_as_string
332
+ description: |-
333
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
334
+ Use “0” for all intersections of the TLC.
335
+ min: 0
336
+ max: 255
337
+ status:
338
+ type: boolean_list_as_string
339
+ description: |-
340
+ False: Manual control inactive
341
+ True: Manual control active
342
+ source:
343
+ type: string_list_as_string
344
+ description: Source of the status change
345
+ values:
346
+ operator_panel: Operator panel
347
+ calendar_clock: Calendar/clock
348
+ control_block: Control block
349
+ forced: Forced due to external command e.g. supervisor
350
+ startup: Set after startup mode
351
+ other: Other reason
352
+ S0009:
353
+ description: |-
354
+ Fixed time control.
355
+ Traffic actuated control deactivated and a pre-timed control is used.
356
+ Usually only used in case normal detectors can't be used, e.g. during maintenance work.
357
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. "0" and "True" (one intersection) or "1,2" and "True,False" (two intersections).
358
+ from_version: 1.0.2
359
+ arguments:
360
+ intersection:
361
+ type: integer_list_as_string
362
+ description: |-
363
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
364
+ Use “0” for all intersections of the TLC.
365
+ min: 0
366
+ max: 255
367
+ status:
368
+ type: boolean_list_as_string
369
+ description: |-
370
+ False: Fixed time control inactive
371
+ True: Fixed time control active
372
+ source:
373
+ type: string_list_as_string
374
+ description: Source of the status change
375
+ values:
376
+ operator_panel: Operator panel
377
+ calendar_clock: Calendar/clock
378
+ control_block: Control block
379
+ forced: Forced due to external command e.g. supervisor
380
+ startup: Set after startup mode
381
+ other: Other reason
382
+ S0010:
383
+ description: |-
384
+ Isolated control.
385
+ Isolated control mode indicates that the controller operates independently of any other traffic light controller. This may be different depending on traffic program (time plan).
386
+ Used to determine if the controller is operating independently or operating with other controllers (coordination).
387
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. "0" and "True" (one intersection) or "1,2" and "True,False" (two intersections).
388
+ from_version: 1.0.2
389
+ arguments:
390
+ intersection:
391
+ type: integer_list_as_string
392
+ description: |-
393
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
394
+ Use “0” for all intersections of the TLC.
395
+ min: 0
396
+ max: 255
397
+ status:
398
+ type: boolean_list_as_string
399
+ description: |-
400
+ False: Isolated control disabled
401
+ True: Isolated control enabled (Vehicle actuated control or Fixed time control)
402
+ source:
403
+ type: string_list_as_string
404
+ description: Source of the status change
405
+ values:
406
+ operator_panel: Operator panel
407
+ calendar_clock: Calendar/clock
408
+ control_block: Control block
409
+ forced: Forced due to external command e.g. supervisor
410
+ startup: Set after startup mode
411
+ other: Other reason
412
+ S0011:
413
+ description: |-
414
+ Yellow flash.
415
+ The controller shows yellow flash.
416
+ Yellow flash may be used during a serious fault (depending on configuration) or maintenance work. It can also be manually set using M0001.
417
+ Some countries may use yellow flash as a normal operating mode, and not necessarily during fault.
418
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. "1,2" and "True,False"
419
+ from_version: 1.0.2
420
+ arguments:
421
+ intersection:
422
+ type: integer_list_as_string
423
+ description: |-
424
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
425
+ Use “0” for all intersections of the TLC.
426
+ min: 0
427
+ max: 255
428
+ status:
429
+ type: boolean_list_as_string
430
+ description: |-
431
+ False: Yellow flash disabled
432
+ True: Yellow flash enabled
433
+ source:
434
+ type: string_list_as_string
435
+ description: Source of the status change
436
+ values:
437
+ operator_panel: Operator panel
438
+ calendar_clock: Calendar/clock
439
+ control_block: Control block
440
+ forced: Forced due to external command e.g. supervisor
441
+ startup: Set after startup mode
442
+ other: Other reason
443
+ S0012:
444
+ description: |-
445
+ All red.
446
+ The controller show all red.
447
+ All red can be manually set using the controllers operating panel during maintenance work.
448
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. "1,2" and "True,False"
449
+ from_version: 1.0.2
450
+ arguments:
451
+ intersection:
452
+ type: integer_list_as_string
453
+ description: |-
454
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
455
+ Use “0” for all intersections of the TLC.
456
+ min: 0
457
+ max: 255
458
+ status:
459
+ type: boolean_list_as_string
460
+ description: |-
461
+ False: All red disabled
462
+ True: All red enabled
463
+ source:
464
+ type: string_list_as_string
465
+ description: Source of the status change
466
+ values:
467
+ operator_panel: Operator panel
468
+ calendar_clock: Calendar/clock
469
+ control_block: Control block
470
+ forced: Forced due to external command e.g. supervisor
471
+ startup: Set after startup mode
472
+ other: Other reason
473
+ S0013:
474
+ description: |-
475
+ Police key
476
+ The controller is forced to dark mode or yellow flash.
477
+ The "police key" is an external control switch present in some controllers that manually switches the controller to either dark mode or yellow flash.
478
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. "1,2" and "0,1"
479
+ from_version: 1.0.2
480
+ arguments:
481
+ intersection:
482
+ type: integer_list_as_string
483
+ description: |-
484
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
485
+ Use “0” for all intersections of the TLC.
486
+ min: 0
487
+ max: 255
488
+ status:
489
+ type: integer_list_as_string
490
+ values:
491
+ 0: disabled
492
+ 1: dark mode
493
+ 2: yellow flash
494
+ 3: all red
495
+ S0014:
496
+ description: |-
497
+ Current time plan.
498
+ The current time plan (signal program) used in the controller. There may be 1-255 predefined time plans.
499
+ The time plan (signal program) may change signal timings, cycle time, control strategy and much more. Typical usage is scenario based control where change of program is used to change priority etc.
500
+ from_version: 1.0.2
501
+ arguments:
502
+ status:
503
+ type: integer_as_string
504
+ description: Current time plan
505
+ min: 1
506
+ max: 255
507
+ source:
508
+ type: string_list_as_string
509
+ description: Source of the status change
510
+ values:
511
+ operator_panel: Operator panel
512
+ calendar_clock: Calendar/clock
513
+ control_block: Control block
514
+ forced: Forced due to external command e.g. supervisor
515
+ startup: Set after startup mode
516
+ other: Other reason
517
+ S0015:
518
+ description: |-
519
+ Current traffic situation.
520
+ The current traffic situation used in the controller.
521
+ Used for area-based control where the M0003 command can be sent to a master traffic light controller about which predefined traffic situation to use (1-255).
522
+ Traffic situation is a concept used to divide multiple TLC's into areas and sub-areas. The traffic situation gives the possibility to change the TLC sub-area dynamically depending on the time of day and the traffic flow. Depending on the traffic situation each TLC selects the time plan dynamically.
523
+ from_version: 1.0.2
524
+ arguments:
525
+ status:
526
+ type: integer_as_string
527
+ description: Current traffic situation
528
+ min: 1
529
+ max: 255
530
+ source:
531
+ type: string_list_as_string
532
+ description: Source of the status change
533
+ values:
534
+ operator_panel: Operator panel
535
+ calendar_clock: Calendar/clock
536
+ control_block: Control block
537
+ forced: Forced due to external command e.g. supervisor
538
+ startup: Set after startup mode
539
+ other: Other reason
540
+ S0016:
541
+ description: |-
542
+ Number of detector logics.
543
+ Can be used by the management system to check the number of detector logics configured in the controller.
544
+ from_version: 1.0.2
545
+ arguments:
546
+ number:
547
+ type: integer_as_string
548
+ description: Number of detector logics
549
+ min: 1
550
+ max: 65025
551
+ S0017:
552
+ description: |-
553
+ Number of signal groups.
554
+ Can be used for the management system to check the number of signal groups configured in the controller.
555
+ from_version: 1.0.2
556
+ arguments:
557
+ number:
558
+ type: integer_as_string
559
+ description: Number of signal groups
560
+ min: 1
561
+ max: 65025
562
+ S0019:
563
+ description: |-
564
+ Number of traffic situations.
565
+ Can be used for the management system to check the number of traffic situations configured in the controller.
566
+ from_version: 1.0.2
567
+ arguments:
568
+ number:
569
+ type: integer_as_string
570
+ description: Number of traffic situations
571
+ min: 1
572
+ max: 65025
573
+ S0020:
574
+ description: |-
575
+ Control mode.
576
+ Can be used for the management system to check the current control mode (startup, normal, standby, failure, test).
577
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. "1,2" and "startup,control"
578
+ from_version: 1.0.2
579
+ arguments:
580
+ intersection:
581
+ type: integer_list_as_string
582
+ description: |-
583
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
584
+ Use “0” for all intersections of the TLC.
585
+ min: 0
586
+ max: 255
587
+ controlmode:
588
+ type: string_list_as_string
589
+ values:
590
+ startup: The controller starts up, performs a power on self test and performs each :term:`start-up interval`
591
+ control: Normal 3-light control
592
+ standby: The controller is in dark or yellow flash mode (either according to programming or manually set)
593
+ failure: The controller has a “major fault” defined according to 3.8 in EN12675. The controller is in dark or yellow flash mode
594
+ test: Mode used for various tests, e.g. signal lights
595
+ S0021:
596
+ description: |-
597
+ Manually set detector logic.
598
+ Provides status of detector logic (1-255) regarding if they are either forced to true or false.
599
+ Can be used to connect RSMP compatible detection equipment to the traffic light controller. Can also be used for prioritization.
600
+ from_version: 1.0.3
601
+ arguments:
602
+ detectorlogics:
603
+ type: string
604
+ description: |-
605
+ Manually set detector logic as text field.
606
+ Each character represent the state in consecutive order,
607
+ where the leftmost character starts with detector logic 1.
608
+ 0 : Detector logic not manually set
609
+ 1 : Detector logic manually set
610
+ - : Detector logic is undefined/does not exist
611
+ pattern: "^[01]*$"
612
+ S0022:
613
+ description: |-
614
+ List of time plans.
615
+ Provides a list of the configured time plans which is possible to use. This status was added due to status S0018 only provided the total number of time plans and not which were possible to use with M0002.
616
+ Can be used for the management system to check the number of time plans configured in the controller.
617
+ from_version: 1.0.13
618
+ arguments:
619
+ status:
620
+ type: integer_list_as_string
621
+ description: Comma separated list of configured time plans. E.g. "1,2,3,5"
622
+ S0023:
623
+ description: |-
624
+ Dynamic bands.
625
+ Provides a list of all defined dynamic bands. Dynamic bands moves start of signal groups in the cycle and changes the signal timings.
626
+ A typical usage of dynamic bands is scenario based control where changing of signal timings is used for optimal traffic flow.
627
+ from_version: 1.0.13
628
+ arguments:
629
+ status:
630
+ type: string
631
+ description: |-
632
+ Dynamic bands.
633
+ Each dynamic band are written as pp-dd-ee where:
634
+ pp=Time plan
635
+ dd=Dynamic band number (from 1-10)
636
+ ee=Extension in seconds in this band
637
+
638
+ Each dynamic band is separated with a comma.
639
+
640
+ E.g.
641
+ pp-dd-ee,pp-dd-ee
642
+ pattern: "(^$)|(^(?<item>(\\d{1,2})\\-\\d{1,2}-\\d{1,2})(,\\g<item>)*$)"
643
+ S0024:
644
+ description: |-
645
+ Offset time.
646
+ Offset time is used to define an offset between intersections in coordinated control. It is based on the expected travel time between intersections.
647
+ Can be used by the management system to check to fine tune the coordination for optimal traffic flow.
648
+ from_version: 1.0.13
649
+ arguments:
650
+ status:
651
+ type: string_list_as_string
652
+ description: |-
653
+ Offset table
654
+ Each offset time is written as p-t where:
655
+ p=time plan number (from 1 to 255)
656
+ t=offset time in seconds (from 0 to 255)
657
+
658
+ Each offset time is separated with a comma
659
+
660
+ E.g.
661
+ 1-0,2-13-3-7
662
+ pattern: "^(\\d{1,3}\\-\\d{1,3})(?:,(\\d{1,3}\\-\\d{1,3}))*$"
663
+ S0026:
664
+ description: |-
665
+ Week time table.
666
+ Week time table for signal programs (time plan) to use for each day during a week.
667
+ The week time table determine which predefined signal timings (time plan) to use during the week for optimal traffic flow.
668
+ from_version: 1.0.13
669
+ arguments:
670
+ status:
671
+ type: string_list_as_string
672
+ description: |-
673
+ Week time table. Defines time table to use for each week day
674
+ Each day is written as d-t where:
675
+ d=day of week
676
+ t=time table nr
677
+
678
+ Day of week legend:
679
+ 0=Monday
680
+ 1=Tuesday
681
+ 2=Wednesday
682
+ 3=Thursday
683
+ 4=Friday
684
+ 5=Saturday
685
+ 6=Sunday
686
+
687
+ Each segment is separated with a comma
688
+ E.g.
689
+ d-t,d-t
690
+ S0027:
691
+ description: |-
692
+ Time tables.
693
+ Time of day for when to switch signal program (time plan).
694
+ The signal timings (time plan) to use during time of day for optimal traffic flow.
695
+ from_version: 1.0.13
696
+ arguments:
697
+ status:
698
+ type: string_list_as_string
699
+ description: |-
700
+ Time Table. Defines time tables.
701
+ Each time definition is written as t-o-h-m where:
702
+ t=time table nr (1-12)
703
+ o=function
704
+ h=hour - switching time
705
+ m=minute - switching minute
706
+
707
+ Function legend:
708
+ 0=no plan is selected by time table
709
+ 1=set plan 1
710
+
711
+ 16= set plan 16
712
+
713
+ hour and minute is using local time (not UTC)
714
+
715
+ Each time definition is separated with a comma
716
+
717
+ E.g.
718
+ t-o-h-m,t-o-h-m
719
+ S0028:
720
+ description: |-
721
+ Cycle time.
722
+ Cycle time (or cycle length) is the sum of all phases in a time plan (traffic program). This time is fixed when using fixed time control or coordination (except "local coordination"). When the cycle counter reaches this length it is reset back to zero.
723
+ Changing the cycle time can be used as part of scenario based control.
724
+ from_version: 1.0.13
725
+ arguments:
726
+ status:
727
+ type: string_list_as_string
728
+ description: |-
729
+ Cycle time table
730
+ Each cycle time is written as pp-tt where:
731
+ pp=time plan
732
+ tt=cycle time in seconds
733
+
734
+ Each cycle time is separated with a comma
735
+
736
+ E.g.
737
+ pp-tt,pp-tt
738
+ S0029:
739
+ description: |-
740
+ Forced input status.
741
+ Provide status of input (1-255) regarding if they are forced or not. Can be used for all types of input where the traffic light controller must react to external control.
742
+ Can be used for bus priority, coordination between traffic controllers, external control systems, and much more.
743
+ from_version: 1.0.13
744
+ arguments:
745
+ status:
746
+ type: string
747
+ description: |-
748
+ Forced input status as text field.
749
+ Each character represent the state in consecutive order,
750
+ where the leftmost character starts with input 1.
751
+ 0 : Input not forced
752
+ 1 : Input forced
753
+ - : Input undefined/does not exist
754
+ S0030:
755
+ description: |-
756
+ Forced output status.
757
+ Provide status of output (1-255) regarding if they are forced or not. Can be used for all types of output where the traffic light controller needs to control other equipment.
758
+ Can be used for bus priority, coordination between traffic controllers, external control systems, and much more.
759
+ from_version: 1.0.15
760
+ arguments:
761
+ status:
762
+ type: string
763
+ description: |-
764
+ Forced output status as text field.
765
+ Each character represent the state in consecutive order,
766
+ where the leftmost character starts with output 1.
767
+ 0 : Output not forced
768
+ 1 : Output forced
769
+ - : Output undefined/does not exist
770
+ S0031:
771
+ description: |-
772
+ Trigger level sensitivity for loop detector.
773
+ The trigger level sensitivity determines at what level the loop detector should trigger. If it set too low then then traffic will not be detected as intended. If it is set too high the detector might give false positives.
774
+ Can be used to make sure that the detectors detect traffic as intended.
775
+ from_version: 1.0.15
776
+ arguments:
777
+ status:
778
+ type: string_list_as_string
779
+ description: |-
780
+ Loop detector trigger level sensitivity is written as dd-ss where:
781
+ dd=loop detector number
782
+ ss=sensitivity value
783
+ Each loop detector is separated with a comma. E.g.dd-ss,dd-ss.
784
+ S0032:
785
+ description: |-
786
+ Coordinated control
787
+ This status is used when coordination between traffic light controllers is active. Coordination is described in detail in the corresponding section
788
+ Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. “1,2” and “centralized,off”
789
+ from_version: 1.1.0
790
+ arguments:
791
+ intersection:
792
+ type: integer_list_as_string
793
+ description: |-
794
+ Comma separated list of intersections which the status relates to, e.g. “1,2”.
795
+ Use “0” for all intersections of the TLC.
796
+ min: 0
797
+ max: 255
798
+ status:
799
+ type: string_list_as_string
800
+ values:
801
+ local: Local coordination
802
+ centralized: Coordination with synchronized clock
803
+ 'off': Coordination not active
804
+ source:
805
+ description: Source of the status change
806
+ type: string_list_as_string
807
+ values:
808
+ operator_panel: Operator panel
809
+ calendar_clock: Calendar/clock
810
+ control_block: Control block
811
+ forced: Forced due to external command e.g. supervisor
812
+ startup: Set after startup mode
813
+ other: Other reason
814
+ S0033:
815
+ description: |-
816
+ Signal Priority Status
817
+ This status can be used to get updates about priority requests. For example, you can use it to know when priority requests are activated or cancelled.
818
+ A list of priorities is returned, referred to by their request ids. The same request id can appear only once.
819
+ All priorities are included in the list (not only the ones that have changed state since the last update). This is done regardless of whether the status is send in respond to a status request, or due to a status subscription, and also regardless of whether a status subscription uses an update interval, or send-on-change, or both.
820
+ If you subscribe using an update interval, you’re not guaranteed to get all intermediate states. To guarantee that, send-on-change must be used when subscribing.
821
+ To understand how this status relates to ETSI/J2735, please see the [wiki](https://github.com/rsmp-nordic/rsmp_sxl_traffic_lights/wiki/Signal-priority-and-ETSI-J2735).
822
+ All priorities are send on every status update, regardless of whether an interval, or sendOnChange (or both) is used.
823
+ When a priority reaches an end states (completed, timeout, rejected, cooldown or stale), it must be sent once on the next status update, then removed from the list.
824
+ A request always starts in the ‘received’ state. The following table shows the possible state transitions:
825
+
826
+ State | Possible next states
827
+ ---------- | -------------------------------------
828
+ received | queued, activated, rejected, cooldown
829
+ queued | activated, timeout
830
+ activated | completed, stale
831
+ completed |
832
+ timeout |
833
+ rejected |
834
+ cooldown |
835
+ stale |
836
+ from_version: 1.1.0
837
+ arguments:
838
+ status:
839
+ description: JSON array of priority status items
840
+ type: array
841
+ items:
842
+ r:
843
+ type: string
844
+ description: ID of the priority request
845
+ t:
846
+ type: timestamp
847
+ description: Timestamp, indicating when the priority last changed state.
848
+ s:
849
+ type: string
850
+ description: |-
851
+ Current status of the priority request
852
+ values:
853
+ received: A new priority request was received but has not yet been processed
854
+ queued: The priority request has been queued for later activation
855
+ activated: The priority was activated
856
+ completed: The priority was cancelled as expected
857
+ timeout: The priority has been queued for too long
858
+ rejected: The priority request cannot be granted
859
+ cooldown: A similar priority request means the priority request cannot be activated now
860
+ stale: The priority has been active too long without cancellation, and was therefore removed
861
+ e:
862
+ type: integer_as_string
863
+ description: |-
864
+ Estimated green extension provided by the priority, in seconds
865
+ Only used when state is ‘completed’.
866
+ optional: true
867
+ min: 0
868
+ max: 255
869
+ d:
870
+ type: integer_as_string
871
+ description: |-
872
+ Estimated red reduction provided by the priority, in seconds
873
+ Only used when state is ‘completed’.
874
+ optional: true
875
+ min: 0
876
+ max: 255
877
+ S0034:
878
+ description: |-
879
+ Timeout for dynamic bands.
880
+ Time until a designated time plan is entered due to lost connection with the supervisor.
881
+ Disabled if set to '0'.
882
+ Used in conjunction with dynamic bands, M0014
883
+ from_version: 1.1.0
884
+ arguments:
885
+ status:
886
+ type: integer_as_string
887
+ description: Timeout, in minutes
888
+ min: 0
889
+ max: 65535
890
+ S0035:
891
+ description: |-
892
+ Emergency route.
893
+ The status is active during emergency prioritization.
894
+ Used in situations where full priority is given in the emergency vehicle program
895
+ or for other types of priority in some cases.
896
+
897
+ This status is similar to S0006, but supports multiple routes
898
+ from_version: 1.2.0
899
+ arguments:
900
+ emergencyroutes:
901
+ description: Active emergency routes
902
+ type: array
903
+ items:
904
+ id:
905
+ type: integer_as_string
906
+ description: ID of active emergency route
907
+ min: 1
908
+ max: 255
909
+ S0091:
910
+ description: |-
911
+ Operator logged in/out OP-panel.
912
+ Provides information if maintenance personnel is currently working on site.
913
+ from_version: 1.0.1
914
+ arguments:
915
+ user:
916
+ type: integer_as_string
917
+ values:
918
+ 0: Nobody logged in
919
+ 1: Operator logged in at level 1 (read only)
920
+ 2: Operator logged in at level 2 (read/write)
921
+ S0092:
922
+ description: |-
923
+ Operator logged in/out web-interface.
924
+ Provides information if maintenance personnel is currently working with the controller.
925
+ from_version: 1.0.1
926
+ arguments:
927
+ user:
928
+ type: integer_as_string
929
+ values:
930
+ 0: Nobody logged in
931
+ 1: Operator logged in at level 1 (read only)
932
+ 2: Operator logged in at level 2 (read/write)
933
+ S0095:
934
+ description: |-
935
+ Version of Traffic Light Controller.
936
+ Provides diagnostic version information.
937
+ from_version: 1.0.1
938
+ arguments:
939
+ status:
940
+ type: string
941
+ description: Manufacturer, product name and version of traffic light controller
942
+ S0096:
943
+ description: |-
944
+ Current date and time.
945
+ Note: UTC is used.
946
+ Provides diagnostic information about the current date and time set in the controller.
947
+ from_version: 1.0.1
948
+ arguments:
949
+ year:
950
+ type: integer_as_string
951
+ description: Year
952
+ min: 0
953
+ max: 9999
954
+ month:
955
+ type: integer_as_string
956
+ description: Month
957
+ min: 1
958
+ max: 12
959
+ day:
960
+ type: integer_as_string
961
+ description: Day of month
962
+ min: 1
963
+ max: 31
964
+ hour:
965
+ type: integer_as_string
966
+ description: Hour
967
+ min: 0
968
+ max: 23
969
+ minute:
970
+ type: integer_as_string
971
+ description: Minute
972
+ min: 0
973
+ max: 59
974
+ second:
975
+ type: integer_as_string
976
+ description: Second
977
+ min: 0
978
+ max: 59
979
+ S0097:
980
+ description: |-
981
+ Checksum of traffic parameters.
982
+ Can be used to check if any traffic parameter has been changed.
983
+ For instance, depending on controller, maintenance personnel can modify traffic parameters on site to optimize traffic flow. This status provides the ability to monitor if any traffic parameter has been changed. The traffic parameters may be downloaded with S0098.
984
+ from_version: 1.0.15
985
+ arguments:
986
+ checksum:
987
+ type: string
988
+ description: |-
989
+ Checksum of the traffic parameters
990
+ Uses SHA-2 as hashing algorithm
991
+ Includes
992
+ - all signal programs, including program versions
993
+ - signal group settings
994
+ - time plans
995
+ - safety matrix
996
+ - intergreen times
997
+ - detector settings
998
+
999
+ It should NOT include:
1000
+ - network settings
1001
+ - log files
1002
+ - software
1003
+ - other device settings that are not part of the signal program
1004
+
1005
+ Note:
1006
+ - The checksum should be calculated using the same data as used in S0098
1007
+ - Data Downloaded with S0098 and hashed with SHA-2 should match this value.
1008
+ timestamp:
1009
+ type: timestamp
1010
+ description: Time stamp of the checksum
1011
+ S0098:
1012
+ description: |-
1013
+ Configuration of traffic parameters.
1014
+ Can be used to download all traffic parameters from the controller.
1015
+ For instance, depending on controller, maintenance personnel can modify traffic parameters on site to optimize traffic flow. This status provides the ability to downloaded them.
1016
+ from_version: 1.0.15
1017
+ arguments:
1018
+ config:
1019
+ type: base64
1020
+ description: |-
1021
+ Traffic parameters.
1022
+ Includes
1023
+ - all signal programs, including program versions
1024
+ - signal group settings
1025
+ - time plans
1026
+ - safety matrix
1027
+ - intergreen times
1028
+ - detector setting
1029
+
1030
+ It should NOT include:
1031
+ - network settings
1032
+ - log files
1033
+ - software
1034
+ - other device settings that are not part of the signal program
1035
+
1036
+ Note:
1037
+ - There is no way to upload this binary file to the TLC using RSMP
1038
+ - The format of the binary file is not specified and is not expected to be compatible between suppliers
1039
+ timestamp:
1040
+ type: timestamp
1041
+ description: Time stamp of the config
1042
+ version:
1043
+ type: string_list_as_string
1044
+ description: |-
1045
+ Version information of the configuration. Contains basic information such as controller id, changes to config and other information.
1046
+ The format is not specified in detail.
1047
+ S0205:
1048
+ description: |-
1049
+ Traffic Counting: Number of vehicles.
1050
+ This status was introduced to improve performance in case traffic counting is done on all all detectors.
1051
+ Please see Section 4: "Traffic counting" for additional requirements.
1052
+ from_version: 1.0.14
1053
+ arguments:
1054
+ start:
1055
+ type: timestamp
1056
+ description: Time stamp for start of measuring
1057
+ vehicles:
1058
+ type: integer_list_as_string
1059
+ description: |-
1060
+ Number of vehicles.
1061
+ - Value expressed as an integer with a range of 0-65535.
1062
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1063
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1064
+ min: -1
1065
+ max: 65535
1066
+ S0206:
1067
+ description: |-
1068
+ Traffic Counting: Vehicle speed
1069
+ This status was introduced to improve performance in case traffic counting is done on all all detectors.
1070
+ Please see Section 4: "Traffic counting" for additional requirements.
1071
+ from_version: 1.0.14
1072
+ arguments:
1073
+ start:
1074
+ type: timestamp
1075
+ description: Time stamp for start of measuring
1076
+ speed:
1077
+ type: integer_list_as_string
1078
+ description: |-
1079
+ Average speed in km/h (integer).
1080
+ - Value expressed as an integer with a range of 0-65535.
1081
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1082
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1083
+ min: -1
1084
+ max: 65535
1085
+ S0207:
1086
+ description: |-
1087
+ Traffic Counting: Occupancy.
1088
+ This status was introduced to improve performance in case traffic counting is done on all all detectors.
1089
+ Please see Section 4: "Traffic counting" for additional requirements.
1090
+ from_version: 1.0.14
1091
+ arguments:
1092
+ start:
1093
+ type: timestamp
1094
+ description: Time stamp for start of measuring
1095
+ occupancy:
1096
+ type: integer_list_as_string
1097
+ description: |-
1098
+ Occupancy in percent (%) (0-100)
1099
+ - Value expressed as an integer with a range of 0-100.
1100
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1101
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1102
+ min: -1
1103
+ max: 100
1104
+ S0208:
1105
+ description: |-
1106
+ Traffic Counting: Number of vehicles of given classification.
1107
+ This status was introduced to improve performance in case traffic counting is done on all all detectors.
1108
+ Please see Section 4: "Traffic counting" for additional requirements.
1109
+ from_version: 1.0.14
1110
+ arguments:
1111
+ start:
1112
+ type: timestamp
1113
+ description: Time stamp for start of measuring
1114
+ P:
1115
+ type: integer_list_as_string
1116
+ description: |-
1117
+ Number of cars.
1118
+ - Value expressed as an integer with a range of 0-65535.
1119
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1120
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1121
+ min: -1
1122
+ max: 65535
1123
+ PS:
1124
+ type: integer_list_as_string
1125
+ description: |-
1126
+ Number of cars with trailers.
1127
+ - Value expressed as an integer with a range of 0-65535.
1128
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1129
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1130
+ min: -1
1131
+ max: 65535
1132
+ L:
1133
+ type: integer_list_as_string
1134
+ description: |-
1135
+ Number of trucks.
1136
+ - Value expressed as an integer with a range of 0-65535.
1137
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1138
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1139
+ min: -1
1140
+ max: 65535
1141
+ LS:
1142
+ type: integer_list_as_string
1143
+ description: |-
1144
+ Number of trucks with trailers.
1145
+ - Value expressed as an integer with a range of 0-65535.
1146
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1147
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1148
+ min: -1
1149
+ max: 65535
1150
+ B:
1151
+ type: integer_list_as_string
1152
+ description: |-
1153
+ Number of buses.
1154
+ - Value expressed as an integer with a range of 0-65535.
1155
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1156
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1157
+ min: -1
1158
+ max: 65535
1159
+ SP:
1160
+ type: integer_list_as_string
1161
+ description: |-
1162
+ Number of trams.
1163
+ - Value expressed as an integer with a range of 0-65535.
1164
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1165
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1166
+ min: -1
1167
+ max: 65535
1168
+ MC:
1169
+ type: integer_list_as_string
1170
+ description: |-
1171
+ Number of motor cycles.
1172
+ - Value expressed as an integer with a range of 0-65535.
1173
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1174
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1175
+ min: -1
1176
+ max: 65535
1177
+ C:
1178
+ type: integer_list_as_string
1179
+ description: |-
1180
+ Number of bicycles.
1181
+ - Value expressed as an integer with a range of 0-65535.
1182
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1183
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1184
+ min: -1
1185
+ max: 65535
1186
+ F:
1187
+ type: integer_list_as_string
1188
+ description: |-
1189
+ Number of pedestrians.
1190
+ - Value expressed as an integer with a range of 0-65535.
1191
+ - Contains data from all detector logics. Each detector logic is separated with a comma.
1192
+ - The value is set to “-1” if no data could be measured (e.g. detector fault)
1193
+ min: -1
1194
+ max: 65535
1195
+ commands:
1196
+ M0001:
1197
+ description: |-
1198
+ Sets functional position.
1199
+ Sets the controller to yellow flash, dark mode or normal control.
1200
+ Requires security code 2.
1201
+ from_version: 1.0.1
1202
+ arguments:
1203
+ status:
1204
+ type: string
1205
+ description: Set operating mode
1206
+ values:
1207
+ NormalControl: Normal Control
1208
+ YellowFlash: Enables yellow flash
1209
+ Dark: Enables dark mode
1210
+ securityCode:
1211
+ type: string
1212
+ description: Security code 2
1213
+ timeout:
1214
+ optional: true
1215
+ type: integer_as_string
1216
+ description: |-
1217
+ Time in minutes until controller automatically reverts to previous functional position.
1218
+ 0=no automatic return
1219
+ min: 0
1220
+ max: 1440
1221
+ intersection:
1222
+ optional: true
1223
+ type: integer_as_string
1224
+ description: |-
1225
+ Intersection number.
1226
+ Command only applies to specified intersection. Other intersections remains in their respective operating mode(s).
1227
+ 0: All intersections
1228
+ min: 0
1229
+ max: 255
1230
+ command: setValue
1231
+ M0002:
1232
+ description: |-
1233
+ Sets current time plan.
1234
+ Change of traffic program of the traffic light controller.
1235
+ Typical usages is scenario based control where change of program is used to change signal timings etc.
1236
+ This command changes the signal timings for optimal traffic flow.
1237
+ Requires security code 2
1238
+ from_version: 1.0.1
1239
+ arguments:
1240
+ status:
1241
+ type: boolean_as_string
1242
+ description: |-
1243
+ False: Controller uses time plan according to programming
1244
+ True: Controller uses time plan according to command
1245
+ securityCode:
1246
+ type: string
1247
+ description: Security code 2
1248
+ timeplan:
1249
+ type: integer_as_string
1250
+ description: designation of time plan
1251
+ min: 1
1252
+ max: 255
1253
+ command: setPlan
1254
+ M0003:
1255
+ description: |-
1256
+ Sets traffic situation the controller uses.
1257
+ Used for area-based control where this command can be sent to a master traffic light controller about which predefined traffic situation to use (1-255).
1258
+ Traffic situation is a concept used to divide multiple TLC's into areas and sub-areas. The traffic situation gives the possibility to change the TLC sub-area dynamically depending on the time of day and the traffic flow. Depending on the traffic situation each TLC selects the time plan dynamically.
1259
+ Requires security code 2
1260
+ from_version: 1.0.1
1261
+ arguments:
1262
+ status:
1263
+ type: boolean_as_string
1264
+ description: |-
1265
+ False: Controller uses traffic situation according to own programming
1266
+ True: Controller uses traffic situation according to command
1267
+ securityCode:
1268
+ type: string
1269
+ description: Security code 2
1270
+ traficsituation:
1271
+ type: integer_as_string
1272
+ description: designation of traficsituation
1273
+ min: 1
1274
+ max: 255
1275
+ command: setTrafficSituation
1276
+ M0004:
1277
+ description: |-
1278
+ Reset Traffic Light Controller.
1279
+
1280
+ This command is used as a last resort to attempt to remotely fix serious faults.
1281
+ If unsuccessful, manual intervention on site is probably required.
1282
+
1283
+ The controller must attempt all available safe action to reset to a functional state.
1284
+ Depending on regulations and controller capabilities, examples actions could be:
1285
+
1286
+ - resetting parameters to defaults
1287
+ - restarting applications
1288
+ - restarting peripheral hardware
1289
+ - going through a shutdown/startup sequence and cycling power
1290
+
1291
+ The controller must also clear all alarms.
1292
+
1293
+ Requires security code 2.
1294
+ The attribute 'status' is deprecated and must be set to true.
1295
+ from_version: 1.0.1
1296
+ arguments:
1297
+ status:
1298
+ type: boolean_as_string
1299
+ description: 'True: Reset controller'
1300
+ securityCode:
1301
+ type: string
1302
+ description: Security code 2
1303
+ command: setRestart
1304
+ M0005:
1305
+ description: |-
1306
+ Activate emergency route.
1307
+ The function is made for emergency prioritization. Works in the same way as the M0006 and M0008 where the traffic light controller responds to an input.
1308
+ Should be used in situations where full priority is given in the emergency vehicle program.
1309
+ Requires security code 2.
1310
+ from_version: 1.0.1
1311
+ arguments:
1312
+ status:
1313
+ type: boolean_as_string
1314
+ description: |-
1315
+ False: Deactivate emergency route
1316
+ True: Activate emergency route
1317
+ securityCode:
1318
+ type: string
1319
+ description: Security code 2
1320
+ emergencyroute:
1321
+ type: integer_as_string
1322
+ description: Number of emergency route
1323
+ min: 1
1324
+ max: 255
1325
+ command: setEmergency
1326
+ M0006:
1327
+ description: |-
1328
+ Activate input.
1329
+ Set given input (1-255) of the controllers general purpose I/O to either true or false.
1330
+ The function can provide an input to the traffic light controller on which a predefined action can be taken.
1331
+ Can be used for all types of input where the traffic light controller must react to external control.
1332
+ Typical usages are bus priority, coordination between traffic controllers, external control systems, and much more.
1333
+ Requires security code 2.
1334
+ from_version: 1.0.1
1335
+ arguments:
1336
+ status:
1337
+ type: boolean_as_string
1338
+ description: |-
1339
+ False: Deactivate input
1340
+ True: Activate input
1341
+ securityCode:
1342
+ type: string
1343
+ description: Security code 2
1344
+ input:
1345
+ type: integer_as_string
1346
+ description: Number of Input
1347
+ min: 1
1348
+ max: 255
1349
+ command: setInput
1350
+ M0007:
1351
+ description: |-
1352
+ Activate fixed time control.
1353
+ Deactivates the traffic actuated control using detectors and activates pre-timed control.
1354
+ Can be used in case normal detectors can't be used, e.g. during maintenance work.
1355
+ Requires security code 2.
1356
+ from_version: 1.0.2
1357
+ arguments:
1358
+ status:
1359
+ type: boolean_as_string
1360
+ description: |-
1361
+ False: Deactivate fixed time control
1362
+ True: Activate fixed time control
1363
+ securityCode:
1364
+ type: string
1365
+ description: Security code 2
1366
+ command: setFixedTime
1367
+ M0012:
1368
+ description: |-
1369
+ Request start or stop of a series of signal groups.
1370
+ Starts or stops several signal groups.
1371
+ This command was introduced due to coordination requirements needing to set many signal groups to green and red at the same time and M0010 and M0012 being to slow to send a message for each signal group individually.
1372
+ Although this command is intended to be used with coordination it is not actually specified to be used for this yet. It is reserved in the SXL for possible future use.
1373
+ Intended for use with coordination of signaling systems where a traffic light controller communicates with neighboring controllers.
1374
+ Only used when a primary controller orders signal group of other controller to green or red (Coordination with external control bits).
1375
+ May also include purposes for adaptive control where a UTC system or a local traffic light controller takes over the phase control (stage control).
1376
+ Requires security code 2.
1377
+ from_version: 1.0.8
1378
+ reserved: true
1379
+ arguments:
1380
+ status:
1381
+ type: string_list_as_string
1382
+ description: |-
1383
+ Orders signal groups to green or red. Sets a block of 16 signal groups at a time. Can be repeated to set several blocks of 16 signal groups. Values are separated with comma. Blocks are separated with semicolon. Since semicolon breaks the SXL csv-format, colon is used in example below.
1384
+
1385
+ 1=Order signal group to green
1386
+ 0=Order signal group to red
1387
+
1388
+ Format: [Offset],[Bits to set],[Bits to unset]:…
1389
+
1390
+ Offset sets where the 16 inputs starts from followed by two 16 bit values telling which bit to set and unset in binary format, i.e. first bit have value 1 and last bit have value 32768.
1391
+
1392
+ Example 1:
1393
+ "5, 4134, 65" sets input 6,7,10,17 = on and 5,11 = off
1394
+ (Input starts from no. 5 and bit 1,2,5,12 = 1 and bit 0,6 = 0)
1395
+
1396
+ Example 2:
1397
+ "22, 1, 4" sets input 22 = on and 24 = off
1398
+ (Input starts from no. 22 and bit 0 = 1 and bit 2 = 0)
1399
+
1400
+ And both these examples could be sent in the same message as:
1401
+ "5,4143,65:22,1,4"
1402
+
1403
+ Such a message would order signal group 6,7,10,17,22 to green and signal group 5,11,24 to red
1404
+ securityCode:
1405
+ type: string
1406
+ description: Security code 2
1407
+ command: setStart
1408
+ M0013:
1409
+ description: |-
1410
+ Activate a series of inputs
1411
+
1412
+ Set given inputs (1-255) of the controllers general purpose I/O to either true or false. This command was introduced due to coordination requirements needing to set many inputs to true/false at the same time and M0006 being to slow to send a message for each input individually. With this command many inputs can be set to true/false at the same time using a single command message. It can be used for all types of input where the traffic light controller must react to external control. Typical usages are bus priority, coordination between traffic controllers, external control systems, and much more.
1413
+
1414
+ Requires security code 2.
1415
+
1416
+ The parameter ‘status’ sets/unsets a block of 16 inputs at a time. It can be repeated to set several blocks of 16 inputs. Values are separated with comma. Blocks are separated with semicolon. Format: [Offset];[Bits to set];[Bits to unset];…
1417
+
1418
+ - ‘Offset’ defines where the 16 inputs starts from
1419
+ - ‘Bits to set’ defines which bit(s) to set. ‘0’ if unused
1420
+ - ‘Bits to unset’ defines which bit(s) to unset. ‘0’ if unused
1421
+
1422
+ Example 1:
1423
+ “3,4134,65” sets input 4,5,8,15 and unsets 3,9
1424
+ - Input starts from no. 5
1425
+ - “4134” is 1 0000 0010 0110 in binary, but since input starts from 3, it is shifted 3 bits, e.g. 1000 0001 0011 0000 which are bits 4,5,8,15
1426
+ - “65” is 100 0001 in binary, but since input starts from 3, it is shifted 3 bits, e.g. 10 0000 1000 which are bits 3,9
1427
+
1428
+ Example 2:
1429
+ “12,1,4” sets input 12 and unsets 14
1430
+ - Input starts from no. 12
1431
+ - “1” is 1 in binary, but since input starts at 12 it is shifted 12 bits, e.g. 1 0000 0000 0000, which is bit 12
1432
+ - “4” is 100 in binary, but since input starts at 12 it is shifted 12 bits, e.g. 100 0000 0000 0000, which is bit 14
1433
+
1434
+ And both these examples could be sent in the same message as: “3,4143,65;12,1,4”
1435
+
1436
+ Such a message would set input 4,5,8,12,15 and unset input 3,9,14
1437
+
1438
+ Example 3:
1439
+ “0,1,2” sets input 0 and unsets 1
1440
+ - Input starts from 0
1441
+ - “1” is 1 in binary, which is bit 0
1442
+ - “2” is 10 in binary, which is bit 1
1443
+ from_version: 1.0.8
1444
+ arguments:
1445
+ status:
1446
+ type: string_list_as_string
1447
+ description: |-
1448
+ Sets/Unsets a block of 16 inputs at a time. Can be repeated to set several blocks of 16 inputs. Values are separated with comma. Blocks are separated with semicolon.
1449
+ Format: [Offset];[Bits to set];[Bits to unset];…
1450
+ securityCode:
1451
+ type: string
1452
+ description: Security code 2
1453
+ command: setInput
1454
+ M0014:
1455
+ description: |-
1456
+ Set dynamic bands.
1457
+ Can be used to change between predefined signal timings. Moves the start of signal groups in the cycle.
1458
+ This command can be used to change the split of green time during the cycle. A typical usage is scenario based control where changing of signal timings is used for optimal traffic flow.
1459
+ Requires security code 2
1460
+ from_version: 1.0.13
1461
+ arguments:
1462
+ plan:
1463
+ type: integer_as_string
1464
+ description: Plan to be changed
1465
+ min: 0
1466
+ max: 255
1467
+ status:
1468
+ type: string_list_as_string
1469
+ description: |-
1470
+ Dynamic bands.
1471
+ Each dynamic band are written as dd-ee where:
1472
+ dd=Dynamic band number (from 1-10)
1473
+ ee=Extension in seconds in this band
1474
+
1475
+ Each dynamic band is separated with a comma.
1476
+
1477
+ E.g.
1478
+ dd-ee,dd-ee
1479
+ securityCode:
1480
+ type: string
1481
+ description: Security code 2
1482
+ command: setCommands
1483
+ M0015:
1484
+ description: |-
1485
+ Set Offset time.
1486
+ Offset time is used to define an offset between intersections in coordinated control. It is based on the expected travel time between intersections.
1487
+ This command can be used to fine tune the coordination for optimal traffic flow.
1488
+ Requires security code 2.
1489
+ from_version: 1.0.13
1490
+ arguments:
1491
+ status:
1492
+ type: integer_as_string
1493
+ description: Set offset time in seconds
1494
+ min: 0
1495
+ max: 255
1496
+ plan:
1497
+ type: integer_as_string
1498
+ description: Time plan nr
1499
+ min: 0
1500
+ max: 255
1501
+ securityCode:
1502
+ type: string
1503
+ description: Security code 2
1504
+ command: setOffset
1505
+ M0016:
1506
+ description: |-
1507
+ Set week time table.
1508
+ Set which time table for signal programs to use for each day during a week.
1509
+ This command changes the signal timings during the week for optimal traffic flow.
1510
+ Requires security code 2.
1511
+ from_version: 1.0.13
1512
+ arguments:
1513
+ status:
1514
+ type: string_list_as_string
1515
+ description: |-
1516
+ Week time table. Defines time table to use for each week day
1517
+ Each segment is written as d-t where:
1518
+ d=day of week
1519
+ t=time table nr
1520
+
1521
+ Day of week legend:
1522
+ 0=Monday
1523
+ 1=Tuesday
1524
+ 2=Wednesday
1525
+ 3=Thursday
1526
+ 4=Friday
1527
+ 5=Saturday
1528
+ 6=Sunday
1529
+
1530
+ Each segment is separated with a comma
1531
+ E.g.
1532
+ d-t,d-t
1533
+ securityCode:
1534
+ type: string
1535
+ description: Security code 2
1536
+ command: setWeekTable
1537
+ M0017:
1538
+ description: |-
1539
+ Set time tables.
1540
+ Set time of day for when to automatically switch signal program (time plan).
1541
+ This command changes the signal timings according to time of day for optimal traffic flow.
1542
+ Requires security code 2.
1543
+ from_version: 1.0.13
1544
+ arguments:
1545
+ status:
1546
+ type: string_list_as_string
1547
+ description: |-
1548
+ Time Table. Defines time tables.
1549
+ Each time definition is written as t-o-h-m where:
1550
+ t=time table nr (1-12)
1551
+ o=function
1552
+ h=hour - switching time
1553
+ m=minute - switching minute
1554
+
1555
+ Function legend:
1556
+ 0=no plan is selected by time table
1557
+ 1=set plan 1
1558
+
1559
+ 16= set plan 16
1560
+
1561
+ hour and minute is using local time (not UTC)
1562
+
1563
+ Each time definition is separated with a comma.
1564
+
1565
+ E.g.
1566
+ t-o-h-m,t-o-h-m
1567
+ securityCode:
1568
+ type: string
1569
+ description: Security code 2
1570
+ command: setTimeTable
1571
+ M0018:
1572
+ description: |-
1573
+ Set Cycle time.
1574
+ Cycle time (or cycle length) is the sum of all phases in a time plan (traffic program). This time is fixed when using fixed time control or coordination (except "local coordination"). When the cycle counter reaches this length it is reset back to zero.
1575
+ This command provides the ability to change the cycle time when using coordinated or fixed time control. It changes the timings for optimal traffic flow. Can be used with scenario based control.
1576
+ Requires security code 2.
1577
+ from_version: 1.0.13
1578
+ arguments:
1579
+ status:
1580
+ type: integer_as_string
1581
+ description: Set cycle time in seconds
1582
+ min: 1
1583
+ max: 255
1584
+ plan:
1585
+ type: integer_as_string
1586
+ description: Time plan nr
1587
+ min: 0
1588
+ max: 255
1589
+ securityCode:
1590
+ type: string
1591
+ description: Security code 2
1592
+ command: setCycleTime
1593
+ M0019:
1594
+ description: |-
1595
+ Force input.
1596
+ Force a given input (1-255) of the controllers general purpose I/O to either True or False. Can be used for all types of input where the traffic light controller must react to external control.
1597
+ Can be used for bus priority, coordination between traffic controllers, external control systems, and much more.
1598
+ Requires security code 2.
1599
+ from_version: 1.0.13
1600
+ arguments:
1601
+ status:
1602
+ type: boolean_as_string
1603
+ description: |-
1604
+ False: Release input
1605
+ True: Force input
1606
+ securityCode:
1607
+ type: string
1608
+ description: Security code 2
1609
+ input:
1610
+ type: integer_as_string
1611
+ description: Number of Input
1612
+ min: 1
1613
+ max: 255
1614
+ inputValue:
1615
+ type: boolean_as_string
1616
+ description: |-
1617
+ False: input forced to False
1618
+ True: input forced to True
1619
+ command: setInput
1620
+ M0020:
1621
+ description: |-
1622
+ Force output.
1623
+ Force a given output (1-255) of the controllers general purpose I/O to either True of False. Can be used for all types of output where the traffic light controller needs to control other equipment.
1624
+ Can be used for bus priority, coordination between traffic controllers, external control systems, and much more.
1625
+ When the output is released (status=False), the outputValue is ignored.
1626
+ Requires security code 2.
1627
+ from_version: 1.0.15
1628
+ arguments:
1629
+ status:
1630
+ type: boolean_as_string
1631
+ description: |-
1632
+ True: Force output
1633
+ False: Release output
1634
+ securityCode:
1635
+ type: string
1636
+ description: Security code 2
1637
+ output:
1638
+ type: integer_as_string
1639
+ description: Number of Output
1640
+ min: 1
1641
+ max: 255
1642
+ outputValue:
1643
+ type: boolean_as_string
1644
+ description: |-
1645
+ False: output forced off
1646
+ True: output forced on
1647
+ command: setOutput
1648
+ M0021:
1649
+ description: |-
1650
+ Set trigger level sensitivity for loop detector.
1651
+ The trigger level sensitivity determines at what level a loop detector should trigger. If it set too low then then traffic will not be detected as intended. If it is set too high the detector might give false positives.
1652
+ This command provides the ability to fine tune loop detectors to make sure they detect traffic as intended.
1653
+ Requires security code 2
1654
+ from_version: 1.0.15
1655
+ arguments:
1656
+ status:
1657
+ type: string_list_as_string
1658
+ description: |-
1659
+ Loop detector trigger level sensitivity is written as dd-ss where:
1660
+ dd=loop detector number
1661
+ ss=sensitivity value
1662
+ securityCode:
1663
+ type: string
1664
+ description: Security code 2
1665
+ command: setLevel
1666
+ M0022:
1667
+ description: |-
1668
+ Request Signal Priority
1669
+
1670
+ Useful for bus priority or other type of priorities like emergency vehicles or groups of cyclists.
1671
+
1672
+ The benefit of using this message over activating inputs or detector logics is that you can specify a priority level, vehicle type and estimated time of arrival. You can also update or cancel the request, and use the corresponding status message to track the status of the request, including how much priority was actually given.
1673
+
1674
+ To understand how this command relates to ETSI/J2735, please see the [wiki](https://github.com/rsmp-nordic/rsmp_sxl_traffic_lights/wiki/Signal-priority-and-ETSI-J2735).
1675
+
1676
+ Activating signal priority is expected to provide more green time for a particular movement through the intersection, but the exact mechanism must typically be configured in the controller.
1677
+
1678
+ The movement to prioritize can be referenced in a number of ways, depending on what is configured in the controller, and in the system that sends priority requests. Either:
1679
+
1680
+ - Reference a signal group by setting ‘signalGroupId’. This method is simple, but will not allow you to have different priority mechanism for the same signal group, unless they can be distinguished by the vehicle type. For example, if you need to trigger different priorities depending on whether a bus goes straight or makes a turn for the same signal group, you need to use of the other referencing methods.
1681
+ - Reference an input by setting ‘inputId’. This can be useful if you previously used inputs to activate priority. The input will not be activated, only the priority.
1682
+ - Reference a connection by setting ‘connectionId’. A connection is a movement from a specific ingoing lane to a specific outgoing lane.
1683
+ - Reference an intersection approach by setting ‘approachId’.
1684
+ - Reference an ingoing lane by setting ‘laneInId’, and optionally also reference an outgoing lane by setting ‘laneOutId’.
1685
+
1686
+ Referencing attributes that are not used must be left out, rather than set to null or empty strings. This includes:
1687
+
1688
+ - signalGroupId
1689
+ - inputId
1690
+ - connectionId
1691
+ - approachId
1692
+ - laneInId
1693
+ - laneOutId
1694
+
1695
+ Referencing attributes are only used when initiating a request. When updating or cancelling the request, the request is identified by its requestId, and no referencing attributes are allowed.
1696
+
1697
+ You initiate a priority request with type set to ‘new’. You must provide a request id that uniquely identifies the request on the controller. It can be a randomly generated UUID (universally unique identifier), or it can be constructed by combining e.g. a vehicle id and some other identifier. When updating or cancelling a request, you must pass the same request id again.
1698
+
1699
+ Providing ETA (estimated time of arrival) when initiating a request is optional, but can help the controller plan ahead in cases where you’re able to send the request before the vehicle arrives at the intersection. You’re allowed to initiate the request without an ETA and provide it in a later request update. But providing the ETA when initiating the request is recommended, since it will give the controller more time to plan ahead.
1700
+
1701
+ Like ETA, providing a vehicle type is optional, but can help the controller decide how to best handle the request.
1702
+
1703
+ The priority level provides a way to indicate the relative importance of the request compared to other requests. For example, emergency vehicles or delayed buses could be given a higher priority level.
1704
+
1705
+ If the ETA changes before the priority is cancelled, or you want to change the priority level, you can send another request message with type set to ‘update’. The vehicle type cannot be changed.
1706
+
1707
+ When you send a priority request, it will be processed to decide if it’s possible to activate the requested priority.
1708
+
1709
+ If the request is accepted, the priority can either be activated immediately, or if another priority is currently active, it can be queued for later activation.
1710
+
1711
+ If the priority cannot be accepted the request is rejected. Cooldown is a specific type of rejection, which means that s similar request has just completed, and some time needs to pass before a similar request can be activated.
1712
+
1713
+ When a request is queued, it is expected to become activated later, but in case too long passes without activation, the controller is expected to time out the request.
1714
+
1715
+ Once a priority is activated, you’re excepted to cancel it as soon as there’s no need for it anymore, typically when the vehicle has passed the intersection. You cancel a request by sending a request passing the existing request id setting the type to ‘cancel’.
1716
+
1717
+ If a request is never cancelled, the controller is expected to remove the priority at some point, but until then the priority might block requests in other direction which is why you should always cancel a priority when it’s not needed anymore.
1718
+ from_version: 1.1.0
1719
+ arguments:
1720
+ requestId:
1721
+ type: string
1722
+ description: A string that uniquely identifies the request on the controller
1723
+ signalGroupId:
1724
+ type: string
1725
+ optional: true
1726
+ description: ID of a signal group component.
1727
+ inputId:
1728
+ type: integer_as_string
1729
+ optional: true
1730
+ description: ID of an input, using the same numbering scheme as M0006
1731
+ min: 0
1732
+ max: 255
1733
+ connectionId:
1734
+ type: integer_as_string
1735
+ optional: true
1736
+ description: ID of a connection, connecting an ingoing and an outgoing lane
1737
+ min: 0
1738
+ max: 255
1739
+ approachId:
1740
+ type: integer_as_string
1741
+ optional: true
1742
+ description: ID of an intersection approach
1743
+ min: 0
1744
+ max: 16
1745
+ laneInId:
1746
+ type: integer_as_string
1747
+ optional: true
1748
+ description: ID of an ingoing lane
1749
+ min: 0
1750
+ max: 255
1751
+ laneOutId:
1752
+ type: integer_as_string
1753
+ optional: true
1754
+ description: ID of an outgoing lane
1755
+ min: 0
1756
+ max: 255
1757
+ priorityId:
1758
+ type: integer_as_string
1759
+ optional: true
1760
+ description: ID of a priority
1761
+ min: 0
1762
+ max: 255
1763
+ type:
1764
+ type: string
1765
+ values:
1766
+ new: New priority request
1767
+ update: Update to existing priority request
1768
+ cancel: Cancel an existing priority
1769
+ level:
1770
+ type: integer_as_string
1771
+ description: |-
1772
+ 0: Lowest, 14: Highest
1773
+ min: 0
1774
+ max: 14
1775
+ eta:
1776
+ type: integer_as_string
1777
+ optional: true
1778
+ description: Estimated time of arrival to the intersection, in seconds
1779
+ min: 0
1780
+ max: 255
1781
+ vehicleType:
1782
+ type: string
1783
+ optional: true
1784
+ description: Vehicle type
1785
+ values:
1786
+ pedestrian: Pedestrians
1787
+ bicycle: Bicycles
1788
+ motorcycle: Motorcycles
1789
+ car: Passenger vehicle
1790
+ bus: Bus used for public transport
1791
+ lightTruck: Light truck
1792
+ heavyTruck: Heavy truck
1793
+ tram: Trams used for Public transport
1794
+ emergency: Police, fire or ambulance
1795
+ safetyCar: For e.g. escort vehicles
1796
+ specialTransport: For e.g. heavy load
1797
+ other: Other type of vehicle
1798
+ command: requestPriority
1799
+ M0023:
1800
+ description: |-
1801
+ Set timeout for dynamic bands
1802
+ Switch to a designated time plan if this timeout is reached due to lost connection with the supervisor.
1803
+ Disable by setting timeout to '0'.
1804
+ Used in conjunction with dynamic bands, M0014
1805
+ Requires security code 2.
1806
+ from_version: 1.1.0
1807
+ arguments:
1808
+ status:
1809
+ type: integer_as_string
1810
+ min: 0
1811
+ max: 65535
1812
+ description: Timeout, in minutes
1813
+ securityCode:
1814
+ type: string
1815
+ description: Security code 2
1816
+ command: setTimeout
1817
+ M0024:
1818
+ description: |-
1819
+ Clear all alarms.
1820
+ Clear all active alarms in the traffic light controller.
1821
+ If the cause of an alarm is still present, the alarm will be reactivated again.
1822
+ from_version: 1.3.0
1823
+ command: clearAlarms
1824
+ arguments:
1825
+ status:
1826
+ type: boolean
1827
+ description: 'True: Clear all alarms'
1828
+ M0103:
1829
+ description: |-
1830
+ Set security code.
1831
+ Change the security code to use when sending commands
1832
+ Security codes are used as an extra layer of security in many commands. They need to match between the supervision system and the traffic light controller in order for the commands to be executed.
1833
+ from_version: 1.0.1
1834
+ arguments:
1835
+ status:
1836
+ type: string
1837
+ values:
1838
+ Level1: Change security code 1
1839
+ Level2: Change security code 2
1840
+ oldSecurityCode:
1841
+ type: string
1842
+ description: Previous security code
1843
+ newSecurityCode:
1844
+ type: string
1845
+ description: New security code
1846
+ command: setSecurityCode
1847
+ M0104:
1848
+ deprecated: true
1849
+ description: |-
1850
+ Set clock.
1851
+ This command will be removed in an upcoming version.
1852
+ You should instead use automatic time synchronization using e.g. using NTP or GPS.
1853
+
1854
+ Can be used to manually set the clock of the traffic light controller in case
1855
+ automatic time synchronization is not available, e.g. during maintenance work.
1856
+
1857
+ If automatic time synchronization is active, the
1858
+ command returns a normal response, but is otherwise ignored and does not set
1859
+ the clock.
1860
+
1861
+ UTC is used. Requires security code 1.
1862
+ from_version: 1.0.1
1863
+ arguments:
1864
+ securityCode:
1865
+ type: string
1866
+ description: Security code 1
1867
+ year:
1868
+ type: integer_as_string
1869
+ description: Year
1870
+ min: 0
1871
+ max: 9999
1872
+ month:
1873
+ type: integer_as_string
1874
+ description: Month
1875
+ min: 1
1876
+ max: 12
1877
+ day:
1878
+ type: integer_as_string
1879
+ description: Day of month
1880
+ min: 1
1881
+ max: 31
1882
+ hour:
1883
+ type: integer_as_string
1884
+ description: Hour
1885
+ min: 0
1886
+ max: 23
1887
+ minute:
1888
+ type: integer_as_string
1889
+ description: Minute
1890
+ min: 0
1891
+ max: 59
1892
+ second:
1893
+ type: integer_as_string
1894
+ description: Second
1895
+ min: 0
1896
+ max: 59
1897
+ command: setDate
1898
+ Signal group:
1899
+ description:
1900
+ alarms:
1901
+ A0008:
1902
+ description: |-
1903
+ Dead lock error.
1904
+ Used for dead lock errors.
1905
+ For instance; a signal group has requested green but is unable to switch due to a conflicting signal group for an extended period of time. At some point the request times out and the controller goes into failure mode. The cause for this error is due to configuration errors or external sources.
1906
+ Is a "major fault" defined according to 3.8 in EN12675 which causes the controller to switch to a "failure mode" according to 3.6 in EN12675.
1907
+ priority: 2
1908
+ category: D
1909
+ from_version: 1.0.1
1910
+ arguments:
1911
+ timeplan:
1912
+ type: integer_as_string
1913
+ description: Current time plan
1914
+ min: 1
1915
+ max: 255
1916
+ A0101:
1917
+ description: |-
1918
+ Pushbutton error.
1919
+ Used for push buttons.
1920
+ priority: 3
1921
+ category: D
1922
+ from_version: 1.0.0
1923
+ A0201:
1924
+ description: |-
1925
+ Serious lamp error.
1926
+ Used for lamp errors.
1927
+ Is a "major fault" defined according to 3.8 in EN12675 which causes the controller to switch to a "failure mode" according to 3.6 in EN12675.
1928
+ priority: 2
1929
+ category: D
1930
+ from_version: 1.0.0
1931
+ arguments:
1932
+ color:
1933
+ type: string
1934
+ description: Color of lamp
1935
+ values:
1936
+ red: red
1937
+ yellow: yellow
1938
+ green: green
1939
+ A0202:
1940
+ description: |-
1941
+ Less serious lamp error.
1942
+ Used for lamp errors.
1943
+ Is a "minor fault" defined according to 3.11 in EN12675.
1944
+ priority: 3
1945
+ category: D
1946
+ from_version: 1.0.0
1947
+ arguments:
1948
+ color:
1949
+ type: string
1950
+ description: Color of lamp
1951
+ values:
1952
+ red: red
1953
+ yellow: yellow
1954
+ green: green
1955
+ statuses:
1956
+ S0025:
1957
+ description: |-
1958
+ Time-of-Green / Time-of-Red.
1959
+ Provides predicted signal timings of green and red for each signal group. Max, min and likely time to green and red.
1960
+ from_version: 1.0.13
1961
+ arguments:
1962
+ minToGEstimate:
1963
+ type: timestamp
1964
+ description: |-
1965
+ Time stamp for the minimum time for the signal group to go to green. If the signal group is green, it is the minimum time for the next green.
1966
+ maxToGEstimate:
1967
+ type: timestamp
1968
+ description: |-
1969
+ Time stamp for the maximum time for the signal group to go to green. If the signal group is green, it is the maximum time for the next green.
1970
+ likelyToGEstimate:
1971
+ type: timestamp
1972
+ description: |-
1973
+ Time stamp for the most likely time for the signal group to go to green. If the signal group is green, it is the most likely time for the next green.
1974
+ ToGConfidence:
1975
+ type: integer_as_string
1976
+ description: Confidence of the likelyToGEstimate. 0-100%
1977
+ min: 0
1978
+ max: 100
1979
+ minToREstimate:
1980
+ type: timestamp
1981
+ description: |-
1982
+ Time stamp for the minimum time for the signal group to go to red. If the signal group is red, it is the minimum time for the next red.
1983
+ maxToREstimate:
1984
+ type: timestamp
1985
+ description: |-
1986
+ Time stamp for the maximum time for the signal group to go to red. If the signal group is red, it is the maximum time for the next red.
1987
+ likelyToREstimate:
1988
+ type: timestamp
1989
+ description: |-
1990
+ Time stamp for the most likely time for the signal group to go to red. If the signal group is red, it is the most likely time for the next red.
1991
+ ToRConfidence:
1992
+ type: integer_as_string
1993
+ description: Confidence of the likelyToREstimate. 0-100%
1994
+ min: 0
1995
+ max: 100
1996
+ commands:
1997
+ M0010:
1998
+ description: |-
1999
+ Start of signal group. Orders a signal group to green.
2000
+ Although this command is intended to be used with coordination it is not actually specified to be used for this yet. It is reserved in the SXL for possible future use.
2001
+ Intended for use with coordination of signaling systems where a traffic light controller communicates with neighboring controllers. Only used when a primary controller orders signal group of other controller to green or red (Coordination with external control bits).
2002
+ Requires security code 2
2003
+ from_version: 1.0.8
2004
+ reserved: true
2005
+ arguments:
2006
+ status:
2007
+ type: boolean_as_string
2008
+ description: |-
2009
+ False: No command (default)
2010
+ True: Order a signal group to green
2011
+ securityCode:
2012
+ type: string
2013
+ description: Security code 2
2014
+ command: setStart
2015
+ M0011:
2016
+ description: |-
2017
+ Stop of signal group. Orders a signal group to red.
2018
+ Although this command is intended to be used with coordination it is not actually specified to be used for this yet. It is reserved in the SXL for possible future use.
2019
+ Intended for use with coordination of signaling systems where a traffic light controller communicates with neighboring controllers. Only used when a primary controller orders signal group of other controller to green or red (Coordination with external control bits).
2020
+ Requires security code 2
2021
+ from_version: 1.0.8
2022
+ reserved: true
2023
+ arguments:
2024
+ status:
2025
+ type: boolean_as_string
2026
+ description: |-
2027
+ False: No command (default)
2028
+ True: Order a signal group to red
2029
+ securityCode:
2030
+ type: string
2031
+ description: Security code 2
2032
+ command: setStop
2033
+ Detector logic:
2034
+ description:
2035
+ alarms:
2036
+ A0301:
2037
+ description: |-
2038
+ Detector error (hardware).
2039
+ Is a "minor fault" defined according to 3.11 in EN12675.
2040
+ priority: 3
2041
+ category: D
2042
+ from_version: 1.0.2
2043
+ arguments:
2044
+ detector:
2045
+ type: string
2046
+ description: Designation of the detector (hardware)
2047
+ type:
2048
+ type: string
2049
+ description: Type of detector
2050
+ values:
2051
+ loop: Inductive detector loop
2052
+ input: External input
2053
+ errormode:
2054
+ type: string
2055
+ description: Detector forced on/off while detector error
2056
+ values: ['on','off'] # on/off must be quoted, otherwise they are converted to true/false
2057
+ manual:
2058
+ type: boolean_as_string
2059
+ description: Manually controlled detector logic (True/False)
2060
+ A0302:
2061
+ description: |-
2062
+ Detector error (logic error).
2063
+ For instance; detector continuously on or off during an extended time.
2064
+ Is a "minor fault" defined according to 3.11 in EN12675.
2065
+ priority: 3
2066
+ category: D
2067
+ from_version: 1.0.2
2068
+ arguments:
2069
+ detector:
2070
+ type: string
2071
+ description: Designation of the detector (hardware)
2072
+ type:
2073
+ type: string
2074
+ description: Type of detector.
2075
+ values:
2076
+ loop: Inductive detector loop
2077
+ input: External input
2078
+ errormode:
2079
+ type: string
2080
+ description: Detector forced on/off while detector error
2081
+ values: ['on','off'] # on/off must be quoted, otherwise they are converted to true/false
2082
+ manual:
2083
+ type: boolean_as_string
2084
+ description: Manually controlled detector logic (True/False)
2085
+ logicerror:
2086
+ type: string
2087
+ description: Type of logic error
2088
+ values:
2089
+ always_off: no detection during predefined max time
2090
+ always_on: detection constantly on during predefined max time
2091
+ intermittent: intermittent logic fault (flutter)
2092
+ A0303:
2093
+ description: |-
2094
+ Serious detector error (hardware).
2095
+ Is a “major fault” defined according to 3.8 i EN12675 which causes the controller to switch to a “failure mode” according to 3.6 in EN12675.
2096
+ priority: 2
2097
+ category: D
2098
+ from_version: 1.1.0
2099
+ arguments:
2100
+ detector:
2101
+ type: string
2102
+ description: Designation of the detector (hardware)
2103
+ type:
2104
+ type: string
2105
+ description: Type of detector.
2106
+ values:
2107
+ loop: Inductive detector loop
2108
+ input: External input
2109
+ errormode:
2110
+ type: string
2111
+ description: Detector forced on/off while detector error
2112
+ values: ['on','off'] # on/off must be quoted, otherwise they are converted to true/false
2113
+ manual:
2114
+ type: boolean_as_string
2115
+ description: Manually controlled detector logic (True/False)
2116
+ A0304:
2117
+ description: |-
2118
+ Serious detector error (logic error).
2119
+ For instance; detector continuously on or off during an extended time.
2120
+ Is a “major fault” defined according to 3.8 i EN12675 which causes the controller to switch to a “failure mode” according to 3.6 in EN12675
2121
+ priority: 2
2122
+ category: D
2123
+ from_version: 1.1.0
2124
+ arguments:
2125
+ detector:
2126
+ type: string
2127
+ description: Designation of the detector (hardware)
2128
+ type:
2129
+ type: string
2130
+ description: Type of detector.
2131
+ values:
2132
+ loop: Inductive detector loop
2133
+ input: External input
2134
+ errormode:
2135
+ type: string
2136
+ description: Detector forced on/off while detector error
2137
+ values: ['on','off'] # on/off must be quoted, otherwise they are converted to true/false
2138
+ manual:
2139
+ type: boolean_as_string
2140
+ description: Manually controlled detector logic (True/False)
2141
+ logicerror:
2142
+ type: string
2143
+ description: Type of logic error
2144
+ values:
2145
+ always_off: no detection during predefined max time
2146
+ always_on: detection constantly on during predefined max time
2147
+ intermittent: intermittent logic fault (flutter)
2148
+ statuses:
2149
+ S0201:
2150
+ description: |-
2151
+ Traffic Counting: Number of vehicles.
2152
+ Used for Traffic counting.
2153
+ Please see Section 4: "Traffic counting" for additional requirements.
2154
+ from_version: 1.0.5
2155
+ arguments:
2156
+ starttime:
2157
+ type: timestamp
2158
+ description: Time stamp for start of measuring
2159
+ vehicles:
2160
+ type: integer_as_string
2161
+ description: Number of vehicles on a given detector logic (since last
2162
+ update)
2163
+ min: 0
2164
+ max: 65535
2165
+ S0202:
2166
+ description: |-
2167
+ Traffic Counting: Vehicle speed.
2168
+ Used for Traffic counting.
2169
+ Please see Section 4: "Traffic counting" for additional requirements.
2170
+ from_version: 1.0.5
2171
+ arguments:
2172
+ starttime:
2173
+ type: timestamp
2174
+ description: Time stamp for start of measuring
2175
+ speed:
2176
+ type: integer_as_string
2177
+ description: Average speed in km/h
2178
+ min: 0
2179
+ max: 65535
2180
+ S0203:
2181
+ description: |-
2182
+ Traffic Counting: Occupancy.
2183
+ Used for Traffic counting.
2184
+ Please see Section 4: "Traffic counting" for additional requirements.
2185
+ from_version: 1.0.5
2186
+ arguments:
2187
+ starttime:
2188
+ type: timestamp
2189
+ description: Time stamp for start of measuring
2190
+ occupancy:
2191
+ type: integer_as_string
2192
+ description: Occupancy in percent (0-100%)
2193
+ min: 0
2194
+ max: 100
2195
+ S0204:
2196
+ description: |-
2197
+ Traffic Counting: Number of vehicles of given classification.
2198
+ Used for Traffic counting.
2199
+ Please see Section 4: "Traffic counting" for additional requirements.
2200
+ from_version: 1.0.5
2201
+ arguments:
2202
+ starttime:
2203
+ type: timestamp
2204
+ description: Time stamp for start of measuring
2205
+ P:
2206
+ type: integer_as_string
2207
+ description: Number of cars
2208
+ min: 0
2209
+ max: 65535
2210
+ PS:
2211
+ type: integer_as_string
2212
+ description: Number of cars with trailers
2213
+ min: 0
2214
+ max: 65535
2215
+ L:
2216
+ type: integer_as_string
2217
+ description: Number of trucks
2218
+ min: 0
2219
+ max: 65535
2220
+ LS:
2221
+ type: integer_as_string
2222
+ description: Number of trucks with trailers
2223
+ min: 0
2224
+ max: 65535
2225
+ B:
2226
+ type: integer_as_string
2227
+ description: Number of buses
2228
+ min: 0
2229
+ max: 65535
2230
+ SP:
2231
+ type: integer_as_string
2232
+ description: Number of trams
2233
+ min: 0
2234
+ max: 65535
2235
+ MC:
2236
+ type: integer_as_string
2237
+ description: Number of motor cycles
2238
+ min: 0
2239
+ max: 65535
2240
+ C:
2241
+ type: integer_as_string
2242
+ description: Number of bicycles
2243
+ min: 0
2244
+ max: 65535
2245
+ F:
2246
+ type: integer_as_string
2247
+ description: Number of pedestrians
2248
+ min: 0
2249
+ max: 65535
2250
+ commands:
2251
+ M0008:
2252
+ description: |-
2253
+ Force detector logic.
2254
+ Force a given detector logic (1-255) to either true or false.
2255
+
2256
+ When 'status' is true the detector logic is forced to the state specified in 'mode'.
2257
+ While forced, no other source can activate or deactivate the detector logic.
2258
+ When forcing, the 'duration' can be set to automatically release the
2259
+ detector logic after a specific time interval.
2260
+
2261
+ When 'status' is false the detector logic is released and the state
2262
+ will again be controlled by other sources, e.g. hardware.
2263
+ Note that this means that releasing does not guarantee a return to the previous state.
2264
+ This is because the other control sources might have changed state while
2265
+ the detector logic was forced.
2266
+ When releasing, the 'mode' and 'duration' attributes are ignored.
2267
+
2268
+ Can also be for signal group prioritization if the controller is programmed
2269
+ to activate priority based on detector logic actication.
2270
+
2271
+ Requires security code 2
2272
+ from_version: 1.0.3
2273
+ arguments:
2274
+ status:
2275
+ type: boolean_as_string
2276
+ description: |-
2277
+ False: Release detector logic, 'mode' is ignored.
2278
+ True: Force detector logic to the value in 'mode'.
2279
+ duration:
2280
+ type: integer_as_string
2281
+ description: |-
2282
+ If set, automatically release after this number of
2283
+ milliseconds. Ignored if 'status' is false.
2284
+ Setting to zero is the same as leaving out, and means
2285
+ no automatic release will happen.
2286
+ min: 0
2287
+ securityCode:
2288
+ type: string
2289
+ description: Security code 2
2290
+ mode:
2291
+ type: boolean_as_string
2292
+ description: |-
2293
+ Mode to force to (ignored if 'status' is false).
2294
+ False: Deactivate detector logic
2295
+ True: Activate detector logic
2296
+ command: setForceDetectorLogic