Adding instance property to the eventOriginObject, updating examples.

iolinkcommunity · Jan 9, 2025 · bbb65ed · bbb65ed
1 parent 5b4b933
commit bbb65ed
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/JSON_for_IO-Link.yaml b/JSON_for_IO-Link.yaml
@@ -477,6 +477,7 @@ paths:
                       origin:
                         masterNumber: 1
                         portNumber: 1
+                        instance: "APPLICATION"
                       message:
                         code: 6163
                         mode: APPEARS
@@ -487,6 +488,7 @@ paths:
                         masterNumber: 1
                         portNumber: 1
                         deviceAlias: Temp_sensor_1
+                        instance: "APPLICATION"
                       message:
                         code: 16912
                         mode: APPEARS
@@ -506,6 +508,7 @@ paths:
                       origin:
                         masterNumber: 1
                         port: 1
+                        instance: "APPLICATION"
                       message:
                         code: 6163
                         mode: APPEARS
@@ -515,6 +518,7 @@ paths:
                       origin:
                         masterNumber: 1
                         portNumber: 1
+                        instance: "APPLICATION"
                       message:
                         code: 6163
                         mode: DISAPPEARS
@@ -524,6 +528,7 @@ paths:
                       origin:
                         masterNumber: 1
                         portNumber: 2
+                        instance: "SYSTEM"
                       message:
                         code: 65313
                         mode: SINGLESHOT
@@ -536,6 +541,7 @@ paths:
                         masterNumber: 1
                         portNumber: 1
                         deviceAlias: Temp_sensor_1
+                        instance: "APPLICATION"
                       message:
                         code: 16912
                         mode: APPEARS
@@ -546,6 +552,7 @@ paths:
                         masterNumber: 1
                         portNumber: 3
                         deviceAlias: Distance_Laser_3
+                        instance: "APPLICATION"
                       message:
                         code: 20480
                         mode: APPEARS

diff --git a/schemas.yaml b/schemas.yaml
@@ -314,6 +314,15 @@ schemas:
       - NOTICE
       - INFO
       - DEBUG
+  eventInstance:
+    description: >- 
+      Indicate the particular source (instance) of an Events. The IO-Link Instance
+      Unknown maps to UNKNOWN, Reserved to UNKNOWN, Application to APPLICATION, and System to SYSTEM.
+    type: string
+    enum:
+      - UNKNOWN
+      - APPLICATION
+      - SYSTEM
   eventOriginObject:
     type: object
     properties:
@@ -332,6 +341,11 @@ schemas:
         $ref: "#/schemas/portNumber"
       deviceAlias:
         $ref: "#/schemas/deviceAlias"
+      instance:
+        description: >-
+          This property is mandatory for IO-Link Port Events and IO-Link
+          Device Events. Should not be used for other log entries.
+        $ref: "#/schemas/eventInstance"
   eventObject:
     type: object
     properties:
@@ -461,6 +475,7 @@ schemas:
             - master
             - port
             - deviceAlias
+            - instance
           allOf:
             - $ref: "#/schemas/eventOriginObject"
         message:
@@ -476,6 +491,7 @@ schemas:
           master: 1
           port: 1
           deviceAlias: Temperature_sensor_1
+          instance: "APPLICATION"
         message:
           code: 16912
           mode: APPEARS