PoE Entity

See the PoE Entity for generic information.

group PoEEntity

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

void poe_getPairEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the current enable value of the indicated POE pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: 1 = Enabled; 0 = Disabled;

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_setPairEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char pair, const unsigned char enable)

Enables or disables the indicated POE pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

• enable – 1 = Enable port; 0 = Disable port.

void poe_getPowerMode(unsigned int *id, struct Result *result, const int index)

Gets the power mode of the device

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The power mode (PD, PSE, Auto, Off).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

void poe_setPowerMode(unsigned int *id, struct Result *result, const int index, const unsigned char value)

Sets the power mode of the device

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code.

• index – The index of the entity in question.

• value – The power mode (PD, PSE, Auto, Off).

void poe_getPowerState(unsigned int *id, struct Result *result, const int index)

Gets the power state of the device

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The power state (PD, PSE, Off).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

void poe_getPairSourcingClass(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the sourcing class for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The POE class being offered by the device (PSE).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_setPairSourcingClass(unsigned int *id, struct Result *result, const int index, const unsigned char pair, const unsigned char value)

Sets the sourcing class for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

• value – The POE class being offered by the device (PSE).

void poe_getPairRequestedClass(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the requested class for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The requested POE class by the device (PD).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_getPairDiscoveredClass(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the discovered class for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The negotiated POE class by the device (PSE/PD).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_getPairDetectionStatus(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

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

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The current detected status of the pairs.

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_getPairVoltage(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the Voltage for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The voltage in microvolts (1 == 1e-6V).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_getPairCurrent(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the Current for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The current in microamps (1 == 1e-6V).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_getPairResistance(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the Resistance for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The resistance in milliohms (1 == 1e-3Z).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_getPairCapacitance(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the Capacitance for a given pair

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The capacitance in nanofarads (1 == 1e-9F).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_getPairPower(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

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

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Variable to be filled with the pairs power in milli-watts (mW).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_getTotalPower(unsigned int *id, struct Result *result, const int index)

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

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Variable to be filled with the total POE power in milli-watts (mW).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

void poe_getPairAccumulatedPower(unsigned int *id, struct Result *result, const int index, const unsigned char pair)

Gets the accumulated power for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Variable to be filled with the total accumulated POE power in milli-watts (mW).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

• pair – Selects PoE pair to access

  • 0 = Pair 1/2

  • 1 = Pair 3/4

void poe_setPairAccumulatedPower(unsigned int *id, struct Result *result, const int index, const unsigned char pair, const int power)

Sets the accumulated power for a given pair.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code.

• index – The index of the entity in question.

• 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).

void poe_getTotalAccumulatedPower(unsigned int *id, struct Result *result, const int index)

Gets the total Accumulated Power

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Variable to be filled with the total accumulated POE power in milli-watts (mW).

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

void poe_setTotalAccumulatedPower(unsigned int *id, struct Result *result, const int index, const int power)

Sets the total accumulated power

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code.

• index – The index of the entity in question.

• power – The power accumulator value to be set in milli-watts (mW).