Update descriptors related to some of the feature sets (#28)

Author: cristian-recoseanu

code/package-lock.json

@@ -554,38 +554,6 @@ export class NcMethodResultId extends NcMethodResult
     }
 }
 
-export class NcMethodResultReceiverStatus extends NcMethodResult
-{
-    public value: NcReceiverStatus;
-
-    public constructor(
-        status: NcMethodStatus,
-        value: NcReceiverStatus)
-    {
-        super(status);
-
-        this.value = value;
-    }
-
-    public static override GetTypeDescriptor(includeInherited: boolean): NcDatatypeDescriptor
-    {
-        let currentClassDescriptor = new NcDatatypeDescriptorStruct("NcMethodResultReceiverStatus", [
-            new NcFieldDescriptor("value", "NcReceiverStatus", false, false, null, "Receiver status method result value")
-        ], "NcMethodResult", null, "Method result containing receiver status information as the value")
-
-        if(includeInherited)
-        {
-            let baseDescriptor = super.GetTypeDescriptor(includeInherited);
-
-            let baseDescriptorStruct = baseDescriptor as NcDatatypeDescriptorStruct;
-            if(baseDescriptorStruct)
-                currentClassDescriptor.fields = currentClassDescriptor.fields.concat(baseDescriptorStruct.fields);
-        }
-
-        return currentClassDescriptor;
-    }
-}
-
 export class NcMethodResultBlockMemberDescriptors extends NcMethodResult
 {
     public value: NcBlockMemberDescriptor[];

code/src/NCModel/Core.ts

@@ -392,6 +392,98 @@ export class NcGain extends NcActuator
     }
 }
 
+export class NcLevelSensor extends NcSensor
+{
+    public static staticClassID: number[] = [ 1, 2, 1, 2, 1 ];
+
+    @myIdDecorator('1p1')
+    public override classID: number[] = NcLevelSensor.staticClassID;
+
+    @myIdDecorator('5p1')
+    public reading: number;
+
+    public constructor(
+        oid: number,
+        constantOid: boolean,
+        owner: number | null,
+        role: string,
+        userLabel: string,
+        touchpoints: NcTouchpoint[],
+        runtimePropertyConstraints: NcPropertyConstraints[] | null,
+        enabled: boolean,
+        ports: NcPort[] | null,
+        latency: number | null,
+        reading: number,
+        description: string,
+        notificationContext: INotificationContext)
+    {
+        super(oid, constantOid, owner, role, userLabel, touchpoints, runtimePropertyConstraints, enabled, ports, latency, description, notificationContext);
+
+        this.reading = reading;
+    }
+
+    //'1m1'
+    public override Get(oid: number, propertyId: NcElementId, handle: number) : CommandResponseNoValue
+    {
+        if(oid == this.oid)
+        {
+            let key: string = `${propertyId.level}p${propertyId.index}`;
+
+            switch(key)
+            {
+                case '5p1':
+                    return new CommandResponseWithValue(handle, NcMethodStatus.OK, this.reading);
+                default:
+                    return super.Get(oid, propertyId, handle);
+            }
+        }
+
+        return new CommandResponseError(handle, NcMethodStatus.InvalidRequest, 'OID could not be found');
+    }
+
+    //'1m2'
+    public override Set(oid: number, id: NcElementId, value: any, handle: number) : CommandResponseNoValue
+    {
+        if(oid == this.oid)
+        {
+            let key: string = `${id.level}p${id.index}`;
+
+            switch(key)
+            {
+                case '5p1':
+                    return new CommandResponseError(handle, NcMethodStatus.Readonly, 'Property is readonly');
+                default:
+                    return super.Set(oid, id, value, handle);
+            }
+        }
+
+        return new CommandResponseError(handle, NcMethodStatus.InvalidRequest, 'OID could not be found');
+    }
+
+    public static override GetClassDescriptor(includeInherited: boolean): NcClassDescriptor 
+    {
+        let currentClassDescriptor = new NcClassDescriptor(`${NcLevelSensor.name} class descriptor`,
+            NcLevelSensor.staticClassID, NcLevelSensor.name, null,
+            [
+                new NcPropertyDescriptor(new NcElementId(5, 1), "reading", "NcDB", true, false, false, false, null, "Level sensor reading in DB")
+            ],
+            [],
+            []
+        );
+
+        if(includeInherited)
+        {
+            let baseDescriptor = super.GetClassDescriptor(includeInherited);
+
+            currentClassDescriptor.properties = currentClassDescriptor.properties.concat(baseDescriptor.properties);
+            currentClassDescriptor.methods = currentClassDescriptor.methods.concat(baseDescriptor.methods);
+            currentClassDescriptor.events = currentClassDescriptor.events.concat(baseDescriptor.events);
+        }
+
+        return currentClassDescriptor;
+    }
+}
+
 export class NcIdentBeacon extends NcWorker
 {
     public static staticClassID: number[] = [ 1, 2, 2 ];
@@ -640,18 +732,122 @@ export class NcReceiverMonitor extends NcWorker
         return new CommandResponseError(handle, NcMethodStatus.InvalidRequest, 'OID could not be found');
     }
 
-    public override InvokeMethod(socket: WebSocketConnection, oid: number, methodId: NcElementId, args: { [key: string]: any; } | null, handle: number): CommandResponseNoValue 
+    public static override GetClassDescriptor(includeInherited: boolean): NcClassDescriptor 
+    {
+        let currentClassDescriptor = new NcClassDescriptor(`${NcReceiverMonitor.name} class descriptor`,
+            NcReceiverMonitor.staticClassID, NcReceiverMonitor.name, null,
+            [
+                new NcPropertyDescriptor(new NcElementId(3, 1), "connectionStatus", "NcConnectionStatus", true, false, false, false, null, "Connection status property"),
+                new NcPropertyDescriptor(new NcElementId(3, 2), "connectionStatusMessage", "NcString", true, false, true, false, null, "Connection status message property"),
+                new NcPropertyDescriptor(new NcElementId(3, 3), "payloadStatus", "NcPayloadStatus", true, false, false, false, null, "Payload status property"),
+                new NcPropertyDescriptor(new NcElementId(3, 4), "payloadStatusMessage", "NcString", true, false, true, false, null, "Payload status message property")
+            ],
+            [],
+            []
+        );
+
+        if(includeInherited)
+        {
+            let baseDescriptor = super.GetClassDescriptor(includeInherited);
+
+            currentClassDescriptor.properties = currentClassDescriptor.properties.concat(baseDescriptor.properties);
+            currentClassDescriptor.methods = currentClassDescriptor.methods.concat(baseDescriptor.methods);
+            currentClassDescriptor.events = currentClassDescriptor.events.concat(baseDescriptor.events);
+        }
+
+        return currentClassDescriptor;
+    }
+}
+
+export class NcReceiverMonitorProtected extends NcReceiverMonitor
+{
+    public static staticClassID: number[] = [ 1, 2, 3, 1 ];
+
+    @myIdDecorator('1p1')
+    public override classID: number[] = NcReceiverMonitorProtected.staticClassID;
+
+    @myIdDecorator('4p1')
+    public signalProtectionStatus: boolean;
+
+    public constructor(
+        oid: number,
+        constantOid: boolean,
+        owner: number | null,
+        role: string,
+        userLabel: string,
+        touchpoints: NcTouchpoint[],
+        runtimePropertyConstraints: NcPropertyConstraints[] | null,
+        enabled: boolean,
+        description: string,
+        notificationContext: INotificationContext)
+    {
+        super(oid, constantOid, owner, role, userLabel, touchpoints, runtimePropertyConstraints, enabled, description, notificationContext);
+
+        this.connectionStatus = NcConnectionStatus.Undefined;
+        this.connectionStatusMessage = null;
+        
+        this.payloadStatus = NcPayloadStatus.Undefined;
+        this.payloadStatusMessage = null;
+
+        this.signalProtectionStatus = false;
+    }
+
+    public Connected()
+    {
+        this.connectionStatus = NcConnectionStatus.Connected;
+        this.payloadStatus = NcPayloadStatus.PayloadOK;
+
+        this.connectionStatusMessage = null;
+        this.payloadStatusMessage = null;
+
+        this.notificationContext.NotifyPropertyChanged(this.oid, new NcElementId(3, 1), NcPropertyChangeType.ValueChanged, this.connectionStatus, null);
+        this.notificationContext.NotifyPropertyChanged(this.oid, new NcElementId(3, 3), NcPropertyChangeType.ValueChanged, this.payloadStatus, null);
+    }
+
+    public Disconnected()
+    {
+        this.connectionStatus = NcConnectionStatus.Undefined;
+        this.payloadStatus = NcPayloadStatus.Undefined;
+
+        this.connectionStatusMessage = null;
+        this.payloadStatusMessage = null;
+
+        this.notificationContext.NotifyPropertyChanged(this.oid, new NcElementId(3, 1), NcPropertyChangeType.ValueChanged, this.connectionStatus, null);
+        this.notificationContext.NotifyPropertyChanged(this.oid, new NcElementId(3, 3), NcPropertyChangeType.ValueChanged, this.payloadStatus, null);
+    }
+
+    //'1m1'
+    public override Get(oid: number, id: NcElementId, handle: number) : CommandResponseNoValue
     {
         if(oid == this.oid)
         {
-            let key: string = `${methodId.level}m${methodId.index}`;
+            let key: string = `${id.level}p${id.index}`;
 
             switch(key)
             {
-                case '3m1':
-                    return new CommandResponseWithValue(handle, NcMethodStatus.OK, new NcReceiverStatus(this.connectionStatus, this.payloadStatus));
+                case '4p1':
+                    return new CommandResponseWithValue(handle, NcMethodStatus.OK, this.signalProtectionStatus);
                 default:
-                    return super.InvokeMethod(socket, oid, methodId, args, handle);
+                    return super.Get(oid, id, handle);
+            }
+        }
+
+        return new CommandResponseError(handle, NcMethodStatus.InvalidRequest, 'OID could not be found');
+    }
+
+    //'1m2'
+    public override Set(oid: number, id: NcElementId, value: any, handle: number) : CommandResponseNoValue
+    {
+        if(oid == this.oid)
+        {
+            let key: string = `${id.level}p${id.index}`;
+
+            switch(key)
+            {
+                case '4p1':
+                    return new CommandResponseError(handle, NcMethodStatus.Readonly, 'Property is readonly');
+                default:
+                    return super.Set(oid, id, value, handle);
             }
         }
 
@@ -660,17 +856,12 @@ export class NcReceiverMonitor extends NcWorker
 
     public static override GetClassDescriptor(includeInherited: boolean): NcClassDescriptor 
     {
-        let currentClassDescriptor = new NcClassDescriptor(`${NcReceiverMonitor.name} class descriptor`,
-            NcReceiverMonitor.staticClassID, NcReceiverMonitor.name, null,
-            [
-                new NcPropertyDescriptor(new NcElementId(3, 1), "connectionStatus", "NcConnectionStatus", true, false, false, false, null, "Connection status property"),
-                new NcPropertyDescriptor(new NcElementId(3, 2), "connectionStatusMessage", "NcString", true, false, true, false, null, "Connection status message property"),
-                new NcPropertyDescriptor(new NcElementId(3, 3), "payloadStatus", "NcPayloadStatus", true, false, false, false, null, "Payload status property"),
-                new NcPropertyDescriptor(new NcElementId(3, 4), "payloadStatusMessage", "NcString", true, false, true, false, null, "Payload status message property")
-            ],
+        let currentClassDescriptor = new NcClassDescriptor(`${NcReceiverMonitorProtected.name} class descriptor`,
+            NcReceiverMonitorProtected.staticClassID, NcReceiverMonitorProtected.name, null,
             [
-                new NcMethodDescriptor(new NcElementId(3, 1), "GetStatus", "NcMethodResultReceiverStatus", [], "Method to retrieve both connection status and payload status in one call")
+                new NcPropertyDescriptor(new NcElementId(4, 1), "signalProtectionStatus", "NcBoolean", true, false, false, false, null, "Indicates if signal protection is active"),
             ],
+            [],
             []
         );
 

code/src/NCModel/Features.ts

@@ -30,7 +30,6 @@ import {
     NcMethodResultError,
     NcMethodResultId,
     NcMethodResultPropertyValue,
-    NcMethodResultReceiverStatus,
     NcMethodStatus,
     NcObject,
     NcParameterConstraints,
@@ -54,7 +53,7 @@ import {
     NcTouchpointResource,
     NcTouchpointResourceNmos, 
     NcTouchpointResourceNmosChannelMapping} from './Core';
-import { DemoDataType, NcActuator, NcDemo, NcGain, NcIdentBeacon, NcReceiverMonitor, NcReceiverStatus, NcSensor, NcSignalWorker, NcWorker } from './Features';
+import { DemoDataType, NcActuator, NcDemo, NcGain, NcIdentBeacon, NcLevelSensor, NcReceiverMonitor, NcReceiverMonitorProtected, NcReceiverStatus, NcSensor, NcSignalWorker, NcWorker } from './Features';
 
 export abstract class NcManager extends NcObject
 {
@@ -569,14 +568,16 @@ export class NcClassManager extends NcManager
             '1.2': NcWorker.GetClassDescriptor(false),
             '1.2.1': NcSignalWorker.GetClassDescriptor(false),
             '1.2.1.1': NcActuator.GetClassDescriptor(false),
+            '1.2.1.1.1': NcGain.GetClassDescriptor(false),
             '1.2.1.2': NcSensor.GetClassDescriptor(false),
-            '1.3': NcManager.GetClassDescriptor(false),
-            '1.3.1': NcDeviceManager.GetClassDescriptor(false),
-            '1.3.2': NcClassManager.GetClassDescriptor(false),
+            '1.2.1.2.1': NcLevelSensor.GetClassDescriptor(false),
             '1.2.0.1': NcDemo.GetClassDescriptor(false),
             '1.2.2': NcIdentBeacon.GetClassDescriptor(false),
             '1.2.3': NcReceiverMonitor.GetClassDescriptor(false),
-            '1.2.1.1.1': NcGain.GetClassDescriptor(false)
+            '1.2.3.1': NcReceiverMonitorProtected.GetClassDescriptor(false),
+            '1.3': NcManager.GetClassDescriptor(false),
+            '1.3.1': NcDeviceManager.GetClassDescriptor(false),
+            '1.3.2': NcClassManager.GetClassDescriptor(false)
         };
 
         return register;
@@ -593,14 +594,16 @@ export class NcClassManager extends NcManager
             case '1.2': return NcWorker.GetClassDescriptor(true);
             case '1.2.1': return NcSignalWorker.GetClassDescriptor(true);
             case '1.2.1.1': return NcActuator.GetClassDescriptor(true);
+            case '1.2.1.1.1': return NcGain.GetClassDescriptor(true);
             case '1.2.1.2': return NcSensor.GetClassDescriptor(true);
-            case '1.3': return NcManager.GetClassDescriptor(true);
-            case '1.3.1': return NcDeviceManager.GetClassDescriptor(true);
-            case '1.3.2': return NcClassManager.GetClassDescriptor(true);
+            case '1.2.1.2.1': return NcLevelSensor.GetClassDescriptor(true);
             case '1.2.0.1': return NcDemo.GetClassDescriptor(true);
             case '1.2.2': return NcIdentBeacon.GetClassDescriptor(true);
             case '1.2.3': return NcReceiverMonitor.GetClassDescriptor(true);
-            case '1.2.1.1.1': return NcGain.GetClassDescriptor(true);
+            case '1.2.3.1': return NcReceiverMonitorProtected.GetClassDescriptor(true);
+            case '1.3': return NcManager.GetClassDescriptor(true);
+            case '1.3.1': return NcDeviceManager.GetClassDescriptor(true);
+            case '1.3.2': return NcClassManager.GetClassDescriptor(true);
             default: return null;
         }
     }
@@ -711,7 +714,6 @@ export class NcClassManager extends NcManager
             'NcMethodResultClassDescriptor': NcMethodResultClassDescriptor.GetTypeDescriptor(false),
             'NcMethodResultDatatypeDescriptor': NcMethodResultDatatypeDescriptor.GetTypeDescriptor(false),
             'NcReceiverStatus': NcReceiverStatus.GetTypeDescriptor(false),
-            'NcMethodResultReceiverStatus': NcMethodResultReceiverStatus.GetTypeDescriptor(false),
             'NcIoDirection': new NcDatatypeDescriptorEnum("NcIoDirection", [
                 new NcEnumItemDescriptor("Undefined", 0, "Not defined"),
                 new NcEnumItemDescriptor("Input", 1, "Input direction"),
@@ -794,7 +796,6 @@ export class NcClassManager extends NcManager
             case 'NcMethodResultClassDescriptor': return NcMethodResultClassDescriptor.GetTypeDescriptor(true);
             case 'NcMethodResultDatatypeDescriptor': return NcMethodResultDatatypeDescriptor.GetTypeDescriptor(true);
             case 'NcMethodResultId': return NcMethodResultId.GetTypeDescriptor(true);
-            case 'NcMethodResultReceiverStatus': return NcMethodResultReceiverStatus.GetTypeDescriptor(true);
             default: return this.dataTypesRegister[name];
         }
     }