Continued work on entity properties

OpenAPI/openapi.yml

@@ -67,6 +67,11 @@ paths:
     $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Name'
   /OBJ-LSM/OBJ-Entities/{uuid}/PAR-Type/:
     $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Type'
+  /OBJ-LSM/OBJ-Entities/{uuid}/VAR-Orientation/:
+    $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/VAR-Orientation'
+  /OBJ-LSM/OBJ-Entities/{uuid}/VAR-Position/:
+    $ref: 'paths/index.yml#/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/VAR-Position'
+
 
 components:
   schemas:

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Calibration.yml

@@ -3,6 +3,11 @@ description: >
 
   Retrieve a unique calibration string identifying a corresponding certificate.  
 
+    
+
+  This is a *read-only* parameter.
+
+
 get:
   tags:
     - Entity

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-State.yml

@@ -8,6 +8,8 @@ description: >
     * `ERROR`: There is an error which is critical to operation.
     * `MAINTENANCE`: The system ist currently down for a scheduled maintenance operation.  
 
+    
+
   This is a *read-only* parameter.
 get:
   tags:

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/PAR-Type.yml

@@ -4,6 +4,8 @@ description: >
   System-specific identifier of the target type, e.g. SMR-1.5inch.
   The type is not further standardized.  
 
+    
+
   This is a *read-only* parameter.
 
 get:

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/VAR-Orientation.yml

+description: >
+  **Orientation**  
+
+  Current orientation (i.e. last measurement) of the mobile entity.
+  This value should only be different to *null* if the entity is actually capable 
+  of measuring the orientation. The same holds for the covariance estimate.  
+
+  Quaternions have been chosen to unambiguously express orientation across conventions.  
+
+    
+
+  **MQTT**: The updates of this value shall also be published via MQTT using 
+  the same JSON representation. Hence they may also be consumed via MQTT and its websocket
+  extension in the corresponding applications.
+get:
+  tags:
+    - Entity
+  description:
+    $ref: '#/description'
+  parameters:
+    - $ref: '../../../../../parameters/index.yml#/OBJ-Entity-uuid'  
+  responses:
+    '200':
+      description: >
+        **OK**  
+
+        Everything occurred as expected.
+      content:
+        application/json:
+          schema: 
+            $ref: '../../../../../schemas/index.yml#/Variable'
+          example:
+            uuid: PAR-Orientation
+            name: Orientation
+            description: Current orientation of the mobile entity expressed as quaternion.
+            ontology: null
+            datatype: double
+            dimension: [4]
+            unit: C62
+            range: []
+            value: [0.02357738, 0.09441385, 0.21169921, 0.97247806]
+            covariance: [
+                          [9.635354886031938e-06, 0.0004436033096059594, 0.00016144081411989793, 0.0001699398949338537],
+                          [0.0004436033096059594, 0.0002922712707392062, 9.709317499541933e-05, 0.00018066604301265513],
+                          [0.00016144081411989793, 9.709317499541933e-05, 2.1450372592198085e-05, 0.00019699186912319554],
+                          [0.0001699398949338537, 0.00018066604301265513, 0.00019699186912319554, 1.645440660862675e-05]
+                        ]
+            timestamp: "2022-02-01T17:00:01.352916Z"
+    '500':
+      $ref: "../../../../../responses/index.yml#/InternalError"
+
+options:
+  tags:
+    - Entity
+  description:
+    $ref: '#/description'
+  parameters:
+    - $ref: '../../../../../parameters/index.yml#/OBJ-Entity-uuid'  
+  responses:
+    '200':
+      description: >
+        **OK**  
+
+        Everything occurred as expected.
+      content:
+        application/json:
+          schema: 
+            $ref: '../../../../../schemas/index.yml#/Variable'
+          example:
+            uuid: PAR-Orientation
+            name: Orientation
+            description: Current orientation of the mobile entity expressed as quaternion.
+            ontology: null
+            datatype: double
+            dimension: [4]
+            unit: C62
+            range: []
+            value: null
+            covariance: null
+            timestamp: null
+    '500':
+      $ref: "../../../../../responses/index.yml#/InternalError"
+    '501':
+      $ref: "../../../../../responses/index.yml#/NotImplemented"
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/VAR-Position.yml

+description: >
+  **Position**  
+
+  Current Position (i.e. last measurement) of the mobile entity.
+  This is the core value of interest for Large-Scale Metrology systems. 
+  The value is expected to be in MTR (not implicated by SOIL, but lowering overhead for others). 
+
+     
+
+  **MQTT**: The updates of this value shall also be published via MQTT using 
+  the same JSON representation. Hence they may also be consumed via MQTT and its websocket
+  extension in the corresponding applications.
+get:
+  tags:
+    - Entity
+  description:
+    $ref: '#/description'
+  parameters:
+    - $ref: '../../../../../parameters/index.yml#/OBJ-Entity-uuid'  
+  responses:
+    '200':
+      description: >
+        **OK**  
+
+        Everything occurred as expected.
+      content:
+        application/json:
+          schema: 
+            $ref: '../../../../../schemas/index.yml#/Variable'
+          example:
+            uuid: VAR-Position
+            name: Position [m]
+            description: Current position of the mobile entity.
+            ontology: null
+            datatype: double
+            dimension: [3]
+            unit: MTR
+            range: []
+            value: [3.123, 4.221, 1.522]
+            covariance: [
+                          [0.04074968380933543, 0.081224742424419, 0.0146097707717761],
+                          [0.081224742424419, 0.11810662674797013, 0.01641245412362838],
+                          [0.0146097707717761, 0.01641245412362838, 0.11144618705511516]
+                        ]
+            timestamp: "2022-02-01T17:00:01.352916Z"
+    '500':
+      $ref: "../../../../../responses/index.yml#/InternalError"
+
+options:
+  tags:
+    - Entity
+  description:
+    $ref: '#/description'
+  parameters:
+    - $ref: '../../../../../parameters/index.yml#/OBJ-Entity-uuid'  
+  responses:
+    '200':
+      description: >
+        **OK**  
+
+        Everything occurred as expected.
+      content:
+        application/json:
+          schema: 
+            $ref: '../../../../../schemas/index.yml#/Variable'
+          example:
+            uuid: VAR-Position
+            name: Position [m]
+            description: Current position of the mobile entity.
+            ontology: null
+            datatype: double
+            dimension: [3]
+            unit: MTR
+            range: []
+            value: null
+            covariance: null
+            timestamp: null
+    '500':
+      $ref: "../../../../../responses/index.yml#/InternalError"
+    '501':
+      $ref: "../../../../../responses/index.yml#/NotImplemented"
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/OBJ-Entities/OBJ-Entity/index.yml

@@ -12,3 +12,7 @@ PAR-Name:
   $ref: 'PAR-Name.yml'
 PAR-Type:
   $ref: 'PAR-Type.yml'
+VAR-Orientation:
+  $ref: 'VAR-Position.yml'
+VAR-Position:
+  $ref: 'VAR-Position.yml'
\ No newline at end of file

OpenAPI/paths/OBJ-ROOT/OBJ-LSM/PAR-Calibration.yml

@@ -3,6 +3,9 @@ description: >
 
   Retrieve a unique calibration string identifying a corresponding certificate.  
 
+    
+
+  This is a *read-only* parameter.
 get:
   tags:
     - LSM

OpenAPI/paths/OBJ-ROOT/PAR-Manufacturer.yml

@@ -2,6 +2,11 @@ description: >
   **Manufacturer**  
 
   String identifying the manufacturer of the device.  
+
+    
+
+  This is a *read-only* parameter.
+
 get:
   tags:
     - Root

OpenAPI/paths/OBJ-ROOT/PAR-State.yml

@@ -8,6 +8,8 @@ description: >
     * `ERROR`: There is an error which is critical to operation.
     * `MAINTENANCE`: The system ist currently down for a scheduled maintenance operation.  
 
+    
+
   This is a *read-only* parameter.
 get:
   tags:

OpenAPI/paths/OBJ-ROOT/PAR-Time.yml

@@ -4,6 +4,11 @@ description: >
   Current system time. This is a convenience function for time inspection and not meant for 
   precise synchronization. If the latter is required, the system time should be synchronized
   at operating system level using an according time protocol.  
+
+    
+
+  This is a *read-only* parameter.
+
 get:
   tags:
     - Root

OpenAPI/paths/OBJ-ROOT/PAR-Version.yml

@@ -4,6 +4,11 @@ description: >
   Incremental version number of the device's and/or interface implementation,
   to allow for introducing and noting breaking changes. The timestamp may
   correspond to the release date.  
+
+    
+
+  This is a *read-only* parameter.
+
 get:
   tags:
     - Root