Proposal to add properties and relationships to Alarm, Event, and Exc…

…eptionEvent.
RealEstateCore · Nov 9, 2023 · 37355ed · 37355ed
1 parent 6b50537
commit 37355ed
Show file tree

Hide file tree

Showing 3 changed files with 132 additions and 1 deletion.
diff --git a/Source/DTDLv2/Brick/Point/Alarm/Alarm.json b/Source/DTDLv2/Brick/Point/Alarm/Alarm.json
@@ -9,6 +9,19 @@
       },
       "name": "lastKnownValue",
       "schema": "dtmi:org:w3id:rec:ExceptionEvent;1"
+    },
+    {
+      "@type": "Relationship",
+      "description": {
+        "en": "The brick:Point that emitted this exception."
+      },
+      "displayName": {
+        "en": "source point"
+      },
+      "maxMultiplicity": 1,
+      "name": "sourcePoint",
+      "target": "dtmi:org:brickschema:schema:Brick:Point;1",
+      "writable": true
     }
   ],
   "description": {

diff --git a/Source/DTDLv2/RealEstateCore/Event/Event.json b/Source/DTDLv2/RealEstateCore/Event/Event.json
@@ -62,6 +62,18 @@
       "schema": "dateTime",
       "writable": true
     },
+    {
+      "@type": "Property",
+      "displayName": {
+        "en": "Event Identifier"
+      },
+      "description": {
+        "en": "Some events (like exception events) generate a unique identifier to enable traceability and management of the event through it's lifecycle."
+      },
+      "name": "eventIdentifier",
+      "schema": "string",
+      "writable": true
+    },
     {
       "@type": "Property",
       "displayName": {
@@ -90,6 +102,18 @@
       "schema": "string",
       "writable": true
     },
+    {
+      "@type": "Property",
+      "displayName": {
+        "en": "Priority"
+      },
+      "description": {
+        "en": "Reflect the importance or urgency of the event. Determines the order in which the system or the operators should address the event."
+      },
+      "name": "priority",
+      "schema": "integer",
+      "writable": true
+    },
     {
       "@type": "Property",
       "description": {

diff --git a/Source/DTDLv2/RealEstateCore/Event/Point-/ExceptionEvent.json b/Source/DTDLv2/RealEstateCore/Event/Point-/ExceptionEvent.json
@@ -2,6 +2,100 @@
   "@id": "dtmi:org:w3id:rec:ExceptionEvent;1",
   "@type": "Interface",
   "contents": [
+    {
+      "@type": "Property",
+      "description": {
+        "en": "The previous state of the event."
+      },
+      "displayName": {
+        "en": "from state"
+      },
+      "name": "fromState",
+      "schema": {
+        "@type": "Enum",
+        "valueSchema": "integer",
+        "enumValues": [
+          {
+            "name": "normal",
+            "displayName": "Normal",
+            "enumValue": 0
+          },
+          {
+            "name": "fault",
+            "displayName": "Fault",
+            "enumValue": 1
+          },
+          {
+            "name": "offnormal",
+            "displayName": "Offnormal",
+            "enumValue": 2
+          },
+          {
+            "name": "highLimit",
+            "displayName": "High Limit",
+            "enumValue": 3
+          },
+          {
+            "name": "lowLimit",
+            "displayName": "Low Limit",
+            "enumValue": 4
+          },
+          {
+            "name": "lifeSafetyAlarm",
+            "displayName": "Life Safety Alarm",
+            "enumValue": 5
+          }
+        ]
+      },
+      "writable": true
+    },
+    {
+      "@type": "Property",
+      "description": {
+        "en": "The current state of the event."
+      },
+      "displayName": {
+        "en": "to state"
+      },
+      "name": "toState",
+      "schema": {
+        "@type": "Enum",
+        "valueSchema": "integer",
+        "enumValues": [
+          {
+            "name": "normal",
+            "displayName": "Normal",
+            "enumValue": 0
+          },
+          {
+            "name": "fault",
+            "displayName": "Fault",
+            "enumValue": 1
+          },
+          {
+            "name": "offnormal",
+            "displayName": "Offnormal",
+            "enumValue": 2
+          },
+          {
+            "name": "highLimit",
+            "displayName": "High Limit",
+            "enumValue": 3
+          },
+          {
+            "name": "lowLimit",
+            "displayName": "Low Limit",
+            "enumValue": 4
+          },
+          {
+            "name": "lifeSafetyAlarm",
+            "displayName": "Life Safety Alarm",
+            "enumValue": 5
+          }
+        ]
+      },
+      "writable": true
+    },
     {
       "@type": "Property",
       "description": {
@@ -17,7 +111,7 @@
     {
       "@type": "Relationship",
       "description": {
-        "en": "The brick:Point that emitted this exception."
+        "en": "The brick:Point that emitted this observation."
       },
       "displayName": {
         "en": "source point"