rsmp_schema 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27c2190ce73299078c227b01b0da79f701bd94b5138504f1990a6ac16c3b0142
-  data.tar.gz: a912fd64f18d9f06608f358a97a08b0b9451e5afc26a5cdde728347778bbb9f8
+  metadata.gz: 8ef1bab7d72db34cc48ea2d84a02347969813176b3863f2c4fe389a75f1ad675
+  data.tar.gz: a05f416ef16d617cdd10e880a637fd8055ad94c84fcc542b993b78b8ceb3d3a8
 SHA512:
-  metadata.gz: 48f6469aec64aaab51e1cd0f33cabb1c83e8e049c95c906ca22a11a5c1b821c287d87e9e13db8ccdd7cc8d801a045f3cc5b9aeb087268feb0869570af3b98907
-  data.tar.gz: 912db9bb17a87cddfef109e0bfd036039ad485dfe00155b1863c3bf6cb5564cc895f6f2738652aff447a08f03bd53bdec7c92343322fba9de501e8012021d8f8
+  metadata.gz: 306e7c93c4cf1ef11ab4054d8fa977a3136d307db389dbf202f03d6581afe8ae5e1d6f9866811a5cb057e4dc786b2b96bef99fea8087c3a6ccab1b6ef1177916
+  data.tar.gz: 75b6ba3cdadd114544e89515acc1453db3511f95e103bdee96a65268ef6af656412e1bb6debe0f17724987a10dead2e4bacbaa9052f03fb7d9eb310bec322931

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp_schema (0.8.5)
+    rsmp_schema (0.8.6)
       json_schemer (~> 2.3.0)
       thor (~> 1.3.1)
 

data/lib/rsmp_schema/version.rb

@@ -1,5 +1,5 @@
 module RSMP
   module Schema
-    VERSION = "0.8.5"
+    VERSION = "0.8.6"
   end
 end

data/schemas/core/3.1.2/status_response.json

@@ -13,13 +13,9 @@
         "type" : "object",
         "properties": {
           "sCI" : { "$ref": "definitions.json#/status_code" },
-          "n" : { "description" : "Value name", "type" : "string" },
+          "n" : { "description" : "Value identifier", "type" : "string" },
           "s" : { "description" : "Value", "type" : "string" },
-          "q" : {
-            "description" : "Quality",
-            "type" : "string",
-            "enum" : [ "recent", "old", "undefined", "unknown" ]
-          }
+          "q" : { "description" : "Quality", "type" : "string", "enum" : [ "recent", "old", "unknown" ] }
         },
         "required" : [ "sCI", "n", "s", "q" ],
         "additionalProperties": false

data/schemas/core/3.1.2/status_update.json

@@ -13,13 +13,9 @@
         "type" : "object",
         "properties": {
           "sCI" : { "$ref": "definitions.json#/status_code" },
-          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "n" : { "description" : "Value identifier", "type" : "string" },
           "s" : { "description" : "Value", "type" : "string" },
-          "q" : {
-            "description" : "Value",
-            "type" : "string",
-            "enum" : [ "recent", "old", "undefined", "unknown" ]
-          }
+          "q" : { "description" : "Quality", "type" : "string", "enum" : [ "recent", "old", "unknown" ] }
         },
         "required" : [ "sCI", "n", "s", "q" ],
         "additionalProperties": false

data/schemas/core/3.1.3/status_response.json

@@ -11,33 +11,29 @@
       "minItems": 1,
       "items" : {
         "type" : "object",
-        "allOf" : [
-          {
-            "required" : [ "sCI", "n", "s", "q" ],
-            "additionalProperties" : false,
-            "properties": {
-              "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
-              "n" : { "description" : "Value name", "type" : "string" },
-              "q" : { "description" : "Quality", "type" : "string" },
-              "s" : { "description" : "Value" }
-            }
-          },
-          {
-            "if" : {
-              "required" : [ "q" ],
-              "properties": { "q" : { "const": "undefined" }}
-            },
-            "then" : {
-              "properties": { "s" : { "type": "null" }}
-            },
-            "else" : {
-              "properties": {
-                "s" : { "type" : ["string"] },
-                "q" : { "enum" : [ "recent", "old", "unknown" ] }
-              }
-            }
+        "properties": {
+          "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
+          "n" : { "description" : "Value identifier", "type" : "string" },
+          "s" : { "description" : "Value"},
+          "q" : { "description" : "Quality", "type" : "string", "enum" : [ "recent", "old", "unknown", "undefined"] }
+        },
+        "if": {
+          "properties": {
+            "q" : { "enum" : ["unknown","undefined"] }
           }
-        ]
+        },
+        "then": {
+          "properties": {
+            "s" : { "type" : "null" }
+          }
+        },
+        "else": {
+          "properties": {
+            "s" : { "type" : "string" }
+          }
+        },
+        "required" : [ "sCI", "n", "s", "q" ],
+        "additionalProperties": false
       }
     }
   },

data/schemas/core/3.1.3/status_update.json

@@ -1,4 +1,4 @@
- {
+{
   "title" :  "StatusUpdate",
   "description" :  "Status update",
   "properties" : {
@@ -13,12 +13,23 @@
         "type" : "object",
         "properties": {
           "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
-          "n" : { "description" : "Unique reference of the value", "type" : "string" },
-          "s" : { "description" : "Value", "type" : "string" },
-          "q" : {
-            "description" : "Value",
-            "type" : "string",
-            "enum" : [ "recent", "old", "undefined", "unknown" ]  // 'undefined' was addded
+          "n" : { "description" : "Value identifier", "type" : "string" },
+          "s" : { "description" : "Value"},
+          "q" : { "description" : "Quality", "type" : "string", "enum" : [ "recent", "old", "unknown", "undefined"] }
+        },
+        "if": {
+          "properties": {
+            "q" : { "enum" : ["unknown","undefined"] }
+          }
+        },
+        "then": {
+          "properties": {
+            "s" : { "type" : "null" }
+          }
+        },
+        "else": {
+          "properties": {
+            "s" : { "type" : "string" }
           }
         },
         "required" : [ "sCI", "n", "s", "q" ],

data/schemas/core/3.2.0/status_response.json

@@ -11,33 +11,29 @@
       "minItems": 1,
       "items" : {
         "type" : "object",
-        "allOf" : [
-          {
-            "required" : [ "sCI", "n", "s", "q" ],
-            "additionalProperties" : false,
-            "properties": {
-              "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
-              "n" : { "description" : "Unique reference of the value", "type" : "string" },
-              "q" : { "description" : "Quality", "type" : "string" },
-              "s" : { "description" : "Value" }
-            }
-          },
-          {
-            "if" : {
-              "required" : [ "q" ],
-              "properties": { "q" : { "const": "undefined" }}
-            },
-            "then" : {
-              "properties": { "s" : { "type": "null" }}
-            },
-            "else" : {
-              "properties": {
-                "s" : { "type" : [ "string", "array" ] },
-                "q" : { "enum" : [ "recent", "old", "unknown" ] }
-              }
-            }
+        "properties": {
+          "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "s" : { "description" : "Value"},
+          "q" : { "description" : "Quality", "type" : "string", "enum" : [ "recent", "old", "undefined", "unknown"] }
+        },
+        "if": {
+          "properties": {
+            "q" : { "enum" : ["unknown","undefined"] }
           }
-        ]
+        },
+        "then": {
+          "properties": {
+            "s" : { "type" : "null" }
+          }
+        },
+        "else": {
+          "properties": {
+            "s" : { "type" : ["string","array"] }
+          }
+        },
+        "required" : [ "sCI", "n", "s", "q" ],
+        "additionalProperties": false
       }
     }
   },

data/schemas/core/3.2.0/status_update.json

@@ -14,11 +14,22 @@
         "properties": {
           "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
-          "s" : { "description" : "Value", "type" : ["string","array"] },   // array is allowed from 3.2.0
-          "q" : {
-            "description" : "Value",
-            "type" : "string",
-            "enum" : [ "recent", "old", "undefined", "unknown" ]
+          "s" : { "description" : "Value"},
+          "q" : { "description" : "Quality", "type" : "string", "enum" : [ "recent", "old", "undefined", "unknown"] }
+        },
+        "if": {
+          "properties": {
+            "q" : { "enum" : ["unknown","undefined"] }
+          }
+        },
+        "then": {
+          "properties": {
+            "s" : { "type" : "null" }
+          }
+        },
+        "else": {
+          "properties": {
+            "s" : { "type" : ["string","array"] }
           }
         },
         "required" : [ "sCI", "n", "s", "q" ],

data/sxl_yaml_format.md

@@ -0,0 +1,237 @@
+# Format of SXL YAML Files
+An RSMP SXL (Signal Exchange List) defines the messages that can be exchanged with a specific type of equipment, e.g. traffic light controllers.
+
+Specifically, the SXL defines the alarms, statuses and commands and their attributes.
+
+The SXL is the authoritative source for an SXL, and is used to generate documentation as well as JSON schema for automatic validation of message structure.
+It's also used to generate configuratiosn for tools that cannot yert directly read the YAML format.
+
+
+```mermaid
+graph LR
+YAML --> Documentation
+YAML --> Schema[JSON Schema]
+YAML --> Tools[Tool Configurations]
+```
+
+## Structure
+An SXL YAML contains a meta section, and a definition of the objects types included in the SXL:
+
+```
+meta: Information about the SXL
+objects: Definitions of objects types
+  Traffic Light Controller:
+    ...
+  Signal group:
+    ...
+  Detector logic
+    ...
+```
+
+### Meta Section
+Includes descriptions of the SXL, like the name and version.
+
+```
+meta:
+  name: Name of the schema
+  description: Description of the schema
+  version: Version of the schema
+```
+
+### Objects Section
+Contains definitions of each object type in the SXL.
+For each object type, there's a description, as well as definition of alarms, statuses and commands:
+ 
+```
+objects:
+  Signal Group:
+    description: Description of the object
+    aggregated_status: Aggregated status definitions
+      ...
+    functional_position: Definition of functional position
+    functional_state: Definition of functional state
+    alarms: Alarm definitions
+      ...
+    statuses: Status definitions
+      ...
+    commands: Command definitions
+      ...
+  ...
+```
+### Aggregated Status Section
+For each object type, the `aggregated_status:` section defines meaning of status bits 1-8:
+
+```
+  aggregated_status:
+    1:
+      title: Name of status bit
+      description: Description of status bit
+    ...
+    8:
+      title: Name of status bit
+      description: Description of status bit
+```
+
+### Functional Position and State 
+For each object type, the `functional_position:` and `functional_state:` define possible values.
+If not used, `null` is specified.
+
+```
+    functional_position: List of possible values, or null if not used
+    functional_state: List of possible values, or null if not used
+```
+
+### Alarms Sections
+For each object type, the `alarms:` section defines the alarms that can be send by that type of object.
+The allowed alarm priorities and categories are defined in RSMP Core.
+
+```
+  A0001: Definition of alarm 1
+    description: Description of the alarm
+    priority: The alarm priority, either 1, 2 or 3
+    category: The alarm categery, either D or T
+```
+
+### Statuses Sections
+For each object type, the `statuses:` section defines the alarms that can be send by that type of object.
+
+```
+  S0001: Definition of status 1
+    description: Description of the status
+    arguments: Definition of status arguments
+      ...
+```
+
+Each argument contains a required description and a type. In addition it might contain other optional attributes that define
+or restict how the argument is used.
+
+```
+    arguments:
+      speed:
+        description: Description of argument
+        type: Type of argument
+        ...
+      ...
+```
+
+### Commands Sections
+For each object type, the `commands:` section defines the alarms that can be send to that type of object.
+In addition it might contain other options used for validating the argument value.
+
+```
+  M001: Definition of command 1
+    description: Description of the command
+    arguments: Definition of command arguments
+      ...
+```
+
+Each argument contains a required description and a type.
+In addition it might contain other options used for validating the argument value.
+
+```
+    arguments:
+      speed:
+        description: Description of argument
+        type: Type of argument
+        ...
+      ...
+```
+
+### Argument options
+Status and command argument definition might include options describing which values are valid for that argument.
+These option can also be used for validating messages, e.g. by generating a JSON Schema.
+
+#### description (Required)
+A description of the argument
+
+#### type (Required)
+The type allowed for the argument. Possible values:
+
+- string, a string, e.g. "start"
+- integer: an integer send as a string, e.g. "6"
+- boolean: a boolean send as a string, ether "true" or "false"
+- base64: binary data encoded in base 64 format
+- timestamp: a timestamp in the format "2025-06-08T08:05:06.584Z
+- version: a semantic version string in the format "4.2.5"
+- message_id: a message id in the format "be12ab9a-800c-4c19-8c50-adf832f22420"
+- component_id: a string without further retrictions, e.g. "O+14439=481WA001"
+- command_code: a command code in the format "M0001"
+- status_code: a status code in the format "S0001"
+- alarm_code: an alarm code in the format "A0001"
+- string_list: a string with a command-separted list of items, e.g. "red,green,blue"
+- integer_list: a string wih a comma-separated list of integers, e.g. "1,2,3"
+- boolean_list: a string with a comma-separated list of booelans, e.g. "true,true,false"
+
+#### values
+A list of allowed enum values, defines as a hash of value/description.
+The values can be either strings or integers:
+
+Example:
+```yaml
+   values:
+     new: New priority request
+     update: Update to existing priority request
+     cancel: Cancel an existing priority
+```
+
+#### min
+Minimum value specified as an integer, e.g. 1.
+Only allowed if the type is `integer`.
+
+#### max
+Maximum value specified as an integer, e.g. 255.
+Only allowed if the type is `integer`.
+
+#### pattern
+A regular expression (regex) pattern used to validate the raw argument string, specified as a string, e.g. "^[01]*$".
+Allowed regardless of the argument type.
+
+## Example Structure
+Here is an example structure of an SXL YAML file:
+
+```yaml
+meta:
+  name: tlc
+  description: Traffic Light Controllers
+  version: 1.0.15
+objects:
+  Traffic Light Controller:
+    description: SXL for Traffic Light Controllers
+    aggregated_status:
+      1:
+        title: Local mode
+        description: Traffic Light Controller is in local mode
+      ...
+      8:
+        title: Not Connected
+    functional_position: null
+    functional_state: null
+    alarms:
+      A0001:
+        description: Serious hardware error
+        priority: 2
+        category: D
+      ...
+    statuses:
+      S0001:
+        description: Signal group status
+        arguments:
+          cyclecounter:
+            description: Cycle counter
+            type: integer
+            min: 0
+            max: 999
+          ...
+      ...
+    commands:
+      M0002:
+        description: Set current time plan
+        arguments:
+          timeplan:
+            description: Time plan number
+            type: integer
+            min: 1
+            max: 255
+          ...
+      ...
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp_schema
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schemer
@@ -954,6 +954,7 @@ files:
 - schemas/tlc/1.2.1/statuses/S0208.json
 - schemas/tlc/1.2.1/statuses/statuses.json
 - schemas/tlc/1.2.1/sxl.yaml
+- sxl_yaml_format.md
 homepage: https://github.com/rsmp-nordic/rsmp_schema
 licenses:
 - MIT
@@ -977,7 +978,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Validate RSMP message against RSMP JSON Schema.