aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaStreamNetwork.js

@@ -1,5 +1,3 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaAgent } from './OcaAgent.js';
 import { OcaBlob } from '../../OCP1/OcaBlob.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaNetworkControlProtocol } from '../../OCP1/OcaNetworkControlProtocol.js';
@@ -9,9 +7,16 @@ import { OcaNetworkStatistics } from '../../OCP1/OcaNetworkStatistics.js';
 import { OcaNetworkStatus } from '../../OCP1/OcaNetworkStatus.js';
 import { OcaNetworkSystemInterfaceID } from '../../OCP1/OcaNetworkSystemInterfaceID.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
 
 /**
- *  **DEPRECATED CLASS**   *Replaced by class*  **OcaMediaTransportNetwork **  *in version 3 of Connection Management (CM3)*  Abstract base class for defining network classes to which this device belongs. May be a media transport network, a control and monitoring network, or a network that does both. There shall be one OcaStreamNetwork instance for each network to which the device belongs. This class may be subclassed to support networks of various types.
+ * **DEPRECATED CLASS** *Replaced by class* **OcaMediaTransportNetwork ***in
+ * version 3 of Connection Management (CM3)* Abstract base class for defining
+ * network classes to which this device belongs. May be a media transport
+ * network, a control and monitoring network, or a network that does both. There
+ * shall be one OcaStreamNetwork instance for each network to which the device
+ * belongs. This class may be subclassed to support networks of various types.
  * @extends OcaAgent
  * @class OcaStreamNetwork
  */
@@ -68,21 +73,24 @@ export const OcaStreamNetwork = make_control_class(
 );
 
 /**
- * Gets the network's link type (wired Ethernet, USB, etc.). Return status indicates whether the operation was successful.
+ * Gets the network's link type (wired Ethernet, USB, etc.). Return status
+ * indicates whether the operation was successful.
  *
  * @method OcaStreamNetwork#GetLinkType
  * @returns {Promise<OcaNetworkLinkType>}
  *   A promise which resolves to a single value of type :class:`OcaNetworkLinkType`.
  */
 /**
- * Gets the network's IDAdvertised. Return status indicates whether the operation was successful.
+ * Gets the network's IDAdvertised. Return status indicates whether the
+ * operation was successful.
  *
  * @method OcaStreamNetwork#GetIDAdvertised
  * @returns {Promise<Uint8Array>}
  *   A promise which resolves to a single value of type ``Uint8Array``.
  */
 /**
- * Sets the network's IDAdvertised. Return status indicates whether the operation was successful.
+ * Sets the network's IDAdvertised. Return status indicates whether the
+ * operation was successful.
  *
  * @method OcaStreamNetwork#SetIDAdvertised
  * @param {Uint8Array} Name
@@ -90,63 +98,85 @@ export const OcaStreamNetwork = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the network's ControlProtocol property. Return status indicates whether the operation was successful.
+ * Gets the network's ControlProtocol property. Return status indicates whether
+ * the operation was successful.
  *
  * @method OcaStreamNetwork#GetControlProtocol
  * @returns {Promise<OcaNetworkControlProtocol>}
  *   A promise which resolves to a single value of type :class:`OcaNetworkControlProtocol`.
  */
 /**
- * Gets the network's MediaProtocol property. Return status indicates whether the operation was successful.
+ * Gets the network's MediaProtocol property. Return status indicates whether
+ * the operation was successful.
  *
  * @method OcaStreamNetwork#GetMediaProtocol
  * @returns {Promise<OcaNetworkMediaProtocol>}
  *   A promise which resolves to a single value of type :class:`OcaNetworkMediaProtocol`.
  */
 /**
- * Retrieves the network's status. Return status indicates whether the status was successfully retrieved.
+ * Retrieves the network's status. Return status indicates whether the status
+ * was successfully retrieved.
  *
  * @method OcaStreamNetwork#GetStatus
  * @returns {Promise<OcaNetworkStatus>}
  *   A promise which resolves to a single value of type :class:`OcaNetworkStatus`.
  */
 /**
- * Retrieves network error statistics counter values. Return status indicates whether the values were successfully retrieved.
+ * Retrieves network error statistics counter values. Return status indicates
+ * whether the values were successfully retrieved.
  *
  * @method OcaStreamNetwork#GetStatistics
  * @returns {Promise<OcaNetworkStatistics>}
  *   A promise which resolves to a single value of type :class:`OcaNetworkStatistics`.
  */
 /**
- * Resets network error statistics counters. Return status indicates whether the counters were successfully reset.
+ * Resets network error statistics counters. Return status indicates whether the
+ * counters were successfully reset.
  *
  * @method OcaStreamNetwork#ResetStatistics
  * @returns {Promise<void>}
  */
 /**
- * Gets the list of system interface IDs that this network is using. Return status indicates success of the operation.
+ * Gets the list of system interface IDs that this network is using. Return
+ * status indicates success of the operation.
  *
  * @method OcaStreamNetwork#GetSystemInterfaces
  * @returns {Promise<OcaNetworkSystemInterfaceID[]>}
- *   A promise which resolves to a single value of type ``OcaNetworkSystemInterfaceID[]``.
+ *   A promise which resolves to a single value of type :class:`OcaNetworkSystemInterfaceID[]`.
  */
 /**
- * Sets the list of system interface IDs that this network will use. Return status indicates success of the operation. This method is not implemented by all network implementations.
+ * Sets the list of system interface IDs that this network will use. Return
+ * status indicates success of the operation. This method is not implemented by
+ * all network implementations.
  *
  * @method OcaStreamNetwork#SetSystemInterfaces
- * @param {OcaNetworkSystemInterfaceID[]} Interfaces
+ * @param {IOcaNetworkSystemInterfaceID[]} Interfaces
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the list of object numbers of Source  **OcaStreamConnector** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when  **OcaStreamConnector** objects'  **Owner**  properties are updated, or when  **OcaStreamConnector**  objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
+ * Gets the list of object numbers of Source **OcaStreamConnector** objects
+ * owned by this network. Return status indicates success of the operation. If
+ * the value of the network's MediaProtocol property is NONE, this method will
+ * return the status value InvalidRequest. Members are added to and deleted from
+ * this list when **OcaStreamConnector** objects' **Owner** properties are
+ * updated, or when **OcaStreamConnector** objects are deleted. For
+ * reconfigurable devices, such changes may be initiated by controllers during
+ * device operation.
  *
  * @method OcaStreamNetwork#GetStreamConnectorsSource
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * Sets the list of object numbers of Source  **OcaStreamConnector** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when  **OcaStreamConnector** objects'  **Owner**  properties are updated, or when  **OcaStreamConnector**  objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
+ * Sets the list of object numbers of Source **OcaStreamConnector** objects
+ * owned by this network. Return status indicates success of the operation. If
+ * the value of the network's MediaProtocol property is NONE, this method will
+ * return the status value InvalidRequest. Members are added to and deleted from
+ * this list when **OcaStreamConnector** objects' **Owner** properties are
+ * updated, or when **OcaStreamConnector** objects are deleted. For
+ * reconfigurable devices, such changes may be initiated by controllers during
+ * device operation.
  *
  * @method OcaStreamNetwork#SetStreamConnectorsSource
  * @param {number[]} StreamConnectors
@@ -154,14 +184,28 @@ export const OcaStreamNetwork = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the list of object numbers of Sink  **OcaStreamConnector** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when  **OcaStreamConnector**  objects'  **Owner**  properties are updated, or when  **OcaStreamConnector** objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
+ * Gets the list of object numbers of Sink **OcaStreamConnector** objects owned
+ * by this network. Return status indicates success of the operation. If the
+ * value of the network's MediaProtocol property is NONE, this method will
+ * return the status value InvalidRequest. Members are added to and deleted from
+ * this list when **OcaStreamConnector** objects' **Owner** properties are
+ * updated, or when **OcaStreamConnector** objects are deleted. For
+ * reconfigurable devices, such changes may be initiated by controllers during
+ * device operation.
  *
  * @method OcaStreamNetwork#GetStreamConnectorsSink
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * Sets the list of object numbers of Sink  **OcaStreamConnector** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when  **OcaStreamConnector**  objects'  **Owner**  properties are updated, or when  **OcaStreamConnector**  objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
+ * Sets the list of object numbers of Sink **OcaStreamConnector** objects owned
+ * by this network. Return status indicates success of the operation. If the
+ * value of the network's MediaProtocol property is NONE, this method will
+ * return the status value InvalidRequest. Members are added to and deleted from
+ * this list when **OcaStreamConnector** objects' **Owner** properties are
+ * updated, or when **OcaStreamConnector** objects are deleted. For
+ * reconfigurable devices, such changes may be initiated by controllers during
+ * device operation.
  *
  * @method OcaStreamNetwork#SetStreamConnectorsSink
  * @param {number[]} StreamConnectors
@@ -169,14 +213,28 @@ export const OcaStreamNetwork = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the list of object numbers of Source  **OcaNetworkSignalChannel** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when  **OcaNetworkSignalChannel**  objects'  **Owner**  properties are updated, or when  **OcaNetworkSignalChannel**  objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
+ * Gets the list of object numbers of Source **OcaNetworkSignalChannel** objects
+ * owned by this network. Return status indicates success of the operation. If
+ * the value of the network's MediaProtocol property is NONE, this method will
+ * return the status value InvalidRequest. Members are added to and deleted from
+ * this list when **OcaNetworkSignalChannel** objects' **Owner** properties are
+ * updated, or when **OcaNetworkSignalChannel** objects are deleted. For
+ * reconfigurable devices, such changes may be initiated by controllers during
+ * device operation.
  *
  * @method OcaStreamNetwork#GetSignalChannelsSource
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * Sets the list of object numbers of Source  **OcaNetworkSignalChannel** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when  **OcaNetworkSignalChannel**  objects'  **Owner**  properties are updated, or when  **OcaNetworkSignalChannel**  objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
+ * Sets the list of object numbers of Source **OcaNetworkSignalChannel** objects
+ * owned by this network. Return status indicates success of the operation. If
+ * the value of the network's MediaProtocol property is NONE, this method will
+ * return the status value InvalidRequest. Members are added to and deleted from
+ * this list when **OcaNetworkSignalChannel** objects' **Owner** properties are
+ * updated, or when **OcaNetworkSignalChannel** objects are deleted. For
+ * reconfigurable devices, such changes may be initiated by controllers during
+ * device operation.
  *
  * @method OcaStreamNetwork#SetSignalChannelsSource
  * @param {number[]} SignalChannels
@@ -184,14 +242,28 @@ export const OcaStreamNetwork = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the list of object numbers of Sink  **OcaNetworkSignalChannel** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when  **OcaNetworkSignalChannel**  objects'  **Owner**  properties are updated, or when  **OcaNetworkSignalChannel**  objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
+ * Gets the list of object numbers of Sink **OcaNetworkSignalChannel** objects
+ * owned by this network. Return status indicates success of the operation. If
+ * the value of the network's MediaProtocol property is NONE, this method will
+ * return the status value InvalidRequest. Members are added to and deleted from
+ * this list when **OcaNetworkSignalChannel** objects' **Owner** properties are
+ * updated, or when **OcaNetworkSignalChannel** objects are deleted. For
+ * reconfigurable devices, such changes may be initiated by controllers during
+ * device operation.
  *
  * @method OcaStreamNetwork#GetSignalChannelsSink
  * @returns {Promise<number[]>}
  *   A promise which resolves to a single value of type ``number[]``.
  */
 /**
- * Sets the list of object numbers of Sink  **OcaNetworkSignalChannel** objects owned by this network. Return status indicates success of the operation. If the value of the network's MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when  **OcaNetworkSignalChannel**  objects'  **Owner**  properties are updated, or when  **OcaNetworkSignalChannel**  objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.
+ * Sets the list of object numbers of Sink **OcaNetworkSignalChannel** objects
+ * owned by this network. Return status indicates success of the operation. If
+ * the value of the network's MediaProtocol property is NONE, this method will
+ * return the status value InvalidRequest. Members are added to and deleted from
+ * this list when **OcaNetworkSignalChannel** objects' **Owner** properties are
+ * updated, or when **OcaNetworkSignalChannel** objects are deleted. For
+ * reconfigurable devices, such changes may be initiated by controllers during
+ * device operation.
  *
  * @method OcaStreamNetwork#SetSignalChannelsSink
  * @param {number[]} SignalChannels
@@ -211,85 +283,83 @@ export const OcaStreamNetwork = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property ControlProtocol changes in the remote object.
+ * This event is emitted when the property ``ControlProtocol`` changes in the remote object.
  * The property ``ControlProtocol`` is described in the AES70 standard as follows.
- * Type of control protocol used by the network (OCAnn) or NONE if this
- * network is not used for control.
+ * Type of control protocol used by the network (OCAnn) or NONE if this network
+ * is not used for control.
  *
  * @member {PropertyEvent<OcaNetworkControlProtocol>} OcaStreamNetwork#OnControlProtocolChanged
  */
 /**
- * This event is emitted when the property IDAdvertised changes in the remote object.
+ * This event is emitted when the property ``IDAdvertised`` changes in the remote object.
  * The property ``IDAdvertised`` is described in the AES70 standard as follows.
- * ID by which this device is known on the network, i.e. the host name or
- * GUID that this device publishes in the network's directory/discovery
- * system.
+ * ID by which this device is known on the network, i.e. the host name or GUID
+ * that this device publishes in the network's directory/discovery system.
  *
  * @member {PropertyEvent<Uint8Array>} OcaStreamNetwork#OnIDAdvertisedChanged
  */
 /**
- * This event is emitted when the property MediaProtocol changes in the remote object.
+ * This event is emitted when the property ``MediaProtocol`` changes in the remote object.
  * The property ``MediaProtocol`` is described in the AES70 standard as follows.
- * Type of media transport protocol used by the network, or NONE if this
- * network is not used for media transport.
+ * Type of media transport protocol used by the network, or NONE if this network
+ * is not used for media transport.
  *
  * @member {PropertyEvent<OcaNetworkMediaProtocol>} OcaStreamNetwork#OnMediaProtocolChanged
  */
 /**
- * This event is emitted when the property SignalChannelsSink changes in the remote object.
+ * This event is emitted when the property ``SignalChannelsSink`` changes in the remote object.
  * The property ``SignalChannelsSink`` is described in the AES70 standard as follows.
- * List of object numbers of <u>sink </u><b>OcaNetworkSignalChannel
- * </b>objects collected by this network.
+ * List of object numbers of sink **OcaNetworkSignalChannel** objects collected
+ * by this network.
  *
  * @member {PropertyEvent<number[]>} OcaStreamNetwork#OnSignalChannelsSinkChanged
  */
 /**
- * This event is emitted when the property SignalChannelsSource changes in the remote object.
+ * This event is emitted when the property ``SignalChannelsSource`` changes in the remote object.
  * The property ``SignalChannelsSource`` is described in the AES70 standard as follows.
- * List of object numbers of <u>source </u><b>OcaNetworkSignalChannel
- * </b>objects collected by this network.
+ * List of object numbers of source **OcaNetworkSignalChannel** objects
+ * collected by this network.
  *
  * @member {PropertyEvent<number[]>} OcaStreamNetwork#OnSignalChannelsSourceChanged
  */
 /**
- * This event is emitted when the property Statistics changes in the remote object.
+ * This event is emitted when the property ``Statistics`` changes in the remote object.
  * The property ``Statistics`` is described in the AES70 standard as follows.
  * Error statistics for this network
  *
  * @member {PropertyEvent<OcaNetworkStatistics>} OcaStreamNetwork#OnStatisticsChanged
  */
 /**
- * This event is emitted when the property Status changes in the remote object.
+ * This event is emitted when the property ``Status`` changes in the remote object.
  * The property ``Status`` is described in the AES70 standard as follows.
  * Operational status of the network.
  *
  * @member {PropertyEvent<OcaNetworkStatus>} OcaStreamNetwork#OnStatusChanged
  */
 /**
- * This event is emitted when the property StreamConnectorsSink changes in the remote object.
+ * This event is emitted when the property ``StreamConnectorsSink`` changes in the remote object.
  * The property ``StreamConnectorsSink`` is described in the AES70 standard as follows.
- * List of object numbers of <u>sink </u><b>OcaStreamConnector
- * </b>objects collected by this network.
+ * List of object numbers of sink **OcaStreamConnector** objects collected by
+ * this network.
  *
  * @member {PropertyEvent<number[]>} OcaStreamNetwork#OnStreamConnectorsSinkChanged
  */
 /**
- * This event is emitted when the property StreamConnectorsSource changes in the remote object.
+ * This event is emitted when the property ``StreamConnectorsSource`` changes in the remote object.
  * The property ``StreamConnectorsSource`` is described in the AES70 standard as follows.
- * List of object numbers of <u>source </u><b>OcaStreamConnector
- * </b>objects collected by this network.
+ * List of object numbers of source **OcaStreamConnector** objects collected by
+ * this network.
  *
  * @member {PropertyEvent<number[]>} OcaStreamNetwork#OnStreamConnectorsSourceChanged
  */
 /**
- * This event is emitted when the property SystemInterfaces changes in the remote object.
+ * This event is emitted when the property ``SystemInterfaces`` changes in the remote object.
  * The property ``SystemInterfaces`` is described in the AES70 standard as follows.
- * Collection of identifiers of system interface(s) used by the network.
- * A "system interface" is the system service through which network
- * traffic passes into and out of the device -- e.g. a socket. The
- * identifier format is system and network dependent; for OCA purposes,
- * it is maintained as a variable-length blob which the protocol does not
- * inspect.
+ * Collection of identifiers of system interface(s) used by the network. A
+ * "system interface" is the system service through which network traffic passes
+ * into and out of the device -- e.g. a socket. The identifier 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<OcaNetworkSystemInterfaceID[]>} OcaStreamNetwork#OnSystemInterfacesChanged
  */

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

@@ -1,8 +1,7 @@
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaBasicActuator } from './OcaBasicActuator';
 
-import { PropertyEvent } from '../property_event';
-
 /**
  * String actuator.
  * @extends OcaBasicActuator
@@ -17,7 +16,8 @@ export declare class OcaStringActuator extends OcaBasicActuator {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the value and max length of the Value property. The return value indicates whether the data was successfully retrieved.
+   * Gets the value and max length of the Value property. The return value
+   * indicates whether the data was successfully retrieved.
    *
    * @method OcaStringActuator#GetSetting
    * @returns {Promise<string>}
@@ -26,7 +26,8 @@ export declare class OcaStringActuator extends OcaBasicActuator {
   GetSetting(): Promise<string>;
 
   /**
-   * Sets the value of the Value property. The return value indicates whether the property was successfully set.
+   * Sets the value of the Value property. The return value indicates whether
+   * the property was successfully set.
    *
    * @method OcaStringActuator#SetSetting
    * @param {string} Value

package/src/controller/ControlClasses/OcaStringActuator.js

@@ -1,7 +1,7 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaBasicActuator } from './OcaBasicActuator.js';
 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';
 
 /**
  * String actuator.
@@ -27,14 +27,16 @@ export const OcaStringActuator = make_control_class(
 );
 
 /**
- * Gets the value and max length of the Value property. The return value indicates whether the data was successfully retrieved.
+ * Gets the value and max length of the Value property. The return value
+ * indicates whether the data was successfully retrieved.
  *
  * @method OcaStringActuator#GetSetting
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Sets the value of the Value property. The return value indicates whether the property was successfully set.
+ * Sets the value of the Value property. The return value indicates whether the
+ * property was successfully set.
  *
  * @method OcaStringActuator#SetSetting
  * @param {string} Value
@@ -49,7 +51,7 @@ export const OcaStringActuator = make_control_class(
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * This event is emitted when the property Setting changes in the remote object.
+ * This event is emitted when the property ``Setting`` changes in the remote object.
  * The property ``Setting`` is described in the AES70 standard as follows.
  * Value.
  *

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

@@ -1,8 +1,7 @@
+import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
 import { OcaBasicSensor } from './OcaBasicSensor';
 
-import { PropertyEvent } from '../property_event';
-
 /**
  * Text string sensor.
  * @extends OcaBasicSensor
@@ -22,7 +21,8 @@ export declare class OcaStringSensor extends OcaBasicSensor {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets the entire string. Return status indicates success or failure of the retrieval.
+   * Gets the entire string. Return status indicates success or failure of the
+   * retrieval.
    *
    * @method OcaStringSensor#GetString
    * @returns {Promise<string>}
@@ -31,7 +31,8 @@ export declare class OcaStringSensor extends OcaBasicSensor {
   GetString(): Promise<string>;
 
   /**
-   * Gets the maximum number of bytes that may be returned. Returned status indicates success or failure of the retrieval.
+   * Gets the maximum number of bytes that may be returned. Returned status
+   * indicates success or failure of the retrieval.
    *
    * @method OcaStringSensor#GetMaxLen
    * @returns {Promise<number>}
@@ -40,7 +41,8 @@ export declare class OcaStringSensor extends OcaBasicSensor {
   GetMaxLen(): Promise<number>;
 
   /**
-   * Sets the maximum number of bytes that the object may return. Returned status indicates success or failure of the set.
+   * Sets the maximum number of bytes that the object may return. Returned
+   * status indicates success or failure of the set.
    *
    * @method OcaStringSensor#SetMaxLen
    * @param {number} maxLen

package/src/controller/ControlClasses/OcaStringSensor.js

@@ -1,7 +1,7 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaBasicSensor } from './OcaBasicSensor.js';
 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';
 
 /**
  * Text string sensor.
@@ -27,21 +27,24 @@ export const OcaStringSensor = make_control_class(
 );
 
 /**
- * Gets the entire string. Return status indicates success or failure of the retrieval.
+ * Gets the entire string. Return status indicates success or failure of the
+ * retrieval.
  *
  * @method OcaStringSensor#GetString
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Gets the maximum number of bytes that may be returned. Returned status indicates success or failure of the retrieval.
+ * Gets the maximum number of bytes that may be returned. Returned status
+ * indicates success or failure of the retrieval.
  *
  * @method OcaStringSensor#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. Returned status indicates success or failure of the set.
+ * Sets the maximum number of bytes that the object may return. Returned status
+ * indicates success or failure of the set.
  *
  * @method OcaStringSensor#SetMaxLen
  * @param {number} maxLen
@@ -49,14 +52,14 @@ export const OcaStringSensor = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property String changes in the remote object.
+ * This event is emitted when the property ``String`` changes in the remote object.
  * The property ``String`` is described in the AES70 standard as follows.
  * The string.
  *
  * @member {PropertyEvent<string>} OcaStringSensor#OnStringChanged
  */
 /**
- * This event is emitted when the property MaxLen changes in the remote object.
+ * 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 string. May be readonly in some
  * implementations.