rsmp_schema 0.1.1 → 0.2.0

data/schemas/tlc/1.1/sxl.yaml

@@ -131,7 +131,8 @@ objects:
               mod = modulo
 
               See the coordination section for more information.
-            range: "[0-999]"
+            min: 0
+            max: 999
           basecyclecounter:
             type: integer
             description: |-
@@ -139,11 +140,13 @@ objects:
               Used for handling of coordination between TLC’s.
               Synchronized between all TLC’s in an active coordination.
               See the coordination section for more information.
-            range: "[0-999]"
+            min: 0
+            max: 999
           stage:
             type: integer
             description: Current stage (isolated)
-            range: "[0-999]"
+            min: 0
+            max: 999
       S0002:
         description: |-
           Detector logic status.
@@ -217,7 +220,8 @@ objects:
           emergencystage:
             type: integer
             description: Number of emergency stage
-            range: "[1-255]"
+            min: 1
+            max: 255
       S0007:
         description: |-
           Controller switched on.
@@ -226,23 +230,20 @@ objects:
           During maintenance work the controller might be using dark mode (no output to the signal heads).
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Traffic Light Controller in dark mode
               True: Traffic Light Controller not in dark mode
           source:
             description: Source of the status change
-            list: true
-            type: string
+            type: string_list
             values:
               operator_panel: Operator panel 
               calendar_clock: Calendar/clock 
@@ -257,22 +258,19 @@ objects:
           Signal timings is controlled manually by service personnel using the operating panel of the controller.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Manual control inactive
               True: Manual control active
           source:
-            list: true
-            type: string
+            type: string_list
             description: Source of the status change
             values:
               operator_panel: Operator panel 
@@ -288,22 +286,19 @@ objects:
           Usually only used in case normal detectors can't be used, e.g. during maintenance work.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Fixed time control inactive
               True: Fixed time control active
           source:
-            list: true
-            type: string
+            type: string_list
             description: Source of the status change
             values:
               operator_panel: Operator panel 
@@ -319,22 +314,19 @@ objects:
           Used to determine if the controller is operating independently or operating with other controllers (coordination).
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Isolated control disabled
               True: Isolated control enabled (Vehicle actuated control or Fixed time control)
           source:
-            list: true
-            type: string
+            type: string_list
             description: Source of the status change
             values:
               operator_panel: Operator panel 
@@ -350,22 +342,19 @@ objects:
           Yellow flash may be used during a serious fault (depending on configuration) or maintenance work. It can also be manually set using M0001.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Yellow flash disabled
               True: Yellow flash enabled
           source:
-            list: true
-            type: string
+            type: string_list
             description: Source of the status change
             values:
               operator_panel: Operator panel 
@@ -381,22 +370,19 @@ objects:
           All red can be manually set using the controllers operating panel during maintenance work.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: All red disabled
               True: All red enabled
           source:
-            list: true
-            type: string
+            type: string_list
             description: Source of the status change
             values:
               operator_panel: Operator panel 
@@ -412,16 +398,14 @@ objects:
           The "police key" is a external control switch present in some controllers that manually switches the controller to either dark mode or yellow flash.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           status:
-            list: true
-            type: integer
+            type: integer_list
             values:
               0: disabled
               1: dark mode
@@ -436,10 +420,10 @@ objects:
           status:
             type: integer
             description: Current time plan
-            range: "[1-255]"
+            min: 1
+            max: 255
           source:
-            list: true
-            type: string
+            type: string_list
             description: Source of the status change
             values:
               operator_panel: Operator panel 
@@ -458,10 +442,10 @@ objects:
           status:
             type: integer
             description: Current traffic situation
-            range: "[1-255]"
+            min: 1
+            max: 255
           source:
-            list: true
-            type: string
+            type: string_list
             description: Source of the status change
             values:
               operator_panel: Operator panel 
@@ -478,7 +462,8 @@ objects:
           number:
             type: integer
             description: Number of detector logics
-            range: "[1-65025]"
+            min: 1
+            max: 65025
       S0017:
         description: |-
           Number of signal groups.
@@ -487,7 +472,8 @@ objects:
           number:
             type: integer
             description: Number of signal groups
-            range: "[1-65025]"
+            min: 1
+            max: 65025
       S0018:
         description: |-
           Number of time plans
@@ -496,7 +482,8 @@ objects:
           number:
             type: integer
             description: Number of time plans (depreciated)
-            range: "[1-65025]"
+            min: 1
+            max: 65025
       S0019:
         description: |-
           Number of traffic situations.
@@ -505,23 +492,22 @@ objects:
           number:
             type: integer
             description: Number of traffic situations
-            range: "[1-65025]"
+            min: 1
+            max: 65025
       S0020:
         description: |-
           Control mode.
           Can be used for the management system to check the current control mode (startup, normal, standby, failure, test).
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           controlmode:
-            list: true
-            type: string
+            type: string_list
             values:
               startup: Startup mode
               control: Normal control
@@ -696,16 +682,14 @@ objects:
           Please note that all values in this status uses comma-separated lists - one value for each intersection, e.g. “1,2” and “centralized,off”
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
             min: 0
             max: 255
           status:
-            list: true
-            type: string
+            type: string_list
             description: |-
               local: Local coordination
               centralized: Coordination with synchronized clock
@@ -713,11 +697,10 @@ objects:
             values:
               local:
               centralized:
-              off:
+              'off':
           source:
             description: Source of the status change
-            list: true
-            type: string
+            type: string_list
             values:
               operator_panel: Operator panel
               calendar_clock: Calendar/clock
@@ -725,6 +708,60 @@ objects:
               forced: Forced due to external command e.g. supervisor
               startup: Set after startup mode
               other: Other reason
+      S0033:
+        description: |-
+          Signal Priority Status
+          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.
+          A list of priorities is returned, referred to by their request ids. The same request id can appear only once.
+          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.
+          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.
+          To understand how this status relates to ETSI/J2735, please see the wiki.
+          All priorities are send on every status update, regardless of whether an interval, or sendOnChange (or both) is used.
+          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.
+          A request always starts in the ‘received’ state. The following table shows the possible state transitions:
+        arguments:
+          status:
+            description: JSON array of priority status items
+            type: array
+            items:
+              r:
+                type: string
+                description: ID of the priority request
+              t:
+                type: timestamp
+                description: |-
+                  Timestamp, indicating when the priority last changed state.
+                  Format according to W3C XML dateTime with a resolution of 3 decimal places.
+                  All time stamps in UTC. E.g. 2009-10-02T14:34:34.341Z
+              s:
+                type: string
+                description: |-
+                  Current status of the priority request
+                values:
+                  received: A new priority request was received but has not yet been processed
+                  queued: The priority request has been queued for later activation
+                  activated: The priority was activated
+                  completed: The priority was cancelled as expected
+                  timeout: The priority has been queued for too long
+                  rejected: The priority request cannot be granted
+                  cooldown: A similar priority request means the priority request cannot be activated now
+                  stale: The priority has been active too long without cancellation, and was therefore removed
+              e:
+                type: integer
+                description: |-
+                  (Optional) Estimated green extension provided by the priority, in seconds
+                  Only used when state is ‘completed’.
+                optional: true
+                min: 0
+                max: 255
+              d:
+                type: integer
+                description: |-
+                  (Optional) Estimated red reduction provided by the priority, in seconds
+                  Only used when state is ‘completed’.
+                optional: true
+                min: 0
+                max: 255
       S0034:
         description: |-
           Timeout for dynamic bands.
@@ -865,7 +902,6 @@ objects:
               Note:
               - There is no way to upload this binary file to the TLC using RSMP
               - The format of the binary file is not specified and is not expected to be compatible between suppliers
-            range: "[binary]"
           timestamp:
             type: timestamp
             description: |-
@@ -885,13 +921,14 @@ objects:
             description: |-
               Time stamp for start of measuring. Format according to W3C XML dateTime with a resolution of 3 decimal places. All time stamps in UTC. E.g. 2009-10-02T14:34:34.341Z
           vehicles:
-            type: string
+            type: integer_list
             description: |-
               Number of vehicles.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
       S0206:
         description: |-
           Traffic Counting: Vehicle speed
@@ -904,13 +941,14 @@ objects:
               XML dateTime with a resolution of 3 decimal places. All time stamps
               in UTC. E.g. 2009-10-02T14:34:34.341Z
           speed:
-            type: string
+            type: integer_list
             description: |-
               Average speed in km/h (integer).
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
       S0207:
         description: |-
           Traffic Counting: Occupancy.
@@ -923,13 +961,14 @@ objects:
               XML dateTime with a resolution of 3 decimal places. All time stamps
               in UTC. E.g. 2009-10-02T14:34:34.341Z
           occupancy:
-            type: string
+            type: integer_list
             description: |-
               Occupancy in percent (%) (0-100)
               - Value expressed as an integer with a range of 0-100.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-100,...]"
+            min: 0
+            max: 100
       S0208:
         description: |-
           Traffic Counting: Number of vehicles of given classification.
@@ -942,77 +981,86 @@ objects:
               XML dateTime with a resolution of 3 decimal places. All time stamps
               in UTC. E.g. 2009-10-02T14:34:34.341Z
           P:
-            type: string
+            type: integer_list
             description: |-
               Number of cars.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
           PS:
-            type: string
+            type: integer_list
             description: |-
               Number of cars with trailers.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
           L:
-            type: string
+            type: integer_list
             description: |-
               Number of trucks.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
           LS:
-            type: string
+            type: integer_list
             description: |-
               Number of trucks with trailers.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
           B:
-            type: string
+            type: integer_list
             description: |-
               Number of busses.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
           SP:
-            type: string
+            type: integer_list
             description: |-
               Number of trams.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
           MC:
-            type: string
+            type: integer_list
             description: |-
               Number of motor cycles.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
           C:
-            type: string
+            type: integer_list
             description: |-
               Number of bicycles.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
           F:
-            type: string
+            type: integer_list
             description: |-
               Number of pedestrians.
               - Value expressed as an integer with a range of 0-65535.
               - Contains data from all detector logics. Each detector logic is separated with a comma.
               - The value is set to “-1” if no data could be measured (e.g. detector fault)
-            range: "[0-65535,...]"
+            min: 0
+            max: 65535
     commands:
       M0001:
         description: |-
@@ -1021,28 +1069,24 @@ objects:
           Requires security code 2.
         arguments:
           status:
-            list: true
+            type: string_list
             description: Set operating mode
-            type: string
             values:
               NormalControl: Normal Control
               YellowFlash: Enables yellow flash
               Dark: Enables dark mode
           securityCode:
-            list: true
+            type: string_list
             description: Security code 2
-            type: string
           timeout:
-            list: true
+            type: integer
             description: |-
               Time in minutes until controller automatically reverts to previous functional position.
               0=no automatic return
-            type: integer
             min: 0
             max: 1440
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               Comma separated list of intersections which the status relates to, e.g. “1,2”.
               Use “0” for all intersections of the TLC.
@@ -1068,7 +1112,8 @@ objects:
           timeplan:
             type: integer
             description: designation of time plan
-            range: "[1-255]"
+            min: 1
+            max: 255
         command: setPlan
       M0003:
         description: |-
@@ -1088,7 +1133,8 @@ objects:
           traficsituation:
             type: integer
             description: designation of traficsituation
-            range: "[1-255]"
+            min: 1
+            max: 255
         command: setTrafficSituation
       M0004:
         description: |-
@@ -1121,7 +1167,8 @@ objects:
           emergencyroute:
             type: integer
             description: Number of emergency route
-            range: "[1-255]"
+            min: 1
+            max: 255
         command: setEmergency
       M0006:
         description: |-
@@ -1143,7 +1190,8 @@ objects:
           input:
             type: integer
             description: Number of Input
-            range: "[1-255]"
+            min: 1
+            max: 255
         command: setInput
       M0007:
         description: |-
@@ -1259,7 +1307,8 @@ objects:
           plan:
             type: integer
             description: Plan to be changed
-            range: "[0-255]"
+            min: 0
+            max: 255
           status:
             type: string
             description: |-
@@ -1286,11 +1335,13 @@ objects:
           status:
             type: integer
             description: Set offset time in seconds
-            range: "[0-255]"
+            min: 0
+            max: 255
           plan:
             type: integer
             description: Time plan nr
-            range: "[0-255]"
+            min: 0
+            max: 255
           securityCode:
             type: string
             description: Security code 2
@@ -1370,11 +1421,13 @@ objects:
           status:
             type: integer
             description: Set cycle time in seconds
-            range: "[1-255]"
+            min: 1
+            max: 255
           plan:
             type: integer
             description: Time plan nr
-            range: "[0-255]"
+            min: 0
+            max: 255
           securityCode:
             type: string
             description: Security code 2
@@ -1397,7 +1450,8 @@ objects:
           input:
             type: integer
             description: Number of Input
-            range: "[1-255]"
+            min: 1
+            max: 255
           inputValue:
             type: boolean
             description: |-
@@ -1422,7 +1476,8 @@ objects:
           output:
             type: integer
             description: Number of Output
-            range: "[1-255]"
+            min: 1
+            max: 255
           outputValue:
             type: boolean
             description: |-
@@ -1504,34 +1559,41 @@ objects:
             description: A string that uniquely identifies the request on the controller
           signalGroupId:
             type: string
+            optional: true
             description: (Optional) ID of a signal group component.
           inputId:
             type: integer
+            optional: true
             description: (Optional) ID of an input, using the same numbering scheme as M0006
             min: 0
             max: 255
           connectionId:
             type: integer
+            optional: true
             description: (Optional) ID of a connection, connecting an ingoing and an outgoing lane
             min: 0
             max: 255
           approachId:
             type: integer
+            optional: true
             description: (Optional) ID of an intersection approach
             min: 0
             max: 16
           laneInId:
             type: integer
+            optional: true
             description: (Optional) ID of an ingoing lane
             min: 0
             max: 255
           laneOutId:
             type: integer
+            optional: true
             description: (Optional) ID of an outgoing lane
             min: 0
             max: 255
           priorityId:
             type: integer
+            optional: true
             description: (Optional) ID of a priority
             min: 0
             max: 255
@@ -1553,11 +1615,13 @@ objects:
             max: 14
           eta:
             type: integer
+            optional: true
             description: (Optional) Estimated time of arrival to the intersection, in seconds
             min: 0
             max: 255
           vehicleType:
             type: string
+            optional: true
             description: |-
               (Optional) Vehicle type
 
@@ -1732,17 +1796,17 @@ objects:
           Time-of-Green / Time-of-Red.
           Provides predicted signal timings of green and red for each signal group. Max, min and likely time to green and red.
         arguments:
-          minToGEstimate   :
+          minToGEstimate:
             type: timestamp
             description: |-
               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.
               Format according to W3C XML dateTime with a resolution of 3 decimal places. All time stamps in UTC. E.g. 2009-10-02T14:34:34.341Z
-          maxToGEstimate   :
+          maxToGEstimate:
             type: timestamp
             description: |-
               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.
               Format according to W3C XML dateTime with a resolution of 3 decimal places. All time stamps in UTC. E.g. 2009-10-02T14:34:34.341Z
-          likelyToGEstimate   :
+          likelyToGEstimate:
             type: timestamp
             description: |-
               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.
@@ -1750,8 +1814,9 @@ objects:
           ToGConfidence:
             type: integer
             description: Confidence of the likelyToGEstimate. 0-100%
-            range: "[0-100]"
-          minToREstimate   :
+            min: 0
+            max: 100
+          minToREstimate:
             type: timestamp
             description: |-
               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.
@@ -1761,7 +1826,7 @@ objects:
             description: |-
               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.
               Format according to W3C XML dateTime with a resolution of 3 decimal places. All time stamps in UTC. E.g. 2009-10-02T14:34:34.341Z
-          likelyToREstimate   :
+          likelyToREstimate:
             type: timestamp
             description: |-
               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.
@@ -1769,7 +1834,8 @@ objects:
           ToRConfidence:
             type: integer
             description: Confidence of the likelyToREstimate. 0-100%
-            range: "[0-100]"
+            min: 0
+            max: 100
     commands:
       M0010:
         description: |-
@@ -1816,7 +1882,6 @@ objects:
           detector:
             type: string
             description: Designation of the detector (hardware)
-            range: "[designation]"
           type:
             type: string
             description: Type of detector
@@ -1827,8 +1892,8 @@ objects:
             type: string
             description: Detector forced on/off while detector error
             values:
-              'on': ''
-              'off': ''
+              'on':    # on/off must be quoted, otherwise they are converted to true/false
+              'off':
           manual:
             type: boolean
             description: Manually controlled detector logic (True/False)
@@ -1843,7 +1908,6 @@ objects:
           detector:
             type: string
             description: Designation of the detector (hardware)
-            range: "[designation]"
           type:
             type: string
             description: Type of detector.
@@ -1967,7 +2031,8 @@ objects:
           occupancy:
             type: integer
             description: Occupancy in percent (0-100%)
-            range: "[0-100]"
+            min: 0
+            max: 100
       S0204:
         description: |-
           Traffic Counting: Number of vehicles of given classification.