rsmp_schema 0.4.5 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c357f707bd7797ccad36b5b4a86d1599d2b8b1351007037a87ea1e56b2601a7
-  data.tar.gz: 41c02d05f87b281b4bff551ca790458ab2a860c459a59ca34c1f5d1f9bfb3ec1
+  metadata.gz: b0fe667b2e56247b88fa296646f5722440c9e8e6fa39b1df0a100ac9e41428b0
+  data.tar.gz: e15a00378c0e0d111f5fb2e7a9c4a36b6ade8b5ff81ac228dd6d47ef29dca223
 SHA512:
-  metadata.gz: 3e7254f157c26648285d3a7e44f921023fe3233792d5207e9b6081d4a849f0357e0a46971e93b642133d1f180d962f466fd08dea901768c4a83cc038dbe2229f
-  data.tar.gz: 6bc084b220bcf1b9d2dea02c7bba7c296c5b64c204d4e4641972fc4f6a99c86e52944fbc176d137f59ed1251d89b910d3bc1e9e8a8aa8780b98495d82ca80c62
+  metadata.gz: ebae7d8552ff121ed8c6e7f33b7c71d16aba8a344daf9d74d9cceddb701400f6117f8a49e97b996a190bce7adc115132e1d940114f95bd8f71446c6ca9300eee
+  data.tar.gz: f3a2b02f947c1da1bb3081898e16d0c5669bfbb3f4a97c220f0eeb1db435186cd61c911504af584b5c2bdb62ec89ed8645d00c42cf59458f6dfdef34d1b4f82f

data/.github/workflows/rspec.yaml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        ruby: ['3.0', '3.1']
+        ruby: ['3.0', '3.1', '3.2']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp_schema (0.4.5)
+    rsmp_schema (0.5)
       json_schemer (~> 0.2.21)
       thor (~> 1.2.1)
 
@@ -52,4 +52,4 @@ DEPENDENCIES
   rspec-expectations (~> 3.11.0)
 
 BUNDLED WITH
-   2.3.19
+   2.4.20

data/lib/rsmp_schema/schema.rb

@@ -30,9 +30,12 @@ module RSMP::Schema
     @@schemas[type] = {}
     Dir.glob("#{type_path}/*").select {|f| File.directory? f}.each do |schema_path|
       version = File.basename(schema_path)
-      @@schemas[type][version] = JSONSchemer.schema(
-        Pathname.new(File.join(schema_path,'rsmp.json'))
-      )
+      file_path = File.join(schema_path,'rsmp.json')
+      if File.exist? file_path
+        @@schemas[type][version] = JSONSchemer.schema(
+          Pathname.new(File.join(schema_path,'rsmp.json'))
+        )
+      end
     end
   end
 

data/lib/rsmp_schema/version.rb

@@ -1,5 +1,5 @@
 module RSMP
   module Schema
-    VERSION = "0.4.5"
+    VERSION = "0.5"
   end
 end

data/schemas/core/3.2/status_response.json

@@ -17,7 +17,7 @@
             "additionalProperties" : false,
             "properties": {
               "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
-              "n" : { "description" : "Value name", "type" : "string" },
+              "n" : { "description" : "Unique reference of the value", "type" : "string" },
               "q" : { "description" : "Quality", "type" : "string" },
               "s" : { "description" : "Value" }
             }

data/schemas/core/3.2.1/core.json

@@ -0,0 +1,39 @@
+{
+  "$schema" : "http://json-schema.org/draft-07/schema#",
+  "name" : "core",
+  "description" : "Core",
+  "version" : "3.2.1",
+  "type" :  "object",
+  "allOf" : [
+    {
+      "properties" : {
+        "mType" : {
+          "description" : "Supported RSMP versions",
+          "type" : "string",
+          "const" : "rSMsg"
+        },
+        "type" : {
+          "description" : "Type of RMSP message",
+          "type" : "string",
+          "enum" : [
+            "MessageAck",
+            "MessageNotAck",
+            "Version",
+            "AggregatedStatus",
+            "AggregatedStatusRequest",
+            "Watchdog",
+            "Alarm",
+            "CommandRequest",
+            "CommandResponse",
+            "StatusRequest",
+            "StatusResponse",
+            "StatusSubscribe",
+            "StatusUnsubscribe",
+            "StatusUpdate"
+          ]
+        }
+      },
+      "required" : [ "mType", "type" ]
+    }
+  ]
+}

data/schemas/core/3.2.1/rsmp.json

@@ -0,0 +1,133 @@
+{
+  "allOf": [
+    {
+      "$ref": "../3.2/core.json"
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageAck" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/message_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageNotAck" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/message_not_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Version" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/version.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "AggregatedStatus" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/aggregated_status.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "AggregatedStatusRequest" } }
+      },
+      "then": {
+        "$ref": "../3.1.5/aggregated_status_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Watchdog" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/watchdog.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Alarm" } }
+      },
+      "then": {
+        "$ref": "../3.2/alarm.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "CommandRequest" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/command_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "CommandResponse" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/command_response.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusRequest" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/status_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusResponse" } }
+      },
+      "then": {
+        "$ref": "../3.2/status_response.json"
+      }
+    },
+    {
+      "if": {
+         "required" : ["type"],
+       "properties": { "type": { "const": "StatusSubscribe" } }
+      },
+      "then": {
+        "$ref": "../3.1.5/status_subscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUnsubscribe" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/status_unsubscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUpdate" } }
+      },
+      "then": {
+        "$ref": "../3.2/status_update.json"
+      }
+    }
+  ]
+}

data/schemas/tlc/1.2/alarms/A0001.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Serious hardware error.\nIs 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."
+}

data/schemas/tlc/1.2/alarms/A0002.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Less serious hardware error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
+}

data/schemas/tlc/1.2/alarms/A0003.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Serious configuration error.\nIs 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."
+}

data/schemas/tlc/1.2/alarms/A0004.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Less serious configuration error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
+}

data/schemas/tlc/1.2/alarms/A0005.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Synchronisation error (coordination).\nIs a \"minor fault\" defined according to 3.11 in EN12675."
+}

data/schemas/tlc/1.2/alarms/A0006.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Safety error\nIs 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."
+}

data/schemas/tlc/1.2/alarms/A0007.json

@@ -0,0 +1,59 @@
+{
+  "description" : "Communication error.\nUsed for communication errors with the central system. Includes NTP connection loss if the TLC is configured to use NTP.\nIs a \"minor fault\" defined according to 3.11 in EN12675.",
+  "allOf" : [
+    {
+      "properties" : {
+        "n" : {
+          "enum" : [
+            "protocol"
+          ]
+        }
+      }
+    },
+    {
+      "if" : {
+        "required" : [
+          "q"
+        ],
+        "properties" : {
+          "q" : {
+            "const" : "undefined"
+          }
+        }
+      },
+      "then" : {
+        "s" : {
+          "type" : "null"
+        }
+      },
+      "else" : {
+        "allOf" : [
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "protocol"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "description" : "Type of communication error, e.g. NTP or RSMP",
+                  "type" : "string",
+                  "enum" : [
+                    "ntp",
+                    "rsmp"
+                  ]
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  ]
+}

data/schemas/tlc/1.2/alarms/A0008.json

@@ -0,0 +1,61 @@
+{
+  "description" : "Dead lock error.\nUsed for dead lock errors.\nFor 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 failure mode. The cause for this error is due to configuration errors or external sources.\nIs 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.",
+  "allOf" : [
+    {
+      "properties" : {
+        "n" : {
+          "enum" : [
+            "timeplan"
+          ]
+        }
+      }
+    },
+    {
+      "if" : {
+        "required" : [
+          "q"
+        ],
+        "properties" : {
+          "q" : {
+            "const" : "undefined"
+          }
+        }
+      },
+      "then" : {
+        "s" : {
+          "type" : "null"
+        }
+      },
+      "else" : {
+        "allOf" : [
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "timeplan"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "allOf" : [
+                    {
+                      "description" : "Current time plan"
+                    },
+                    {
+                      "$ref" : "../../../core/3.1.2/definitions.json#/integer"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  ]
+}

data/schemas/tlc/1.2/alarms/A0009.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Other error.\nUsed for other errors not covered by any other alarm type.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
+}

data/schemas/tlc/1.2/alarms/A0010.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Door open.\nUsed for open door (room or cabinet)."
+}

data/schemas/tlc/1.2/alarms/A0101.json

@@ -0,0 +1,3 @@
+{
+  "description" : "Pushbutton error.\nUsed for push buttons."
+}

data/schemas/tlc/1.2/alarms/A0201.json

@@ -0,0 +1,60 @@
+{
+  "description" : "Serious lamp error.\nUsed for lamp errors.\nIs 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.",
+  "allOf" : [
+    {
+      "properties" : {
+        "n" : {
+          "enum" : [
+            "color"
+          ]
+        }
+      }
+    },
+    {
+      "if" : {
+        "required" : [
+          "q"
+        ],
+        "properties" : {
+          "q" : {
+            "const" : "undefined"
+          }
+        }
+      },
+      "then" : {
+        "s" : {
+          "type" : "null"
+        }
+      },
+      "else" : {
+        "allOf" : [
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "color"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "description" : "Color of lamp",
+                  "type" : "string",
+                  "enum" : [
+                    "green",
+                    "red",
+                    "yellow"
+                  ]
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  ]
+}

data/schemas/tlc/1.2/alarms/A0202.json

@@ -0,0 +1,60 @@
+{
+  "description" : "Less serious lamp error.\nUsed for lamp errors.\nIs a \"minor fault\" defined according to 3.11 in EN12675.",
+  "allOf" : [
+    {
+      "properties" : {
+        "n" : {
+          "enum" : [
+            "color"
+          ]
+        }
+      }
+    },
+    {
+      "if" : {
+        "required" : [
+          "q"
+        ],
+        "properties" : {
+          "q" : {
+            "const" : "undefined"
+          }
+        }
+      },
+      "then" : {
+        "s" : {
+          "type" : "null"
+        }
+      },
+      "else" : {
+        "allOf" : [
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "color"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "description" : "Color of lamp",
+                  "type" : "string",
+                  "enum" : [
+                    "green",
+                    "red",
+                    "yellow"
+                  ]
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  ]
+}

data/schemas/tlc/1.2/alarms/A0301.json

@@ -0,0 +1,132 @@
+{
+  "description" : "Detector error (hardware).\nIs a \"minor fault\" defined according to 3.11 in EN12675.",
+  "allOf" : [
+    {
+      "properties" : {
+        "n" : {
+          "enum" : [
+            "detector",
+            "errormode",
+            "manual",
+            "type"
+          ]
+        }
+      }
+    },
+    {
+      "if" : {
+        "required" : [
+          "q"
+        ],
+        "properties" : {
+          "q" : {
+            "const" : "undefined"
+          }
+        }
+      },
+      "then" : {
+        "s" : {
+          "type" : "null"
+        }
+      },
+      "else" : {
+        "allOf" : [
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "detector"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "description" : "Designation of the detector (hardware)",
+                  "type" : "string"
+                }
+              }
+            }
+          },
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "type"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "description" : "Type of detector",
+                  "type" : "string",
+                  "enum" : [
+                    "input",
+                    "loop"
+                  ]
+                }
+              }
+            }
+          },
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "errormode"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "description" : "Detector forced on/off while detector error",
+                  "type" : "string",
+                  "enum" : [
+                    "off",
+                    "on"
+                  ]
+                }
+              }
+            }
+          },
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "manual"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "allOf" : [
+                    {
+                      "description" : "Manually controlled detector logic (True/False)"
+                    },
+                    {
+                      "$ref" : "../../../core/3.1.2/definitions.json#/boolean"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  ]
+}