aes70 1.6.2 → 2.0.0

package/src/controller/ControlClasses/OcaAgent.js

@@ -13,7 +13,7 @@ export const OcaAgent = make_control_class(
   'OcaAgent',
   2,
   '\u0001\u0002',
-  2,
+  3,
   OcaRoot,
   [
     ['GetLabel', 2, 1, [], [OcaString]],
@@ -23,22 +23,20 @@ export const OcaAgent = make_control_class(
   ],
   [
     ['Label', [OcaString], 2, 1, false, false, null],
-    ['Owner', [OcaUint32], 2, 2, false, false, null],
+    ['Owner', [OcaUint32], 2, 2, true, false, null],
   ],
   []
 );
 
 /**
- * Gets the value of the Label property. The return value indicates whether the
- * property was successfully retrieved.
+ * Gets the value of the **Label** property.
  *
  * @method OcaAgent#GetLabel
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Sets the value of the Label property. The return value indicates whether the
- * property was successfully set.
+ * Sets the value of the **Label** property.
  *
  * @method OcaAgent#SetLabel
  * @param {string} Label
@@ -46,19 +44,18 @@ export const OcaAgent = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the Owner property. The return value indicates whether the
- * property was successfully retrieved.
+ * Gets the value of the **Owner** property.
  *
  * @method OcaAgent#GetOwner
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Returns path from the given object down to root. The return value indicates
- * whether the operation succeeded. Added in version 2.
+ * Returns Role Path and ONo Path from the Root Block to this object. The return
+ * value indicates whether the operation succeeded.
  * The return values of this method are
  *
- * - NamePath of type ``string[]``
+ * - RolePath of type ``string[]``
  * - ONoPath of type ``number[]``
  *
  * @method OcaAgent#GetPath
@@ -71,10 +68,3 @@ export const OcaAgent = make_control_class(
  *
  * @member {PropertyEvent<string>} OcaAgent#OnLabelChanged
  */
-/**
- * This event is emitted when the property ``Owner`` changes in the remote object.
- * The property ``Owner`` is described in the AES70 standard as follows.
- * Object number of block that contains this agent.
- *
- * @member {PropertyEvent<number>} OcaAgent#OnOwnerChanged
- */

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

@@ -1,9 +1,5 @@
 import { IOcaApplicationNetworkCommand } from '../../types/OcaApplicationNetworkCommand';
 import { OcaApplicationNetworkState } from '../../types/OcaApplicationNetworkState';
-import {
-  IOcaNetworkSystemInterfaceDescriptor,
-  OcaNetworkSystemInterfaceDescriptor,
-} from '../../types/OcaNetworkSystemInterfaceDescriptor';
 import { Arguments } from '../arguments';
 import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
@@ -23,9 +19,7 @@ export declare class OcaApplicationNetwork extends OcaRoot {
   /**
    * This event is emitted whenever SystemInterfaces changes.
    */
-  OnSystemInterfacesChanged: PropertyEvent<
-    OcaNetworkSystemInterfaceDescriptor[]
-  >;
+  OnSystemInterfacesChanged: PropertyEvent<Uint8Array[]>;
 
   /**
    * This event is emitted whenever State changes.
@@ -96,10 +90,10 @@ export declare class OcaApplicationNetwork extends OcaRoot {
    * status indicates whether the list was successfully retrieved.
    *
    * @method OcaApplicationNetwork#GetSystemInterfaces
-   * @returns {Promise<OcaNetworkSystemInterfaceDescriptor[]>}
-   *   A promise which resolves to a single value of type :class:`OcaNetworkSystemInterfaceDescriptor[]`.
+   * @returns {Promise<Uint8Array[]>}
+   *   A promise which resolves to a single value of type ``Uint8Array[]``.
    */
-  GetSystemInterfaces(): Promise<OcaNetworkSystemInterfaceDescriptor[]>;
+  GetSystemInterfaces(): Promise<Uint8Array[]>;
 
   /**
    * Sets the network's System Interface Descriptor(s). Return status indicates
@@ -107,13 +101,11 @@ export declare class OcaApplicationNetwork extends OcaRoot {
    * Descriptor may be set at construction time.
    *
    * @method OcaApplicationNetwork#SetSystemInterfaces
-   * @param {IOcaNetworkSystemInterfaceDescriptor[]} Descriptors
+   * @param {Uint8Array[]} Descriptors
    *
    * @returns {Promise<void>}
    */
-  SetSystemInterfaces(
-    Descriptors: IOcaNetworkSystemInterfaceDescriptor[]
-  ): Promise<void>;
+  SetSystemInterfaces(Descriptors: Uint8Array[]): Promise<void>;
 
   /**
    * Retrieves the network's state. Return status indicates whether the status
@@ -148,11 +140,11 @@ export declare class OcaApplicationNetwork extends OcaRoot {
   Control(Command: IOcaApplicationNetworkCommand): Promise<void>;
 
   /**
-   * Returns path from given object down to root. The return value indicates
-   * whether the operation succeeded.
+   * Returns Role Path and ONo Path from the Root Block to this object. The
+   * return value indicates whether the operation succeeded.
    * The return values of this method are
    *
-   * - NamePath of type ``string[]``
+   * - RolePath of type ``string[]``
    * - ONoPath of type ``number[]``
    *
    * @method OcaApplicationNetwork#GetPath

package/src/controller/ControlClasses/OcaApplicationNetwork.js

@@ -2,7 +2,6 @@ import { OcaApplicationNetworkCommand } from '../../OCP1/OcaApplicationNetworkCo
 import { OcaApplicationNetworkState } from '../../OCP1/OcaApplicationNetworkState.js';
 import { OcaBlob } from '../../OCP1/OcaBlob.js';
 import { OcaList } from '../../OCP1/OcaList.js';
-import { OcaNetworkSystemInterfaceDescriptor } from '../../OCP1/OcaNetworkSystemInterfaceDescriptor.js';
 import { OcaString } from '../../OCP1/OcaString.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
@@ -26,20 +25,8 @@ export const OcaApplicationNetwork = make_control_class(
     ['GetOwner', 2, 3, [], [OcaUint32]],
     ['GetServiceID', 2, 4, [], [OcaBlob]],
     ['SetServiceID', 2, 5, [OcaBlob], []],
-    [
-      'GetSystemInterfaces',
-      2,
-      6,
-      [],
-      [OcaList(OcaNetworkSystemInterfaceDescriptor)],
-    ],
-    [
-      'SetSystemInterfaces',
-      2,
-      7,
-      [OcaList(OcaNetworkSystemInterfaceDescriptor)],
-      [],
-    ],
+    ['GetSystemInterfaces', 2, 6, [], [OcaList(OcaBlob)]],
+    ['SetSystemInterfaces', 2, 7, [OcaList(OcaBlob)], []],
     ['GetState', 2, 8, [], [OcaApplicationNetworkState]],
     ['GetErrorCode', 2, 9, [], [OcaUint16]],
     ['Control', 2, 10, [OcaApplicationNetworkCommand], []],
@@ -47,17 +34,9 @@ export const OcaApplicationNetwork = make_control_class(
   ],
   [
     ['Label', [OcaString], 2, 1, false, true, null],
-    ['Owner', [OcaUint32], 2, 2, false, true, null],
+    ['Owner', [OcaUint32], 2, 2, true, false, null],
     ['ServiceID', [OcaBlob], 2, 3, false, false, null],
-    [
-      'SystemInterfaces',
-      [OcaList(OcaNetworkSystemInterfaceDescriptor)],
-      2,
-      4,
-      false,
-      false,
-      null,
-    ],
+    ['SystemInterfaces', [OcaList(OcaBlob)], 2, 4, false, false, null],
     ['State', [OcaApplicationNetworkState], 2, 5, false, false, null],
     ['ErrorCode', [OcaUint16], 2, 6, false, false, null],
   ],
@@ -111,8 +90,8 @@ export const OcaApplicationNetwork = make_control_class(
  * status indicates whether the list was successfully retrieved.
  *
  * @method OcaApplicationNetwork#GetSystemInterfaces
- * @returns {Promise<OcaNetworkSystemInterfaceDescriptor[]>}
- *   A promise which resolves to a single value of type :class:`OcaNetworkSystemInterfaceDescriptor[]`.
+ * @returns {Promise<Uint8Array[]>}
+ *   A promise which resolves to a single value of type ``Uint8Array[]``.
  */
 /**
  * Sets the network's System Interface Descriptor(s). Return status indicates
@@ -120,7 +99,7 @@ export const OcaApplicationNetwork = make_control_class(
  * Descriptor may be set at construction time.
  *
  * @method OcaApplicationNetwork#SetSystemInterfaces
- * @param {IOcaNetworkSystemInterfaceDescriptor[]} Descriptors
+ * @param {Uint8Array[]} Descriptors
  *
  * @returns {Promise<void>}
  */
@@ -151,11 +130,11 @@ export const OcaApplicationNetwork = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns path from given object down to root. The return value indicates
- * whether the operation succeeded.
+ * Returns Role Path and ONo Path from the Root Block to this object. The return
+ * value indicates whether the operation succeeded.
  * The return values of this method are
  *
- * - NamePath of type ``string[]``
+ * - RolePath of type ``string[]``
  * - ONoPath of type ``number[]``
  *
  * @method OcaApplicationNetwork#GetPath
@@ -181,7 +160,7 @@ export const OcaApplicationNetwork = make_control_class(
  * format is system and network dependent; for OCA purposes, it is maintained as
  * a variable-length blob which the protocol does not inspect.
  *
- * @member {PropertyEvent<OcaNetworkSystemInterfaceDescriptor[]>} OcaApplicationNetwork#OnSystemInterfacesChanged
+ * @member {PropertyEvent<Uint8Array[]>} OcaApplicationNetwork#OnSystemInterfacesChanged
  */
 /**
  * This event is emitted when the property ``State`` changes in the remote object.

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

@@ -7,8 +7,8 @@ import { RemoteDevice } from '../remote_device';
 import { OcaLevelSensor } from './OcaLevelSensor';
 
 /**
- * Child of **OcaLevelSensor** that returns an audio meter reading in dB
- * relative to a known reference level, and whose value has been calculated by
+ * Child of **OcaLevelSensor** that shall return an audio meter reading in dB
+ * relative to a known reference level, and whose value shall be calculated by
  * the selected averaging algorithm.
  * @extends OcaLevelSensor
  * @class OcaAudioLevelSensor
@@ -22,8 +22,7 @@ export declare class OcaAudioLevelSensor extends OcaLevelSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value of the Law property. The return value indicates whether the
-   * property was successfully retrieved.
+   * Gets the value of the **Law** property.
    *
    * @method OcaAudioLevelSensor#GetLaw
    * @returns {Promise<OcaLevelMeterLaw>}
@@ -32,9 +31,7 @@ export declare class OcaAudioLevelSensor extends OcaLevelSensor {
   GetLaw(): Promise<OcaLevelMeterLaw>;
 
   /**
-   * Sets the value of the Law property. The return value indicates whether the
-   * property was successfully set. Only implemented for objects whose Law
-   * property is read/write.
+   * Sets the value of the **Law** property.
    *
    * @method OcaAudioLevelSensor#SetLaw
    * @param {IOcaLevelMeterLaw} law

package/src/controller/ControlClasses/OcaAudioLevelSensor.js

@@ -3,8 +3,8 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaLevelSensor } from './OcaLevelSensor.js';
 
 /**
- * Child of **OcaLevelSensor** that returns an audio meter reading in dB
- * relative to a known reference level, and whose value has been calculated by
+ * Child of **OcaLevelSensor** that shall return an audio meter reading in dB
+ * relative to a known reference level, and whose value shall be calculated by
  * the selected averaging algorithm.
  * @extends OcaLevelSensor
  * @class OcaAudioLevelSensor
@@ -13,7 +13,7 @@ export const OcaAudioLevelSensor = make_control_class(
   'OcaAudioLevelSensor',
   5,
   '\u0001\u0001\u0002\u0002\u0001',
-  2,
+  3,
   OcaLevelSensor,
   [
     ['GetLaw', 5, 1, [], [OcaLevelMeterLaw]],
@@ -24,17 +24,14 @@ export const OcaAudioLevelSensor = make_control_class(
 );
 
 /**
- * Gets the value of the Law property. The return value indicates whether the
- * property was successfully retrieved.
+ * Gets the value of the **Law** property.
  *
  * @method OcaAudioLevelSensor#GetLaw
  * @returns {Promise<OcaLevelMeterLaw>}
  *   A promise which resolves to a single value of type :class:`OcaLevelMeterLaw`.
  */
 /**
- * Sets the value of the Law property. The return value indicates whether the
- * property was successfully set. Only implemented for objects whose Law
- * property is read/write.
+ * Sets the value of the **Law** property.
  *
  * @method OcaAudioLevelSensor#SetLaw
  * @param {IOcaLevelMeterLaw} law

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

@@ -5,7 +5,7 @@ import { OcaManager } from './OcaManager';
  * Placeholder for optional manager that in future versions of the standard will
  * hold various global audio processing parameters.
  *
- *  - May be instantiated once in any device.
+ *  - May be instantiated at most once in any device.
  *
  *  - If instantiated, object number must be 9.
  *

package/src/controller/ControlClasses/OcaAudioProcessingManager.js

@@ -5,7 +5,7 @@ import { OcaManager } from './OcaManager.js';
  * Placeholder for optional manager that in future versions of the standard will
  * hold various global audio processing parameters.
  *
- *  - May be instantiated once in any device.
+ *  - May be instantiated at most once in any device.
  *
  *  - If instantiated, object number must be 9.
  *
@@ -17,7 +17,7 @@ export const OcaAudioProcessingManager = make_control_class(
   'OcaAudioProcessingManager',
   3,
   '\u0001\u0003\t',
-  2,
+  3,
   OcaManager,
   [],
   [],

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

@@ -2,7 +2,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaActuator } from './OcaActuator';
 
 /**
- * Abstract base class for weakly typed actuators.
+ * Abstract base class for basic actuators.
  * @extends OcaActuator
  * @class OcaBasicActuator
  */

package/src/controller/ControlClasses/OcaBasicActuator.js

@@ -2,7 +2,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaActuator } from './OcaActuator.js';
 
 /**
- * Abstract base class for weakly typed actuators.
+ * Abstract base class for basic actuators.
  * @extends OcaActuator
  * @class OcaBasicActuator
  */
@@ -10,7 +10,7 @@ export const OcaBasicActuator = make_control_class(
   'OcaBasicActuator',
   4,
   '\u0001\u0001\u0001\u0001',
-  2,
+  3,
   OcaActuator,
   [],
   [],

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

@@ -2,7 +2,7 @@ import { RemoteDevice } from '../remote_device';
 import { OcaSensor } from './OcaSensor';
 
 /**
- * Abstract base class for weakly typed sensors.
+ * Abstract base class for basic sensors.
  * @extends OcaSensor
  * @class OcaBasicSensor
  */

package/src/controller/ControlClasses/OcaBasicSensor.js

@@ -2,7 +2,7 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaSensor } from './OcaSensor.js';
 
 /**
- * Abstract base class for weakly typed sensors.
+ * Abstract base class for basic sensors.
  * @extends OcaSensor
  * @class OcaBasicSensor
  */
@@ -10,7 +10,7 @@ export const OcaBasicSensor = make_control_class(
   'OcaBasicSensor',
   4,
   '\u0001\u0001\u0002\u0001',
-  2,
+  3,
   OcaSensor,
   [],
   [],

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

@@ -9,15 +9,19 @@ import { OcaBasicActuator } from './OcaBasicActuator';
  */
 export declare class OcaBitstringActuator extends OcaBasicActuator {
   /**
-   * This event is emitted whenever Bitstring changes.
+   * This event is emitted whenever Setting changes.
+   */
+  OnSettingChanged: PropertyEvent<boolean[]>;
+
+  /**
+   * An alias for OnSettingChanged
    */
   OnBitstringChanged: PropertyEvent<boolean[]>;
 
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the number of bits in the string. The return value indicates whether
-   * the property was successfully gathered.
+   * Gets the number of bits in the string.
    *
    * @method OcaBitstringActuator#GetNrBits
    * @returns {Promise<number>}
@@ -26,8 +30,7 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   GetNrBits(): Promise<number>;
 
   /**
-   * Gets the bit value of the given bit. The return value indicates whether the
-   * property was successfully gathered.
+   * Gets the bit value of the given bit.
    *
    * @method OcaBitstringActuator#GetBit
    * @param {number} bitNr
@@ -38,8 +41,7 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   GetBit(bitNr: number): Promise<boolean>;
 
   /**
-   * Sets the bit value of the given bit. The return value indicates whether the
-   * property was successfully set.
+   * Sets the bit value of the given bit.
    *
    * @method OcaBitstringActuator#SetBit
    * @param {number} bitNr
@@ -50,8 +52,17 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   SetBit(bitNr: number, Value: boolean): Promise<void>;
 
   /**
-   * Gets the entire bitstring.The return value indicates whether the property
-   * was successfully gathered.
+   * Gets the entire bitstring.
+   *
+   * @method OcaBitstringActuator#GetSetting
+   * @returns {Promise<boolean[]>}
+   *   A promise which resolves to a single value of type ``boolean[]``.
+   */
+  GetSetting(): Promise<boolean[]>;
+
+  /**
+   * Gets the entire bitstring.
+   * An alias for GetSetting.
    *
    * @method OcaBitstringActuator#GetBitstring
    * @returns {Promise<boolean[]>}
@@ -60,13 +71,23 @@ export declare class OcaBitstringActuator extends OcaBasicActuator {
   GetBitstring(): Promise<boolean[]>;
 
   /**
-   * Sets the entire bitstring. The return value indicates whether the property
-   * was successfully set.
+   * Sets the entire bitstring.
+   *
+   * @method OcaBitstringActuator#SetSetting
+   * @param {boolean[]} Setting
+   *
+   * @returns {Promise<void>}
+   */
+  SetSetting(Setting: boolean[]): Promise<void>;
+
+  /**
+   * Sets the entire bitstring.
+   * An alias for SetSetting.
    *
    * @method OcaBitstringActuator#SetBitstring
-   * @param {boolean[]} BitString
+   * @param {boolean[]} Setting
    *
    * @returns {Promise<void>}
    */
-  SetBitstring(BitString: boolean[]): Promise<void>;
+  SetBitstring(Setting: boolean[]): Promise<void>;
 }

package/src/controller/ControlClasses/OcaBitstringActuator.js

@@ -13,30 +13,28 @@ export const OcaBitstringActuator = make_control_class(
   'OcaBitstringActuator',
   5,
   '\u0001\u0001\u0001\u0001\r',
-  2,
+  3,
   OcaBasicActuator,
   [
     ['GetNrBits', 5, 1, [], [OcaUint16]],
     ['GetBit', 5, 2, [OcaUint16], [OcaBoolean]],
     ['SetBit', 5, 3, [OcaUint16, OcaBoolean], []],
-    ['GetBitstring', 5, 4, [], [OcaBitstring]],
-    ['SetBitstring', 5, 5, [OcaBitstring], []],
+    ['GetSetting', 5, 4, [], [OcaBitstring], ['GetBitstring']],
+    ['SetSetting', 5, 5, [OcaBitstring], [], ['SetBitstring']],
   ],
-  [['Bitstring', [OcaBitstring], 5, 1, false, false, null]],
+  [['Setting', [OcaBitstring], 5, 1, false, false, ['Bitstring']]],
   []
 );
 
 /**
- * Gets the number of bits in the string. The return value indicates whether the
- * property was successfully gathered.
+ * Gets the number of bits in the string.
  *
  * @method OcaBitstringActuator#GetNrBits
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the bit value of the given bit. The return value indicates whether the
- * property was successfully gathered.
+ * Gets the bit value of the given bit.
  *
  * @method OcaBitstringActuator#GetBit
  * @param {number} bitNr
@@ -45,8 +43,7 @@ export const OcaBitstringActuator = make_control_class(
  *   A promise which resolves to a single value of type ``boolean``.
  */
 /**
- * Sets the bit value of the given bit. The return value indicates whether the
- * property was successfully set.
+ * Sets the bit value of the given bit.
  *
  * @method OcaBitstringActuator#SetBit
  * @param {number} bitNr
@@ -55,26 +52,46 @@ export const OcaBitstringActuator = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the entire bitstring.The return value indicates whether the property was
- * successfully gathered.
+ * Gets the entire bitstring.
+ *
+ * @method OcaBitstringActuator#GetSetting
+ * @returns {Promise<boolean[]>}
+ *   A promise which resolves to a single value of type ``boolean[]``.
+ */
+/**
+ * Gets the entire bitstring.
+ * An alias for GetSetting.
  *
  * @method OcaBitstringActuator#GetBitstring
  * @returns {Promise<boolean[]>}
  *   A promise which resolves to a single value of type ``boolean[]``.
  */
 /**
- * Sets the entire bitstring. The return value indicates whether the property
- * was successfully set.
+ * Sets the entire bitstring.
+ *
+ * @method OcaBitstringActuator#SetSetting
+ * @param {boolean[]} Setting
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Sets the entire bitstring.
+ * An alias for SetSetting.
  *
  * @method OcaBitstringActuator#SetBitstring
- * @param {boolean[]} BitString
+ * @param {boolean[]} Setting
  *
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property ``Bitstring`` changes in the remote object.
- * The property ``Bitstring`` is described in the AES70 standard as follows.
- * The bitstring data.
+ * This event is emitted when the property ``Setting`` changes in the remote object.
+ * The property ``Setting`` is described in the AES70 standard as follows.
+ * The bitstring data. New name for v3 of this class.
+ *
+ * @member {PropertyEvent<boolean[]>} OcaBitstringActuator#OnSettingChanged
+ */
+/**
+ * An alias for OnSettingChanged
  *
  * @member {PropertyEvent<boolean[]>} OcaBitstringActuator#OnBitstringChanged
  */

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

@@ -9,15 +9,19 @@ import { OcaBasicSensor } from './OcaBasicSensor';
  */
 export declare class OcaBitstringSensor extends OcaBasicSensor {
   /**
-   * This event is emitted whenever BitString changes.
+   * This event is emitted whenever Reading changes.
+   */
+  OnReadingChanged: PropertyEvent<boolean[]>;
+
+  /**
+   * An alias for OnReadingChanged
    */
   OnBitStringChanged: PropertyEvent<boolean[]>;
 
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the number of bits of the bitmask data. Returned status indicates
-   * success or failure of the retrieval.
+   * Gets the number of bits of the bitstring data.
    *
    * @method OcaBitstringSensor#GetNrBits
    * @returns {Promise<number>}
@@ -26,8 +30,7 @@ export declare class OcaBitstringSensor extends OcaBasicSensor {
   GetNrBits(): Promise<number>;
 
   /**
-   * Gets the value of the given bit. Return status indicates success or failure
-   * of the retrieval.
+   * Gets the value of the given bit.
    *
    * @method OcaBitstringSensor#GetBit
    * @param {number} bitNr
@@ -38,8 +41,17 @@ export declare class OcaBitstringSensor extends OcaBasicSensor {
   GetBit(bitNr: number): Promise<number>;
 
   /**
-   * Gets the entire bitstring. Return status indicates success or failure of
-   * the retrieval.
+   * Gets the entire bitstring.
+   *
+   * @method OcaBitstringSensor#GetReading
+   * @returns {Promise<boolean[]>}
+   *   A promise which resolves to a single value of type ``boolean[]``.
+   */
+  GetReading(): Promise<boolean[]>;
+
+  /**
+   * Gets the entire bitstring.
+   * An alias for GetReading.
    *
    * @method OcaBitstringSensor#GetBitString
    * @returns {Promise<boolean[]>}