aes70 1.6.1 → 2.0.0

package/src/controller/ControlClasses/OcaJsonActuator.js

@@ -0,0 +1,58 @@
+import { OcaString } from '../../OCP1/OcaString.js';
+import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaBasicActuator } from './OcaBasicActuator.js';
+
+/**
+ * JSON value actuator.
+ * @extends OcaBasicActuator
+ * @class OcaJsonActuator
+ */
+export const OcaJsonActuator = make_control_class(
+  'OcaJsonActuator',
+  5,
+  '\u0001\u0001\u0001\u0001\u000e',
+  1,
+  OcaBasicActuator,
+  [
+    ['GetValue', 5, 1, [], [OcaString]],
+    ['SetValue', 5, 2, [OcaString], []],
+    ['GetMaxLen', 5, 3, [], [OcaUint16]],
+  ],
+  [
+    ['Value', [OcaString], 5, 1, false, false, null],
+    ['MaxLen', [OcaUint16], 5, 2, true, false, null],
+  ],
+  []
+);
+
+/**
+ * Gets the value of the **Value** property.
+ *
+ * @method OcaJsonActuator#GetValue
+ * @returns {Promise<string>}
+ *   A promise which resolves to a single value of type ``string``.
+ */
+/**
+ * Sets the value of the **Value** property.
+ *
+ * @method OcaJsonActuator#SetValue
+ * @param {string} Setting
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Output parameter that shall hold the maximum allowable length of the Setting
+ * property if the method succeeds.
+ *
+ * @method OcaJsonActuator#GetMaxLen
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * This event is emitted when the property ``Value`` changes in the remote object.
+ * The property ``Value`` is described in the AES70 standard as follows.
+ * The JSON value.
+ *
+ * @member {PropertyEvent<string>} OcaJsonActuator#OnValueChanged
+ */

package/src/controller/ControlClasses/OcaJsonSensor.d.ts

@@ -0,0 +1,51 @@
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaBasicSensor } from './OcaBasicSensor';
+
+/**
+ * JSON value actuator, with or without schema.
+ * @extends OcaBasicSensor
+ * @class OcaJsonSensor
+ */
+export declare class OcaJsonSensor extends OcaBasicSensor {
+  /**
+   * This event is emitted whenever Value changes.
+   */
+  OnValueChanged: PropertyEvent<string>;
+
+  /**
+   * This event is emitted whenever MaxLen changes.
+   */
+  OnMaxLenChanged: PropertyEvent<number>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Gets the value of the **Value** property.
+   *
+   * @method OcaJsonSensor#GetValue
+   * @returns {Promise<string>}
+   *   A promise which resolves to a single value of type ``string``.
+   */
+  GetValue(): Promise<string>;
+
+  /**
+   * Gets the maximum number of bytes that may be returned.
+   *
+   * @method OcaJsonSensor#GetMaxLen
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  GetMaxLen(): Promise<number>;
+
+  /**
+   * Sets the maximum number of bytes that the object may return. Optional
+   * method.
+   *
+   * @method OcaJsonSensor#SetMaxLen
+   * @param {number} Len
+   *
+   * @returns {Promise<void>}
+   */
+  SetMaxLen(Len: number): Promise<void>;
+}

package/src/controller/ControlClasses/OcaJsonSensor.js

@@ -0,0 +1,65 @@
+import { OcaString } from '../../OCP1/OcaString.js';
+import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaBasicSensor } from './OcaBasicSensor.js';
+
+/**
+ * JSON value actuator, with or without schema.
+ * @extends OcaBasicSensor
+ * @class OcaJsonSensor
+ */
+export const OcaJsonSensor = make_control_class(
+  'OcaJsonSensor',
+  5,
+  '\u0001\u0001\u0002\u0001\u000e',
+  1,
+  OcaBasicSensor,
+  [
+    ['GetValue', 5, 1, [], [OcaString]],
+    ['GetMaxLen', 5, 2, [], [OcaUint16]],
+    ['SetMaxLen', 5, 3, [OcaUint16], []],
+  ],
+  [
+    ['Value', [OcaString], 5, 1, false, false, null],
+    ['MaxLen', [OcaUint16], 5, 2, false, false, null],
+  ],
+  []
+);
+
+/**
+ * Gets the value of the **Value** property.
+ *
+ * @method OcaJsonSensor#GetValue
+ * @returns {Promise<string>}
+ *   A promise which resolves to a single value of type ``string``.
+ */
+/**
+ * Gets the maximum number of bytes that may be returned.
+ *
+ * @method OcaJsonSensor#GetMaxLen
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * Sets the maximum number of bytes that the object may return. Optional method.
+ *
+ * @method OcaJsonSensor#SetMaxLen
+ * @param {number} Len
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * This event is emitted when the property ``Value`` changes in the remote object.
+ * The property ``Value`` is described in the AES70 standard as follows.
+ * The JSON value.
+ *
+ * @member {PropertyEvent<string>} OcaJsonSensor#OnValueChanged
+ */
+/**
+ * This event is emitted when the property ``MaxLen`` changes in the remote object.
+ * The property ``MaxLen`` is described in the AES70 standard as follows.
+ * Maximum length of the returned value. May be readonly in some
+ * implementations.
+ *
+ * @member {PropertyEvent<number>} OcaJsonSensor#OnMaxLenChanged
+ */

package/src/controller/ControlClasses/OcaLevelSensor.d.ts

@@ -17,8 +17,7 @@ export declare class OcaLevelSensor extends OcaSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value and limits of the **Reading** property. The return value
-   * indicates whether the data was successfully retrieved.
+   * Gets the value and limits of the **Reading** property.
    * The return values of this method are
    *
    * - Reading of type ``number``

package/src/controller/ControlClasses/OcaLevelSensor.js

@@ -11,7 +11,7 @@ export const OcaLevelSensor = make_control_class(
   'OcaLevelSensor',
   4,
   '\u0001\u0001\u0002\u0002',
-  2,
+  3,
   OcaSensor,
   [['GetReading', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]]],
   [['Reading', [OcaFloat32], 4, 1, false, false, null]],
@@ -19,8 +19,7 @@ export const OcaLevelSensor = make_control_class(
 );
 
 /**
- * Gets the value and limits of the **Reading** property. The return value
- * indicates whether the data was successfully retrieved.
+ * Gets the value and limits of the **Reading** property.
  * The return values of this method are
  *
  * - Reading of type ``number``

package/src/controller/ControlClasses/OcaLibraryManager.d.ts

@@ -29,7 +29,7 @@ export declare class OcaLibraryManager extends OcaManager {
   /**
    * This event is emitted whenever CurrentPatch changes.
    */
-  OnCurrentPatchChanged: PropertyEvent<OcaLibVolIdentifier>;
+  OnCurrentPatchChanged: PropertyEvent<number>;
 
   constructor(objectNumber: number, device: RemoteDevice);
 

package/src/controller/ControlClasses/OcaLibraryManager.js

@@ -23,7 +23,7 @@ export const OcaLibraryManager = make_control_class(
   'OcaLibraryManager',
   3,
   '\u0001\u0003\b',
-  2,
+  3,
   OcaManager,
   [
     ['AddLibrary', 3, 1, [OcaLibVolType], [OcaLibraryIdentifier]],
@@ -35,7 +35,7 @@ export const OcaLibraryManager = make_control_class(
   ],
   [
     ['Libraries', [OcaList(OcaLibraryIdentifier)], 3, 1, false, false, null],
-    ['CurrentPatch', [OcaLibVolIdentifier], 3, 2, false, false, null],
+    ['CurrentPatch', [OcaUint16], 3, 2, false, false, null],
   ],
   []
 );
@@ -108,5 +108,5 @@ export const OcaLibraryManager = make_control_class(
  * Changing the value of this property applies the patch represented by the new
  * value.
  *
- * @member {PropertyEvent<OcaLibVolIdentifier>} OcaLibraryManager#OnCurrentPatchChanged
+ * @member {PropertyEvent<number>} OcaLibraryManager#OnCurrentPatchChanged
  */

package/src/controller/ControlClasses/OcaLockManager.d.ts

@@ -0,0 +1,44 @@
+import { IOcaLockState } from '../../types/OcaLockState';
+import { RemoteDevice } from '../remote_device';
+import { OcaManager } from './OcaManager';
+
+/**
+ * Optional object and device lock manager that supports mutex-type waits for
+ * locking things without causing race conditions.
+ *
+ *  - May be instantiated at most once in any device.
+ *
+ *  - If instantiated, object number must be 14 (decimal).
+ *
+ *
+ * @extends OcaManager
+ * @class OcaLockManager
+ */
+export declare class OcaLockManager extends OcaManager {
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Lock an object. returns when lock is set or timeout expires or
+   * **AbortWaits(...)** is called. A timeout value of zero requests an
+   * indefinite wait with no timeout.. Note: To lock an entire device, lock its
+   * Device Manager (ONo 1).
+   *
+   * @method OcaLockManager#LockWait
+   * @param {number} target
+   * @param {IOcaLockState} type
+   * @param {number} timeout
+   *
+   * @returns {Promise<void>}
+   */
+  LockWait(target: number, type: IOcaLockState, timeout: number): Promise<void>;
+
+  /**
+   * Aborts all of this session's waits on the given object.
+   *
+   * @method OcaLockManager#AbortWaits
+   * @param {number} ONo
+   *
+   * @returns {Promise<void>}
+   */
+  AbortWaits(ONo: number): Promise<void>;
+}

package/src/controller/ControlClasses/OcaLockManager.js

@@ -0,0 +1,53 @@
+import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
+import { OcaLockState } from '../../OCP1/OcaLockState.js';
+import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaManager } from './OcaManager.js';
+
+/**
+ * Optional object and device lock manager that supports mutex-type waits for
+ * locking things without causing race conditions.
+ *
+ *  - May be instantiated at most once in any device.
+ *
+ *  - If instantiated, object number must be 14 (decimal).
+ *
+ *
+ * @extends OcaManager
+ * @class OcaLockManager
+ */
+export const OcaLockManager = make_control_class(
+  'OcaLockManager',
+  3,
+  '\u0001\u0003\u000e',
+  1,
+  OcaManager,
+  [
+    ['LockWait', 3, 1, [OcaUint32, OcaLockState, OcaFloat32], []],
+    ['AbortWaits', 3, 2, [OcaUint32], []],
+  ],
+  [],
+  []
+);
+
+/**
+ * Lock an object. returns when lock is set or timeout expires or
+ * **AbortWaits(...)** is called. A timeout value of zero requests an indefinite
+ * wait with no timeout.. Note: To lock an entire device, lock its Device
+ * Manager (ONo 1).
+ *
+ * @method OcaLockManager#LockWait
+ * @param {number} target
+ * @param {IOcaLockState} type
+ * @param {number} timeout
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Aborts all of this session's waits on the given object.
+ *
+ * @method OcaLockManager#AbortWaits
+ * @param {number} ONo
+ *
+ * @returns {Promise<void>}
+ */

package/src/controller/ControlClasses/OcaLog.d.ts

@@ -0,0 +1,128 @@
+import { IOcaLockState } from '../../types/OcaLockState';
+import { IOcaLogFilter } from '../../types/OcaLogFilter';
+import { IOcaLogRecord, OcaLogRecord } from '../../types/OcaLogRecord';
+import { Arguments } from '../arguments';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaDataset } from './OcaDataset';
+
+/**
+ * A log object. Child of **OcaDataSet.**
+ * @extends OcaDataset
+ * @class OcaLog
+ */
+export declare class OcaLog extends OcaDataset {
+  /**
+   * This event is emitted whenever Enabled changes.
+   */
+  OnEnabledChanged: PropertyEvent<boolean>;
+
+  /**
+   * This event is emitted whenever SeverityThreshold changes.
+   */
+  OnSeverityThresholdChanged: PropertyEvent<number>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Adds a log entry.
+   *
+   * @method OcaLog#AddLogRecord
+   * @param {IOcaLogRecord} Entry
+   *
+   * @returns {Promise<void>}
+   */
+  AddLogRecord(Entry: IOcaLogRecord): Promise<void>;
+
+  /**
+   * Gets the value of the **SeverityThreshold** property.
+   *
+   * @method OcaLog#GetSeverityThreshold
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  GetSeverityThreshold(): Promise<number>;
+
+  /**
+   * Sets the value of the **SeverityThreshold** property.
+   *
+   * @method OcaLog#SetSeverityThreshold
+   * @param {number} Severity
+   *
+   * @returns {Promise<void>}
+   */
+  SetSeverityThreshold(Severity: number): Promise<void>;
+
+  /**
+   * Opens a log retrieval session. Sets the record filter that the retrievals
+   * will use. Returns a handle for subsequent **RetrieveRecords(...)** calls to
+   * use.
+   *
+   * @method OcaLog#OpenRetrievalSession
+   * @param {IOcaLockState} LockType
+   * @param {IOcaLogFilter} Filter
+   *
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  OpenRetrievalSession(
+    LockType: IOcaLockState,
+    Filter: IOcaLogFilter
+  ): Promise<number>;
+
+  /**
+   * Closes a log retrieval session.
+   *
+   * @method OcaLog#CloseRetrievalSession
+   * @param {number} Handle
+   *
+   * @returns {Promise<void>}
+   */
+  CloseRetrievalSession(Handle: number): Promise<void>;
+
+  /**
+   * In a given log reading session, retrieves the next log record(s) that match
+   * the session's retrieval criteria. There must have an open log retrieval
+   * session created by calling OpenLogRetrievalSession(...). This call
+   * specifies the retrieval criteria. Returns **.EndOfData**=TRUE when there
+   * are no more records to retrieve.
+   * The return values of this method are
+   *
+   * - EndOfData of type ``boolean``
+   * - LengthOfRequestedData of type ``number|BigInt``
+   * - Records of type ``IOcaLogRecord[]``
+   *
+   * @method OcaLog#RetrieveRecords
+   * @param {number} Handle
+   * @param {number|BigInt} RecStartNo
+   * @param {number} RecCount
+   * @param {number|BigInt} MaxDataLength
+   *
+   * @returns {Promise<Arguments<boolean,number|BigInt,OcaLogRecord[]>>}
+   */
+  RetrieveRecords(
+    Handle: number,
+    RecStartNo: number | BigInt,
+    RecCount: number,
+    MaxDataLength: number | BigInt
+  ): Promise<Arguments<[boolean, number | BigInt, OcaLogRecord[]]>>;
+
+  /**
+   * Gets the value of the **Enabled** property.
+   *
+   * @method OcaLog#GetEnabled
+   * @returns {Promise<boolean>}
+   *   A promise which resolves to a single value of type ``boolean``.
+   */
+  GetEnabled(): Promise<boolean>;
+
+  /**
+   * Sets the value of the **Enabled** property.
+   *
+   * @method OcaLog#SetEnabled
+   * @param {boolean} Enabled
+   *
+   * @returns {Promise<void>}
+   */
+  SetEnabled(Enabled: boolean): Promise<void>;
+}

package/src/controller/ControlClasses/OcaLog.js

@@ -0,0 +1,142 @@
+import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
+import { OcaInt32 } from '../../OCP1/OcaInt32.js';
+import { OcaList } from '../../OCP1/OcaList.js';
+import { OcaLockState } from '../../OCP1/OcaLockState.js';
+import { OcaLogFilter } from '../../OCP1/OcaLogFilter.js';
+import { OcaLogRecord } from '../../OCP1/OcaLogRecord.js';
+import { OcaUint16 } from '../../OCP1/OcaUint16.js';
+import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { OcaUint64 } from '../../OCP1/OcaUint64.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaDataset } from './OcaDataset.js';
+
+/**
+ * A log object. Child of **OcaDataSet.**
+ * @extends OcaDataset
+ * @class OcaLog
+ */
+export const OcaLog = make_control_class(
+  'OcaLog',
+  3,
+  '\u0001\u0005\u0001',
+  1,
+  OcaDataset,
+  [
+    ['AddLogRecord', 3, 1, [OcaLogRecord], []],
+    ['GetSeverityThreshold', 3, 2, [], [OcaInt32]],
+    ['SetSeverityThreshold', 3, 3, [OcaInt32], []],
+    ['OpenRetrievalSession', 3, 4, [OcaLockState, OcaLogFilter], [OcaUint32]],
+    ['CloseRetrievalSession', 3, 5, [OcaUint32], []],
+    [
+      'RetrieveRecords',
+      3,
+      6,
+      [OcaUint32, OcaUint64, OcaUint16, OcaUint64],
+      [OcaBoolean, OcaUint64, OcaList(OcaLogRecord)],
+    ],
+    ['GetEnabled', 3, 7, [], [OcaBoolean]],
+    ['SetEnabled', 3, 8, [OcaBoolean], []],
+  ],
+  [
+    ['Enabled', [OcaBoolean], 3, 1, false, false, null],
+    ['SeverityThreshold', [OcaInt32], 3, 2, false, false, null],
+  ],
+  []
+);
+
+/**
+ * Adds a log entry.
+ *
+ * @method OcaLog#AddLogRecord
+ * @param {IOcaLogRecord} Entry
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the value of the **SeverityThreshold** property.
+ *
+ * @method OcaLog#GetSeverityThreshold
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * Sets the value of the **SeverityThreshold** property.
+ *
+ * @method OcaLog#SetSeverityThreshold
+ * @param {number} Severity
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Opens a log retrieval session. Sets the record filter that the retrievals
+ * will use. Returns a handle for subsequent **RetrieveRecords(...)** calls to
+ * use.
+ *
+ * @method OcaLog#OpenRetrievalSession
+ * @param {IOcaLockState} LockType
+ * @param {IOcaLogFilter} Filter
+ *
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * Closes a log retrieval session.
+ *
+ * @method OcaLog#CloseRetrievalSession
+ * @param {number} Handle
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * In a given log reading session, retrieves the next log record(s) that match
+ * the session's retrieval criteria. There must have an open log retrieval
+ * session created by calling OpenLogRetrievalSession(...). This call specifies
+ * the retrieval criteria. Returns **.EndOfData**=TRUE when there are no more
+ * records to retrieve.
+ * The return values of this method are
+ *
+ * - EndOfData of type ``boolean``
+ * - LengthOfRequestedData of type ``number|BigInt``
+ * - Records of type ``IOcaLogRecord[]``
+ *
+ * @method OcaLog#RetrieveRecords
+ * @param {number} Handle
+ * @param {number|BigInt} RecStartNo
+ * @param {number} RecCount
+ * @param {number|BigInt} MaxDataLength
+ *
+ * @returns {Promise<Arguments<boolean,number|BigInt,OcaLogRecord[]>>}
+ */
+/**
+ * Gets the value of the **Enabled** property.
+ *
+ * @method OcaLog#GetEnabled
+ * @returns {Promise<boolean>}
+ *   A promise which resolves to a single value of type ``boolean``.
+ */
+/**
+ * Sets the value of the **Enabled** property.
+ *
+ * @method OcaLog#SetEnabled
+ * @param {boolean} Enabled
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * This event is emitted when the property ``Enabled`` changes in the remote object.
+ * The property ``Enabled`` is described in the AES70 standard as follows.
+ * TRUE if and only if logging is enabled.
+ *
+ * @member {PropertyEvent<boolean>} OcaLog#OnEnabledChanged
+ */
+/**
+ * This event is emitted when the property ``SeverityThreshold`` changes in the remote object.
+ * The property ``SeverityThreshold`` is described in the AES70 standard as follows.
+ * Log input filter: Only events whose severity level designator values are at
+ * or below this threshold will be logged. Note: **OcaLogSeverityLevel** is
+ * defined to follow the Syslog format as described in [RFC 5424]. In [RFC
+ * 5424], higher importance of an event is represented by a lower numeric value
+ * of its Severity Level.
+ *
+ * @member {PropertyEvent<number>} OcaLog#OnSeverityThresholdChanged
+ */

package/src/controller/ControlClasses/OcaManager.js

@@ -13,7 +13,7 @@ export const OcaManager = make_control_class(
   'OcaManager',
   2,
   '\u0001\u0003',
-  2,
+  3,
   OcaRoot,
   [],
   [],