Management Datatypes

OcaManagerDescriptor

struct OcaManagerDescriptor

Structure that describes a Manager instance.

OcaONo ObjectNumber: Object number of this Manager instance.

OcaString Name: Name of this Manager instance.

OcaClassID ClassID: ClassID of the class from which the Manager instance was constructed.

OcaClassVersionNumber ClassVersion: Version number of the class from which this Manager instance was constructed.

OcaManufacturer

struct OcaManufacturer

Structure that describes a manufacturer.

OcaString Name: Manufacturer’s name

OcaOrganizationID OrganizationID: Manufacturer’s IEEE OUI or CID, if any. Zero value means OUI or CID is not specified.

OcaString Website: URL of the manufacturer’s website. If none, an empty string shall be provided.

OcaString BusinessContact: Contact information for business issues. If none, an empty string shall be provided.

OcaString TechnicalContact: Contact information for technical issues. If none, an empty string shall be provided.

OcaProduct

struct OcaProduct

Structure that describes a Product.

OcaString Name: Product name

OcaString ModelID: Manufacturer’s unique model identifier.

OcaString RevisionLevel: Manufacturer’s product revision level code

OcaString BrandName: Brand name under which product is sold

OcaUUID UUID: Unique UUID of product. Not manufacturer-specific.

OcaString Description: Text description of product

OcaManagerDefaultObjectNumbers

enum OcaManagerDefaultObjectNumbers

Datatype that defines the fixed object numbers assigned to the various OcaManager objects.

enumerator DeviceManager = 1: Required

enumerator SecurityManager = 2: Optional

enumerator FirmwareManager = 3: Optional

enumerator SubscriptionManager = 4: Required

enumerator PowerManager = 5: Optional

enumerator NetworkManager = 6: Required if Device has OcaNetworkInterface and/or OcaNetworkApplication objects, or subclasses of them

enumerator MediaClockManager = 7: Required if device supports AES70-controlled media transport

enumerator LibraryManager = 8: Deprecated in OCA 1.5

enumerator AudioProcessingManager = 9: Optional

enumerator DeviceTimeManager = 10: Required if device knows what time it is

enumerator TaskManager = 11: Deprecated in OCA 1.5

enumerator CodingManager = 12: Deprecated in OCA 1.5

enumerator DiagnosticManager = 13: Optional

enumerator LockManager = 14: Optional

OcaDeviceGenericState

enum OcaDeviceGenericState : uint8_t

Generic device states

enumerator NormalOperation = 0: Device is operating normally.

enumerator Initializaing = 1: Device is starting or restarting.

enumerator Updating = 2: Device is installing firmware.

enumerator Fault = 3: Device has encountered a terminal error and cannot continue to operate normally without external intervention.

enumerator ExpansionBase = 128: Base value for proprietary extensions

OcaDeviceOperationalState

struct OcaDeviceOperationalState

Operating state of device: generic state + device-specific details

OcaDeviceGenericState Generic: Generic device state

OcaBlob Details: Device-specific state details (optional)

OcaComponent

enum OcaComponent : uint16_t

Enumeration (16-bit) for of software & firmware components in the device. Except for the boot loader, all other values of this enum are device-specific and will be specified by subclassing this class.

enumerator BootLoader = 0: The boot loader image.

OcaVersion

struct OcaVersion

Representation of a version number of a (hardware/software) component of a device in the form of Major.Minor.Build (e.g. 1.0.123).

OcaUint32 Major: The major version number.

OcaUint32 Minor: The minor version number.

OcaUint32 Build: The build number. May be 0 if it is not used (e.g. for a hardware component).

OcaComponent Component: The component.

OcaResetCause

enum OcaResetCause : uint8_t

Enumeration of reasons for device reset.

enumerator PowerOn = 0: Reset due to powering up.

enumerator InternalError = 1: Reset due to internal error.

enumerator Upgrade = 2: Reset following upgrade of firmware.

enumerator ExternalRequest = 3: Reset due to an external request (i.e. Reset method of DeviceManager or hardware reset pin).

enumerator Unknown = 255