OcaDeviceManager¶

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaManager().

This class defines the properties

Name	JavaScript Type	AES70 Type
ModelGUID	OcaModelGUID	OcaModelGUID
SerialNumber	string	OcaString
ModelDescription	OcaModelDescription	OcaModelDescription
DeviceName	string	OcaString
OcaVersion	number	OcaUint16
DeviceRole	string	OcaString
UserInventoryCode	string	OcaString
Enabled	boolean	OcaBoolean
State	OcaDeviceState	OcaDeviceState
Busy	boolean	OcaBoolean
ResetCause	OcaResetCause	OcaResetCause
Message	string	OcaString
Managers	OcaManagerDescriptor[]	OcaList<OcaManagerDescriptor>
DeviceRevisionID	string	OcaString

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, ModelGUID, SerialNumber, ModelDescription, DeviceName, OcaVersion, DeviceRole, UserInventoryCode, Enabled, State, Busy, ResetCause, Message, Managers and DeviceRevisionID.

class OcaDeviceManager(objectNumber, device)¶

Mandatory manager that contains information relevant to the whole device.

Must be instantiated once in every device.

Must have object number 1.

OcaDeviceManager.OnBusyChanged¶

type: PropertyEvent.<boolean>

This event is emitted when the property Busy changes in the remote object. The property Busy is described in the AES70 standard as follows. True iff device is working on something and is not available for OCA command activity. Readonly.

OcaDeviceManager.OnDeviceNameChanged¶

type: PropertyEvent.<string>

This event is emitted when the property DeviceName changes in the remote object. The property DeviceName is described in the AES70 standard as follows. Name of the device. Should be unique manufacturer-qualified identifier.

OcaDeviceManager.OnDeviceRoleChanged¶

type: PropertyEvent.<string>

This event is emitted when the property DeviceRole changes in the remote object. The property DeviceRole is described in the AES70 standard as follows. Role of device in application (arbitrary).

OcaDeviceManager.OnEnabledChanged¶

type: PropertyEvent.<boolean>

This event is emitted when the property Enabled changes in the remote object. The property Enabled is described in the AES70 standard as follows. Indicates whether the device is enabled (and therefore operational).

OcaDeviceManager.OnManagersChanged¶

type: PropertyEvent.<Array.<OcaManagerDescriptor>>

This event is emitted when the property Managers changes in the remote object. The property Managers is described in the AES70 standard as follows. List of all manager objects instantiated in this device.

OcaDeviceManager.OnMessageChanged¶

type: PropertyEvent.<string>

This event is emitted when the property Message changes in the remote object. The property Message is described in the AES70 standard as follows. Arbitrary text message provided by controller. Display and handling of the text is device-dependent and not defined by OCA.

OcaDeviceManager.OnModelDescriptionChanged¶

type: PropertyEvent.<OcaModelDescription>

This event is emitted when the property ModelDescription changes in the remote object. The property ModelDescription is described in the AES70 standard as follows. Read-only property that contains text names for this model, its manufacturer, and its version.

OcaDeviceManager.OnModelGUIDChanged¶

type: PropertyEvent.<OcaModelGUID>

This event is emitted when the property ModelGUID changes in the remote object. The property ModelGUID is described in the AES70 standard as follows. Read-only property that identifies the model of the device. Note this property is not equivalent to a MAC address, because (a) MAC addresses identify individual devices, not models, and (b) MAC addresses are Ethernet-specific, but an OCA device need not have an Ethernet port.

OcaDeviceManager.OnOcaVersionChanged¶

type: PropertyEvent.<number>

This event is emitted when the property OcaVersion changes in the remote object. The property OcaVersion is described in the AES70 standard as follows. Read-only property that indicates the AES70 version number used by the device.

OcaDeviceManager.OnResetCauseChanged¶

type: PropertyEvent.<OcaResetCause>

This event is emitted when the property ResetCause changes in the remote object. The property ResetCause is described in the AES70 standard as follows. Read-only attribute that indicates the reset cause of the last reset.

OcaDeviceManager.OnSerialNumberChanged¶

type: PropertyEvent.<string>

This event is emitted when the property SerialNumber changes in the remote object. The property SerialNumber is described in the AES70 standard as follows. Read-only property that identifies the serial number of the CAP device.

OcaDeviceManager.OnStateChanged¶

type: PropertyEvent.<OcaDeviceState>

This event is emitted when the property State changes in the remote object. The property State is described in the AES70 standard as follows. Read-only property that indicates the current state of the device.

OcaDeviceManager.OnUserInventoryCodeChanged¶

type: PropertyEvent.<string>

This event is emitted when the property UserInventoryCode changes in the remote object. The property UserInventoryCode is described in the AES70 standard as follows. Code used for equipment tracking.

OcaDeviceManager.ClearResetCause()¶

Clears the ResetCause property, i.e. resets it to the default value ‘PowerOn’. Must be used after the reset cause has been read out to ensure differentation between reconnects due to network loss and reconnects due to external or internal reset. Offered as a separate method (instead of implicitly clearing the cause after it has been read out) to accomodate systems that have multiple controllers. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<void> –

OcaDeviceManager.GetDeviceName()¶

Gets the device name. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<string> – A promise which resolves to a single value of type string.

OcaDeviceManager.GetDeviceRevisionID()¶

Gets the value of property DeviceRevisionID . Return value indicates whether value was successfully retrieved.

Returns: Promise.<string> – A promise which resolves to a single value of type string.

OcaDeviceManager.GetDeviceRole()¶

Gets the value of the Role property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<string> – A promise which resolves to a single value of type string.

OcaDeviceManager.GetEnabled()¶

Gets the value of the Enabled property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<boolean> – A promise which resolves to a single value of type boolean.

OcaDeviceManager.GetManagers()¶

Retrive the list of descriptors of managers instantiated in this device. The return value indicates whether the retrieval was successful.

Returns: Promise.<Array.<OcaManagerDescriptor>> – A promise which resolves to a single value of type OcaManagerDescriptor[].

OcaDeviceManager.GetMessage()¶

Gets the value of property Message . Return value indicates whether value was successfully retrieved.

Returns: Promise.<string> – A promise which resolves to a single value of type string.

OcaDeviceManager.GetModelDescription()¶

Gets the model description. The return value indicates whether the description was successfully retrieved.

Returns: Promise.<OcaModelDescription> – A promise which resolves to a single value of type OcaModelDescription().

OcaDeviceManager.GetModelGUID()¶

Gets the model GUID. The return value indicates whether the GUID was successfully retrieved.

Returns: Promise.<OcaModelGUID> – A promise which resolves to a single value of type OcaModelGUID().

OcaDeviceManager.GetOcaVersion()¶

Gets the value of the OcaVersion property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<number> – A promise which resolves to a single value of type number.

OcaDeviceManager.GetResetCause()¶

Gets the value of the ResetCause property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<OcaResetCause> – A promise which resolves to a single value of type OcaResetCause().

OcaDeviceManager.GetSerialNumber()¶

Gets the value of the SerialNumber property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<string> – A promise which resolves to a single value of type string.

OcaDeviceManager.GetState()¶

Gets the value of the State property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<OcaDeviceState> – A promise which resolves to a single value of type OcaDeviceState().

OcaDeviceManager.GetUserInventoryCode()¶

Gets the value of the UserInventoryCode property. The return value indicates whether the property was successfully retrieved.

Returns: Promise.<string> – A promise which resolves to a single value of type string.

OcaDeviceManager.SetDeviceName(Name)¶

Sets the device name. The return value indicates whether the property was successfully set.

Arguments

Name (string) –

Returns

Promise.<void> –

OcaDeviceManager.SetDeviceRole(role)¶

Sets the value of the Role property. The return value indicates whether the property was successfully set.

Arguments

role (string) –

Returns

Promise.<void> –

OcaDeviceManager.SetEnabled(enabled)¶

Sets the value of the Enabled property. The return value indicates whether the property was successfully set.

Arguments

enabled (boolean) –

Returns

Promise.<void> –

OcaDeviceManager.SetMessage(Text)¶

Set arbitrary text message into Message property. The return value indicates whether the value was successfully set.

Arguments

Text (string) –

Returns

Promise.<void> –

OcaDeviceManager.SetResetKey(Key, Address)¶

Sets the value of the reset key of the device. The return value indicates whether the property was successfully set. Note that the device manager must inform the CAP gateway of this key (via the host interface), since the CAP gateway will check for and handle the special reset message.

Arguments

Key (Uint8Array) –
Address (Uint8Array) –

Returns

Promise.<void> –

OcaDeviceManager.SetUserInventoryCode(Code)¶

Sets the value of the UserInventoryCode property. The return value indicates whether the property was successfully set.

Arguments

Code (string) –

Returns

Promise.<void> –