aes70 1.6.2 → 2.0.0

package/src/controller/ControlClasses/OcaFrequencyActuator.js

@@ -11,7 +11,7 @@ export const OcaFrequencyActuator = make_control_class(
   'OcaFrequencyActuator',
   4,
   '\u0001\u0001\u0001\b',
-  2,
+  3,
   OcaActuator,
   [
     ['GetFrequency', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
@@ -22,8 +22,7 @@ export const OcaFrequencyActuator = make_control_class(
 );
 
 /**
- * Gets the value of the Frequency property. The return value indicates whether
- * the property was successfully retrieved.
+ * Gets the value and limits of the **Frequency** property.
  * The return values of this method are
  *
  * - Frequency of type ``number``
@@ -34,8 +33,7 @@ export const OcaFrequencyActuator = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the Frequency property. The return value indicates whether
- * the property was successfully set.
+ * Sets the value of the **Frequency** property.
  *
  * @method OcaFrequencyActuator#SetFrequency
  * @param {number} Frequency

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

@@ -17,8 +17,7 @@ export declare class OcaFrequencySensor 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/OcaFrequencySensor.js

@@ -11,7 +11,7 @@ export const OcaFrequencySensor = make_control_class(
   'OcaFrequencySensor',
   4,
   '\u0001\u0001\u0002\u0004',
-  2,
+  3,
   OcaSensor,
   [['GetReading', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]]],
   [['Reading', [OcaFloat32], 4, 1, false, false, null]],
@@ -19,8 +19,7 @@ export const OcaFrequencySensor = 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/OcaGain.d.ts

@@ -17,8 +17,7 @@ export declare class OcaGain extends OcaActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value and limits of the Gain property. The return value indicates
-   * whether the data was successfully retrieved.
+   * Gets the value and limits of the **Gain** property.
    * The return values of this method are
    *
    * - Gain of type ``number``
@@ -31,8 +30,7 @@ export declare class OcaGain extends OcaActuator {
   GetGain(): Promise<Arguments<[number, number, number]>>;
 
   /**
-   * Sets the value of the Gain property. The return value indicates whether the
-   * property was successfully set.
+   * Sets the value of the **Gain** property.
    *
    * @method OcaGain#SetGain
    * @param {number} Gain

package/src/controller/ControlClasses/OcaGain.js

@@ -11,7 +11,7 @@ export const OcaGain = make_control_class(
   'OcaGain',
   4,
   '\u0001\u0001\u0001\u0005',
-  2,
+  3,
   OcaActuator,
   [
     ['GetGain', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
@@ -22,8 +22,7 @@ export const OcaGain = make_control_class(
 );
 
 /**
- * Gets the value and limits of the Gain property. The return value indicates
- * whether the data was successfully retrieved.
+ * Gets the value and limits of the **Gain** property.
  * The return values of this method are
  *
  * - Gain of type ``number``
@@ -34,8 +33,7 @@ export const OcaGain = make_control_class(
  * @returns {Promise<Arguments<number,number,number>>}
  */
 /**
- * Sets the value of the Gain property. The return value indicates whether the
- * property was successfully set.
+ * Sets the value of the **Gain** property.
  *
  * @method OcaGain#SetGain
  * @param {number} Gain

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

@@ -4,7 +4,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaSensor } from './OcaSensor';
 
 /**
- * Senses a gain value. Typically used to indicate instantaneous gain value of a
+ * Gain value sensor. Typically used to indicate instantaneous gain value of a
  * dynamics element.
  * @extends OcaSensor
  * @class OcaGainSensor
@@ -18,8 +18,7 @@ export declare class OcaGainSensor 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/OcaGainSensor.js

@@ -3,7 +3,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaSensor } from './OcaSensor.js';
 
 /**
- * Senses a gain value. Typically used to indicate instantaneous gain value of a
+ * Gain value sensor. Typically used to indicate instantaneous gain value of a
  * dynamics element.
  * @extends OcaSensor
  * @class OcaGainSensor
@@ -12,7 +12,7 @@ export const OcaGainSensor = make_control_class(
   'OcaGainSensor',
   4,
   '\u0001\u0001\u0002\n',
-  1,
+  3,
   OcaSensor,
   [['GetReading', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]]],
   [['Reading', [OcaFloat32], 4, 1, false, false, null]],
@@ -20,8 +20,7 @@ export const OcaGainSensor = 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/OcaGroup.d.ts

@@ -0,0 +1,140 @@
+import { Event } from '../event';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaAgent } from './OcaAgent';
+
+/**
+ * Control aggregator. See **[AES70-1(Control Aggregation)]** for the normative
+ * specification of **OcaGroup** semantics.
+ * @extends OcaAgent
+ * @class OcaGroup
+ */
+export declare class OcaGroup extends OcaAgent {
+  /**
+   * Event that is emitted whenever a value-setting operation returns a status
+   * other than OK. NOTE. This is an ordinary event that causes a normal
+   * Notification message to be emitted. The OCP.1 protocol defines a special
+   * type of Notification PDU called **'Exception'**, but that PDU type is only
+   * used to signal cancellation of a subscription. This **GroupException**
+   * event uses the normal Notification PDU type, which is called **'Event'**.
+   * @member OcaGroup#OnGroupException {Event}
+   */
+  OnGroupException: Event;
+  /**
+   * This event is emitted whenever Members changes.
+   */
+  OnMembersChanged: PropertyEvent<number[]>;
+
+  /**
+   * This event is emitted whenever GroupControllerONo changes.
+   */
+  OnGroupControllerONoChanged: PropertyEvent<number>;
+
+  /**
+   * This event is emitted whenever AggregationRule changes.
+   */
+  OnAggregationRuleChanged: PropertyEvent<string>;
+
+  /**
+   * This event is emitted whenever SaturationRule changes.
+   */
+  OnSaturationRuleChanged: PropertyEvent<string>;
+
+  constructor(objectNumber: number, device: RemoteDevice);
+
+  /**
+   * Gets the list of Group members.
+   *
+   * @method OcaGroup#GetMembers
+   * @returns {Promise<number[]>}
+   *   A promise which resolves to a single value of type ``number[]``.
+   */
+  GetMembers(): Promise<number[]>;
+
+  /**
+   * Sets the list of Group members.
+   *
+   * @method OcaGroup#SetMembers
+   * @param {number[]} Members
+   *
+   * @returns {Promise<void>}
+   */
+  SetMembers(Members: number[]): Promise<void>;
+
+  /**
+   * Adds a Member to the Group.
+   *
+   * @method OcaGroup#AddMember
+   * @param {number} Member
+   *
+   * @returns {Promise<void>}
+   */
+  AddMember(Member: number): Promise<void>;
+
+  /**
+   * Removes a Member from the Group.
+   *
+   * @method OcaGroup#RemoveMember
+   * @param {number} Member
+   *
+   * @returns {Promise<void>}
+   */
+  RemoveMember(Member: number): Promise<void>;
+
+  /**
+   * Gets the Group Controller object number.
+   *
+   * @method OcaGroup#GetGroupControllerONo
+   * @returns {Promise<number>}
+   *   A promise which resolves to a single value of type ``number``.
+   */
+  GetGroupControllerONo(): Promise<number>;
+
+  /**
+   * Sets the Group Controller object number.
+   *
+   * @method OcaGroup#SetGroupControllerONo
+   * @param {number} ONo
+   *
+   * @returns {Promise<void>}
+   */
+  SetGroupControllerONo(ONo: number): Promise<void>;
+
+  /**
+   * Gets the value of the **AggregationRule** property.
+   *
+   * @method OcaGroup#GetAggregationRule
+   * @returns {Promise<string>}
+   *   A promise which resolves to a single value of type ``string``.
+   */
+  GetAggregationRule(): Promise<string>;
+
+  /**
+   * Sets the value of the **AggregationRule** property.
+   *
+   * @method OcaGroup#SetAggregationRule
+   * @param {string} Rule
+   *
+   * @returns {Promise<void>}
+   */
+  SetAggregationRule(Rule: string): Promise<void>;
+
+  /**
+   * Gets the value of the **SaturationRule** property.
+   *
+   * @method OcaGroup#GetSaturationRule
+   * @returns {Promise<string>}
+   *   A promise which resolves to a single value of type ``string``.
+   */
+  GetSaturationRule(): Promise<string>;
+
+  /**
+   * Sets the value of the **SaturationRule** property.
+   *
+   * @method OcaGroup#SetSaturationRule
+   * @param {string} Rule
+   *
+   * @returns {Promise<void>}
+   */
+  SetSaturationRule(Rule: string): Promise<void>;
+}

package/src/controller/ControlClasses/OcaGroup.js

@@ -0,0 +1,156 @@
+import { OcaGroupException } from '../../OCP1/OcaGroupException.js';
+import { OcaList } from '../../OCP1/OcaList.js';
+import { OcaString } from '../../OCP1/OcaString.js';
+import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
+
+/**
+ * Control aggregator. See **[AES70-1(Control Aggregation)]** for the normative
+ * specification of **OcaGroup** semantics.
+ * @extends OcaAgent
+ * @class OcaGroup
+ */
+export const OcaGroup = make_control_class(
+  'OcaGroup',
+  3,
+  '\u0001\u0002\u0016',
+  4,
+  OcaAgent,
+  [
+    ['GetMembers', 3, 1, [], [OcaList(OcaUint32)]],
+    ['SetMembers', 3, 2, [OcaList(OcaUint32)], []],
+    ['AddMember', 3, 3, [OcaUint32], []],
+    ['RemoveMember', 3, 4, [OcaUint32], []],
+    ['GetGroupControllerONo', 3, 5, [], [OcaUint32]],
+    ['SetGroupControllerONo', 3, 6, [OcaUint32], []],
+    ['GetAggregationRule', 3, 7, [], [OcaString]],
+    ['SetAggregationRule', 3, 8, [OcaString], []],
+    ['GetSaturationRule', 3, 9, [], [OcaString]],
+    ['SetSaturationRule', 3, 10, [OcaString], []],
+  ],
+  [
+    ['Members', [OcaList(OcaUint32)], 3, 1, false, false, null],
+    ['GroupControllerONo', [OcaUint32], 3, 2, false, false, null],
+    ['AggregationRule', [OcaString], 3, 3, false, false, null],
+    ['SaturationRule', [OcaString], 3, 4, false, false, null],
+  ],
+  [['GroupException', 3, 1, [OcaList(OcaGroupException)]]]
+);
+
+/**
+ * Gets the list of Group members.
+ *
+ * @method OcaGroup#GetMembers
+ * @returns {Promise<number[]>}
+ *   A promise which resolves to a single value of type ``number[]``.
+ */
+/**
+ * Sets the list of Group members.
+ *
+ * @method OcaGroup#SetMembers
+ * @param {number[]} Members
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Adds a Member to the Group.
+ *
+ * @method OcaGroup#AddMember
+ * @param {number} Member
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Removes a Member from the Group.
+ *
+ * @method OcaGroup#RemoveMember
+ * @param {number} Member
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the Group Controller object number.
+ *
+ * @method OcaGroup#GetGroupControllerONo
+ * @returns {Promise<number>}
+ *   A promise which resolves to a single value of type ``number``.
+ */
+/**
+ * Sets the Group Controller object number.
+ *
+ * @method OcaGroup#SetGroupControllerONo
+ * @param {number} ONo
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the value of the **AggregationRule** property.
+ *
+ * @method OcaGroup#GetAggregationRule
+ * @returns {Promise<string>}
+ *   A promise which resolves to a single value of type ``string``.
+ */
+/**
+ * Sets the value of the **AggregationRule** property.
+ *
+ * @method OcaGroup#SetAggregationRule
+ * @param {string} Rule
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the value of the **SaturationRule** property.
+ *
+ * @method OcaGroup#GetSaturationRule
+ * @returns {Promise<string>}
+ *   A promise which resolves to a single value of type ``string``.
+ */
+/**
+ * Sets the value of the **SaturationRule** property.
+ *
+ * @method OcaGroup#SetSaturationRule
+ * @param {string} Rule
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Event that is emitted whenever a value-setting operation returns a status
+ * other than OK. NOTE. This is an ordinary event that causes a normal
+ * Notification message to be emitted. The OCP.1 protocol defines a special type
+ * of Notification PDU called **'Exception'**, but that PDU type is only used to
+ * signal cancellation of a subscription. This **GroupException** event uses the
+ * normal Notification PDU type, which is called **'Event'**.
+ * @member OcaGroup#OnGroupException {Event}
+ */
+/**
+ * This event is emitted when the property ``Members`` changes in the remote object.
+ * The property ``Members`` is described in the AES70 standard as follows.
+ * Object numbers of group members
+ *
+ * @member {PropertyEvent<number[]>} OcaGroup#OnMembersChanged
+ */
+/**
+ * This event is emitted when the property ``GroupControllerONo`` changes in the remote object.
+ * The property ``GroupControllerONo`` is described in the AES70 standard as follows.
+ * Object number of group controller object. Zero value means group is peer to
+ * peer group in which a change to any member affects all members.
+ *
+ * @member {PropertyEvent<number>} OcaGroup#OnGroupControllerONoChanged
+ */
+/**
+ * This event is emitted when the property ``AggregationRule`` changes in the remote object.
+ * The property ``AggregationRule`` is described in the AES70 standard as follows.
+ * Aggregation rule of group. Optional; null string if not used. Values are
+ * implementation-dependent.
+ *
+ * @member {PropertyEvent<string>} OcaGroup#OnAggregationRuleChanged
+ */
+/**
+ * This event is emitted when the property ``SaturationRule`` changes in the remote object.
+ * The property ``SaturationRule`` is described in the AES70 standard as follows.
+ * Saturation rule of group. Optional; null string if not used. Values are
+ * implementation-dependent.
+ *
+ * @member {PropertyEvent<string>} OcaGroup#OnSaturationRuleChanged
+ */