Power Supply Datatypes

OcaPowerSupplyType

enum OcaPowerSupplyType : uint8_t

Type of power supply.

enumerator None = 0: No power supply.

enumerator Mains = 1: Mains-powered power supply.

enumerator Battery = 2: Battery power supply.

enumerator Phantom = 3: Phantom power supply. Includes Power-over-Ethernet supplies.

enumerator Solar = 4: Solar power supply

OcaPowerSupplyLocation

enum OcaPowerSupplyLocation : uint8_t

Physical location of a device power supply.

enumerator Unspecified = 1: Unspecified location

enumerator Internal = 2: Power supply is physically inside the device.

enumerator External = 3: Power supply is physically outside the device.

OcaPowerSupplyState

enum OcaPowerSupplyState : uint8_t

State of a power supply.

enumerator Off = 0: Powered down.

enumerator Unavailable = 1: Power supply is turned on but not available for activation.

enumerator Available = 2: Power supply is fully available for activation.

enumerator Active = 3: Power supply is currently supplying power to the device.

OcaPowerState

enum OcaPowerState : uint8_t

Enumeration defining the power states that OCA devices can be in. The state is returned by the device’s Power Manager on request.

enumerator None = 0: Unspecified state.

enumerator Working = 1: Power is on.

enumerator Standby = 2: The device is in standby mode, but may be awoken by a call to the appropriate state-changing method of this class.

enumerator Off = 3: The device is off, but may (depending on implementation) be awoken by a transport-dependent wakeup mechanism.