PoE Class¶

See the PoE Entity for generic information.

class PoEClass : public Acroname::BrainStem2CLI::EntityClass¶

PoEClass: This entity is only available on certain modules, and provides a Power over Ethernet control ability.

Public Functions

PoEClass()¶: Constructors.

~PoEClass()¶: Destructor.

!PoEClass (): Finalizer.

void init (BrainStem2CLI::ModuleClass^ module, const unsigned char index)

Initializes the class. Should only be called when manually creating classes.

Parameters:

pModule – The module.
index – The cmdPOE index to be addressed.

aErr getPairEnabled(const unsigned char pair, unsigned char %enable)¶

Gets the current enable value of the indicated POE pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
enable – 1 = Enabled; 0 = Disabled;

Returns:

Returns common entity return values

aErr setPairEnabled(const unsigned char pair, const unsigned char enable)¶

Enables or disables the indicated POE pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
enable – 1 = Enable port; 0 = Disable port.

Returns:

Returns common entity return values

aErr getPowerMode(unsigned char %value)¶

Gets the power mode of the device

Parameters:: value – The power mode (PD, PSE, Auto, Off).
Returns:: Returns common entity return values

aErr setPowerMode(const unsigned char value)¶

Sets the power mode of the device

Parameters:: value – The power mode (PD, PSE, Auto, Off).
Returns:: Returns common entity return values

aErr getPowerState(unsigned char %value)¶

Gets the power state of the device

Parameters:: value – The power state (PD, PSE, Off).
Returns:: Returns common entity return values

aErr getPairSourcingClass(const unsigned char pair, unsigned char %value)¶

Gets the sourcing class for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
value – The POE class being offered by the device (PSE).

Returns:

Returns common entity return values

aErr setPairSourcingClass(const unsigned char pair, const unsigned char value)¶

Sets the sourcing class for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
value – The POE class being offered by the device (PSE).

Returns:

Returns common entity return values

aErr getPairRequestedClass(const unsigned char pair, unsigned char %value)¶

Gets the requested class for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
value – The requested POE class by the device (PD).

Returns:

Returns common entity return values

aErr getPairDiscoveredClass(const unsigned char pair, unsigned char %value)¶

Gets the discovered class for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
value – The negotiated POE class by the device (PSE/PD).

Returns:

Returns common entity return values

aErr getPairDetectionStatus(const unsigned char pair, unsigned char %value)¶

Gets detected status of the POE connection for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
value – The current detected status of the pairs.

Returns:

Returns common entity return values

aErr getPairVoltage(const unsigned char pair, int %microvolts)¶

Gets the Voltage for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
microvolts – The voltage in microvolts (1 == 1e-6V).

Returns:

Returns common entity return values

aErr getPairCurrent(const unsigned char pair, int %microamps)¶

Gets the Current for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
microamps – The current in microamps (1 == 1e-6V).

Returns:

Returns common entity return values

aErr getPairResistance(const unsigned char pair, int %milliohms)¶

Gets the Resistance for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
milliohms – The resistance in milliohms (1 == 1e-3Z).

Returns:

Returns common entity return values

aErr getPairCapacitance(const unsigned char pair, int %nanofarads)¶

Gets the Capacitance for a given pair

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
nanofarads – The capacitance in nanofarads (1 == 1e-9F).

Returns:

Returns common entity return values

aErr getPairPower(const unsigned char pair, int %power)¶

Get the instantaneous power consumption for a given pair The equivalent of Voltage x Current

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
power – Variable to be filled with the pairs power in milli-watts (mW).

Returns:

Returns common entity return values

aErr getTotalPower(int %power)¶

Gets the total instantaneous power consumption The equivalent of Pair1(Voltage x Current) + Pair2(Voltage x Current)

Parameters:: power – Variable to be filled with the total POE power in milli-watts (mW).
Returns:: Returns common entity return values

aErr getPairAccumulatedPower(const unsigned char pair, int %power)¶

Gets the accumulated power for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
power – Variable to be filled with the total accumulated POE power in milli-watts (mW).

Returns:

Returns common entity return values

aErr setPairAccumulatedPower(const unsigned char pair, const int power)¶

Sets the accumulated power for a given pair.

Parameters:

pair – Selects PoE pair to access
- 0 = Pair 1/2
- 1 = Pair 3/4
power – The power accumulator value to be set in milli-watts (mW).

Returns:

Returns common entity return values

aErr getTotalAccumulatedPower(int %power)¶

Gets the total Accumulated Power

Parameters:: power – Variable to be filled with the total accumulated POE power in milli-watts (mW).
Returns:: Returns common entity return values

aErr setTotalAccumulatedPower(const int power)¶

Sets the total accumulated power

Parameters:: power – The power accumulator value to be set in milli-watts (mW).
Returns:: Returns common entity return values