Sensor and meter data models

smart-data-models · May 7, 2023 · c3533a7 · c3533a7
1 parent 7b67982
commit c3533a7
Show file tree

Hide file tree

Showing 18 changed files with 2,887 additions and 0 deletions.
diff --git a/CONTRIBUTORS.yaml b/CONTRIBUTORS.yaml
@@ -0,0 +1,10 @@
+description: This is a compilation list of all CONTRIBUTORS across different objects (data models) alphabetically ordered. All fields are non mandatory
+contributors:
+-
+ name:
+ surname:
+ mail:
+ organization:
+ project:
+ comments:
+ year:
diff --git a/Meter/ADOPTERS.yaml b/Meter/ADOPTERS.yaml
@@ -0,0 +1,18 @@
+description: This is a compilation list of the current adopters of the data model Meter of the Subject dataModel.SREF.
+currentAdopters:
+-
+ adopter: KMD A/S
+ description: Models are used to represent a digital twin of the building
+ mail: [email protected]; [email protected]
+ organization: 
+ project: Twin4Build - A holistic Digital Twin platform for decision-making support over the whole building life cycle 
+ comments: 
+ startDate: 2022-09-01
+-
+ adopter: University of Southern Denmark
+ description: Models are used to represent a digital twin of the building
+ mail: [email protected]; [email protected]
+ organization: 
+ project: Twin4Build - A holistic Digital Twin platform for decision-making support over the whole building life cycle 
+ comments: 
+ startDate: 2022-09-01
diff --git a/Meter/examples/example-normalized.json b/Meter/examples/example-normalized.json
@@ -0,0 +1,73 @@
+{
+  "id": "urn:ngsi-ld:Meter:d22ab4ee-d495-47d9-bf91-4040a9f1e437",
+  "type": "Meter",
+  "hasMeterReading": {
+    "type": "Measurement",
+    "value": 0.1692820780421772
+  },
+  "hasMeterReadingType": {
+    "type": "MeterHasMeterReadingType",
+    "value": "Coal"
+  },
+  "hasManufacturer": {
+    "type": "Text",
+    "value": "Meter Company Inc."
+  },
+  "hasModel": {
+    "type": "Text",
+    "value": "Meter 0.1.2"
+  },
+  "isContainedInBuildingSpace": {
+    "type": "URL",
+    "value": "urn:ngsi-ld:BuildingSpace:4d607bea-f506-477d-b3e4-35d8293d7738"
+  },
+  "isContainedInPhysicalObject": {
+    "type": "URL",
+    "value": "urn:ngsi-ld:PhysicalObject:dba2b9c7-0db0-44ba-bd5b-c3d29594bede"
+  },
+  "isSubSystemOf": {
+    "type": "array",
+    "value": [
+      {
+        "type": "URL",
+        "value": "urn:ngsi-ld:System:4bd5e430-e4cb-4e30-a518-2b03107c4f21"
+      },
+      {
+        "type": "URL",
+        "value": "urn:ngsi-ld:System:0c935447-3415-44d5-a9c8-1f48439f55d6"
+      },
+      {
+        "type": "URL",
+        "value": "urn:ngsi-ld:System:58888147-d89b-4d4b-a6fb-515f75932ccc"
+      }
+    ]
+  },
+  "dateCreated": {
+    "type": "DateTime",
+    "value": "2023-01-25T23:06:00.1423439+01:00"
+  },
+  "dateModified": {
+    "type": "DateTime",
+    "value": "2023-01-26T06:13:15.9747331+01:00"
+  },
+  "source": {
+    "type": "Text",
+    "value": "Import"
+  },
+  "name": {
+    "type": "Text",
+    "value": "Meter"
+  },
+  "alternateName": {
+    "type": "Text",
+    "value": "Meter type 2"
+  },
+  "description": {
+    "type": "Text",
+    "value": "Meter of limited Meter types"
+  },
+  "dataProvider": {
+    "type": "Text",
+    "value": "IFC file"
+  }
+}
diff --git a/Meter/examples/example-normalized.jsonld b/Meter/examples/example-normalized.jsonld
@@ -0,0 +1,76 @@
+{
+  "id": "urn:ngsi-ld:Meter:e653c629-dd05-45f0-8949-1b72927b3805",
+  "type": "Meter",
+  "hasMeterReading": {
+    "type": "Property",
+    "unitCode": "NA",
+    "observedAt": "2023-01-26T14:05:57Z",
+    "value": 0.2858275914845758
+  },
+  "hasMeterReadingType": {
+    "type": "Property",
+    "value": "Smoke"
+  },
+  "hasManufacturer": {
+    "type": "Property",
+    "value": "Meter Company Inc."
+  },
+  "hasModel": {
+    "type": "Property",
+    "value": "Meter 0.1.2"
+  },
+  "isContainedInBuildingSpace": {
+    "type": "Relationship",
+    "object": "urn:ngsi-ld:BuildingSpace:3c7f35e1-9d96-4584-bee3-282830581524"
+  },
+  "isContainedInPhysicalObject": {
+    "type": "Relationship",
+    "object": "urn:ngsi-ld:PhysicalObject:ee8b7910-fbc2-4a0f-8689-b37a0f373265"
+  },
+  "isSubSystemOf": [
+    {
+      "type": "Relationship",
+      "object": "urn:ngsi-ld:System:9b595557-65c4-4ce2-98d5-3b26cf43c236"
+    },
+    {
+      "type": "Relationship",
+      "object": "urn:ngsi-ld:System:18f7f604-ec80-4556-8674-3bf94037843d"
+    },
+    {
+      "type": "Relationship",
+      "object": "urn:ngsi-ld:System:8b5dac28-26c9-4f3f-bdd7-f5e1288c71bc"
+    }
+  ],
+  "dateCreated": {
+    "type": "Property",
+    "value": "2023-01-26T06:13:46Z"
+  },
+  "dateModified": {
+    "type": "Property",
+    "value": "2023-01-25T17:40:16Z"
+  },
+  "source": {
+    "type": "Property",
+    "value": "Import"
+  },
+  "name": {
+    "type": "Property",
+    "value": "Meter"
+  },
+  "alternateName": {
+    "type": "Property",
+    "value": "Meter type 2"
+  },
+  "description": {
+    "type": "Property",
+    "value": "Meter of limited Meter types"
+  },
+  "dataProvider": {
+    "type": "Property",
+    "value": "IFC file"
+  },
+  "@context": [
+    "https://raw.githubusercontent.com/smart-data-models/dataModel.SAREF/master/context.jsonld",
+    "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
+  ]
+}
diff --git a/Meter/examples/example.json b/Meter/examples/example.json
@@ -0,0 +1,22 @@
+{
+  "id": "urn:ngsi-ld:Meter:0dde3ab1-8d7f-400b-9fae-29a6d8db52a0",
+  "type": "Meter",
+  "hasMeterReading": 0.8038490157762914,
+  "hasMeterReadingType": "Humidity",
+  "hasManufacturer": "Meter Company Inc.",
+  "hasModel": "Meter 0.1.2",
+  "isContainedInBuildingSpace": "urn:ngsi-ld:BuildingSpace:b05a842e-2dab-4f8e-91d8-dddf6c9d7a08",
+  "isContainedInPhysicalObject": "urn:ngsi-ld:PhysicalObject:7d7e30d7-230d-445e-847e-d56a8bfe769a",
+  "isSubSystemOf": [
+    "urn:ngsi-ld:System:d21bd703-9e2e-4fdc-a513-3e03580ad18e",
+    "urn:ngsi-ld:System:0bf297bb-2527-4926-ba9e-5b5f65834c5b",
+    "urn:ngsi-ld:System:b2ed4c1a-f7d8-42b0-9555-2738ce9c80f6"
+  ],
+  "dateCreated": "2023-01-26T09:50:53Z",
+  "dateModified": "2023-01-25T18:14:39Z",
+  "source": "Import",
+  "name": "Meter",
+  "alternateName": "Meter type 2",
+  "description": "Meter of limited Meter types",
+  "dataProvider": "IFC file"
+}
diff --git a/Meter/examples/example.jsonld b/Meter/examples/example.jsonld
@@ -0,0 +1,26 @@
+{
+  "id": "urn:ngsi-ld:Meter:ee807196-0895-456c-a9cd-a0ce754c9a7d",
+  "type": "Meter",
+  "hasMeterReading": 0.3234784413713925,
+  "hasMeterReadingType": "Energy",
+  "hasManufacturer": "Meter Company Inc.",
+  "hasModel": "Meter 0.1.2",
+  "isContainedInBuildingSpace": "urn:ngsi-ld:BuildingSpace:b1d0f425-0713-4fcf-98e1-fdadce1b4297",
+  "isContainedInPhysicalObject": "urn:ngsi-ld:PhysicalObject:c27bac88-f5cd-4156-8b21-118666a981ed",
+  "isSubSystemOf": [
+    "urn:ngsi-ld:System:801be713-b55a-4d20-97c0-f57a0324d1c9",
+    "urn:ngsi-ld:System:780cc615-6169-4896-a969-6619abde8228",
+    "urn:ngsi-ld:System:e85eb619-4cec-4bdd-b2c8-d1899b4f2033"
+  ],
+  "dateCreated": "2023-01-26T05:05:25Z",
+  "dateModified": "2023-01-25T19:26:04Z",
+  "source": "Import",
+  "name": "Meter",
+  "alternateName": "Meter type 2",
+  "description": "Meter of limited Meter types",
+  "dataProvider": "IFC file",
+  "@context": [
+    "https://raw.githubusercontent.com/smart-data-models/dataModel.SAREF/master/context.jsonld",
+    "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
+  ]
+}
diff --git a/Meter/notes.yaml b/Meter/notes.yaml
@@ -0,0 +1,5 @@
+notesHeader:
+
+notesFooter:
+
+notesMiddle:
diff --git a/Meter/schema.json b/Meter/schema.json
@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/schema#",
+  "$schemaVersion": "0.0.1",
+  "modelTags": "SAREF Meter",
+  "$id": "https://smart-data-models.github.com/dataModel.SAREF/Meter/schema.json",
+  "derivedFrom": "https://saref.etsi.org/core/v3.1.1/#saref:Meter",
+  "title": "Smart data models - Meter schema",
+  "type": "object",
+  "license": "https://opensource.org/licenses/BSD-3-Clause",
+  "description": "A device built to accurately detect and display a quantity in a form readable by a human being. Further, a device of category saref:Meter that performs a saref:MeteringFunction.",
+  "allOf": [
+    {
+      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons"
+    },
+    {
+      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons"
+    },
+    {
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "Property. It must be equal to `Meter`.",
+          "enum": [
+            "Meter"
+          ]
+        },
+        "hasMeterReading": {
+          "$ref": "https://raw.githubusercontent.com/smart-data-models/dataModel.SAREF/master/SAREF-schema.json#/definitions/Measurement",
+          "description": "Property. A relationship between a metering function and the measurement of the reading"
+        },
+        "hasMeterReadingType": {
+          "type": "string",
+          "description": "Property. A relationship identifying the reading type of a metering function (e.g., Water, Gas, Pressure , Energy , Power, etc.)",
+          "enum": [
+            "Coal",
+            "Electricity",
+            "Energy",
+            "Gas",
+            "Humidity",
+            "Light",
+            "Motion",
+            "Occupancy",
+            "Power",
+            "Pressure",
+            "Price",
+            "Smoke",
+            "Temperature",
+            "Water"
+          ]
+        },
+        "hasManufacturer": {
+          "type": "string",
+          "description": "Property. A relationship identifying the manufacturer of an entity (e.g., device). The value is expected to be a string or a string with language tag."
+        },
+        "hasModel": {
+          "type": "string",
+          "description": "Property. A relationship identifying the model of an entity (e.g., device). The value is expected to be a string or a string with language tag."
+        },
+        "isContainedInBuildingSpace": {
+          "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/EntityIdentifierType",
+          "description": "Relationship. An entity used to define the physical spaces of the building. A building space contains devices or building objects. (BuildingSpace)"
+        },
+        "isContainedInPhysicalObject": {
+          "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/EntityIdentifierType",
+          "description": "Relationship. Any Object that has a proper space region. (Definition extracted from DUL ontology) (PhysicalObject)"
+        },
+        "isSubSystemOf": {
+          "type": "array",
+          "description": "Relationship. A reference to a system(s) that this Physical Object is part of.",
+          "items": {
+            "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/EntityIdentifierType",
+            "description": "Relationship. The class of systems, i.e., systems virtually isolated from the environment, whose behaviour and interactions with the environment are modeled. Systems can be connected to other systems. Connected systems interact in some ways. Systems can also have subsystems. Properties of subsystems somehow contribute to the properties of the supersystem. (System)"
+          }
+        }
+      }
+    }
+  ],
+  "required": [
+    "id",
+    "type"
+  ]
+}
diff --git a/SAREF-schema.json b/SAREF-schema.json
@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/schema#",
+  "$id": "https://smart-data-models.github.com/dataModel.SAREF/commons",
+  "title": "Common definitions for SAREF for buildings",
+  "definitions": {
+    "Measurement": {
+      "type": "number",
+      "description": "Property. Represents the measured value made over a property. It is also linked to the unit of measure in which the value is expressed and the timestamp of the measurement."
+    },
+    "PhysicalObject": {
+      "type": "object",
+      "description": "Any Object that has a proper space region.  (Definition extracted from DUL ontology)",
+      "allOf": [
+        {
+          "properties": {
+            "type": {
+              "type": "string",
+              "description": "Property. It must be equal to `PhysicalObject`.",
+              "enum": [
+                "PhysicalObject"
+              ]
+            },
+            "isContainedInBuildingSpace": {
+              "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/EntityIdentifierType",
+              "description": "Relationship. An entity used to define the physical spaces of the building. A building space contains devices or building objects. (BuildingSpace)"
+            },
+            "isContainedInPhysicalObject": {
+              "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/EntityIdentifierType",
+              "description": "Relationship. Any Object that has a proper space region.  (Definition extracted from DUL ontology) (PhysicalObject)"
+            },
+            "isSubSystemOf": {
+              "type": "array",
+              "description": "Relationship. A reference to a system(s) that this Physical Object is part of.",
+              "items": {
+                "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/EntityIdentifierType",
+                "description": "Relationship. The class of systems, i.e., systems virtually isolated from the environment, whose behaviour and interactions with the environment are modeled. Systems can be connected to other systems. Connected systems interact in some ways. Systems can also have subsystems. Properties of subsystems somehow contribute to the properties of the supersystem. (System)"
+              }
+            }
+          }
+        }
+      ]
+    }
+  }
+}
diff --git a/Sensor/ADOPTERS.yaml b/Sensor/ADOPTERS.yaml
@@ -0,0 +1,18 @@
+description: This is a compilation list of the current adopters of the data model Sensor of the Subject dataModel.SAREF.
+currentAdopters:
+-
+ adopter: KMD A/S
+ description: Models are used to represent a digital twin of the building
+ mail: [email protected]; [email protected]
+ organization: 
+ project: Twin4Build - A holistic Digital Twin platform for decision-making support over the whole building life cycle 
+ comments: 
+ startDate: 2022-09-01
+-
+ adopter: University of Southern Denmark
+ description: Models are used to represent a digital twin of the building
+ mail: [email protected]; [email protected]
+ organization: 
+ project: Twin4Build - A holistic Digital Twin platform for decision-making support over the whole building life cycle 
+ comments: 
+ startDate: 2022-09-01