PoE Entity

API Documentation: [cpp] [python] [.NET] [CCA] [REST]

The PoE entity provides Power over Ethernet control and telemetry on supported products. Use this entity to enable/disable PoE pairs, select power modes, inspect negotiated classes, and read per-pair electrical measurements and accumulated power.

  • pair = 0 = wire pair 1/2

  • pair = 1 = wire pair 3/4

Pair Enable/Disable

stem.poe.getPairEnabled(pair) [cpp] [python] [.NET] [LabVIEW]
stem.poe.setPairEnabled(pair, enable) [cpp] [python] [.NET] [LabVIEW]
1 = Enabled, 0 = Disabled.

Power Mode and Power State

stem.poe.getPowerMode() [cpp] [python] [.NET] [LabVIEW]
stem.poe.setPowerMode(value) [cpp] [python] [.NET] [LabVIEW]
stem.poe.getPowerState() [cpp] [python] [.NET] [LabVIEW]
Power Mode (commanded): PD, PSE, Auto, Off.
Power State (actual): PD, PSE, Off.

Classification and Detection

stem.poe.getPairSourcingClass(pair) [cpp] [python] [.NET] [LabVIEW]
stem.poe.setPairSourcingClass(pair, value) [cpp] [python] [.NET] [LabVIEW]
Sourcing class: The PoE class offered by the device when acting as a PSE.
stem.poe.getPairRequestedClass(pair) [cpp] [python] [.NET] [LabVIEW]
Requested class: The PoE class requested by the device when acting as a PD.
stem.poe.getPairDiscoveredClass(pair) [cpp] [python] [.NET] [LabVIEW]
Discovered class (PSE/PD): The negotiated PoE class result.
stem.poe.getPairDetectionStatus(pair) [cpp] [python] [.NET] [LabVIEW]
Current per-pair detection status.
Detection status values

Unknown

Short circuit

Open circuit

Low resistance

High resistance

Valid

Switch Failure

Electrical Measurements (per pair)

stem.poe.getPairVoltage(pair) [cpp] [python] [.NET] [LabVIEW]
Voltage: µV
stem.poe.getPairCurrent(pair) [cpp] [python] [.NET] [LabVIEW]
Current: µA
stem.poe.getPairResistance(pair) [cpp] [python] [.NET] [LabVIEW]
Resistance: mΩ
stem.poe.getPairCapacitance(pair) [cpp] [python] [.NET] [LabVIEW]
Capacitance: nF
stem.poe.getPairPower(pair) [cpp] [python] [.NET] [LabVIEW]
Power: mW (approx. Voltage * Current for the pair)

Total Power (instantaneous)

stem.poe.getTotalPower() [cpp] [python] [.NET] [LabVIEW]
Returns the sum of both pairs’ instantaneous power (mW).

Accumulated Power (energy counters)

stem.poe.getPairAccumulatedPower(pair) [cpp] [python] [.NET] [LabVIEW]
stem.poe.setPairAccumulatedPower(pair, power) [cpp] [python] [.NET] [LabVIEW]
stem.poe.getTotalAccumulatedPower() [cpp] [python] [.NET] [LabVIEW]
stem.poe.setTotalAccumulatedPower(power) [cpp] [python] [.NET] [LabVIEW]
* All values are in mWh
* Setting total or pair accumulated power resets the corresponding accumulator.