POE Entity

group POEEntity

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

Congratulations! You found an Easter egg! Unfortunately, this code is still under construction and should not be used.

POEClass: This entity is only available on certain modules, and provides a Power Over Ethernet control ability. Gets the power mode of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The power mode (PD, PSE, Auto, Off).

• 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

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone on success. Non-zero error code on failure.

• 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

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The power state (PD, PSE, Off).

• index – The index of the entity in question.

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

Gets the sourcing class on Pair 1/2 of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The POE class being offered by the device (PSE).

• index – The index of the entity in question.

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

Sets the sourcing class on Pair 1/2 of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone on success. Non-zero error code on failure.

• index – The index of the entity in question.

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

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

Gets the sourcing class on Pair 3/4 of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The POE class being offered by the device (PSE).

• index – The index of the entity in question.

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

Sets the sourcing class on Pair 3/4 of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone on success. Non-zero error code on failure.

• index – The index of the entity in question.

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

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

Gets the requested class on Pair 1/2 of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The requested POE class by the device (PD).

• index – The index of the entity in question.

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

Gets the requested class on Pair 3/4 of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The requested POE class by the device (PD).

• index – The index of the entity in question.

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

Gets the discovered class on Pair 1/2 of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The negotiated POE class by the device (PSE/PD).

• index – The index of the entity in question.

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

Gets the discovered class on Pair 3/4 of the device

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The negotiated POE class by the device (PSE/PD).

• index – The index of the entity in question.

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

Gets detected status of the POE connection on Pair 1/2

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The current detected status of the pairs.

• index – The index of the entity in question.

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

Gets detected status of the POE connection on Pair 3/4

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The current detected status of the pairs.

• index – The index of the entity in question.

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

Gets the Voltage on Pair 1/2

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The voltage in microvolts (1 == 1e-6V).

• index – The index of the entity in question.

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

Gets the Voltage on Pair 3/4

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The voltage in microvolts (1 == 1e-6V).

• index – The index of the entity in question.

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

Gets the Voltage on Pair 1/2

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The current in microamps (1 == 1e-6V).

• index – The index of the entity in question.

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

Gets the Voltage on Pair 3/4

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The current in microamps (1 == 1e-6V).

• index – The index of the entity in question.

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

Gets the Voltage on Pair 1/2

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The resistance in milliohms (1 == 1e-3V).

• index – The index of the entity in question.

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

Gets the Voltage on Pair 3/4

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The resistance in milliohms (1 == 1e-3V).

• index – The index of the entity in question.

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

Gets the Voltage on Pair 1/2

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The capacitance in nanocoulombs (1 == 1e-9V).

• index – The index of the entity in question.

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

Gets the Voltage on Pair 3/4

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The capacitance in nanocoulombs (1 == 1e-9V).

• index – The index of the entity in question.

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

Resets the POEClass Entity to it factory default configuration.

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone on success. Non-zero error code on failure.

• index – The index of the entity in question.