PoE Endpoint

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

See the PoE Entity for generic information.

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairenabled/(pair)

Gets the current enable value of the indicated POE pair.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (boolean) – Value formatted as a boolean

  • response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/poe/(index)/pairenabled/(pair)

Enables or disables the indicated POE pair.

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Request JSON Object:

  • value (boolean) –

    Boolean value to set.

    May be specified as a boolean, integer, or a string (formatted as “True”, “FALSE”, “1”, etc.)

Response JSON Object:

  • response.value (boolean) – Value formatted as a boolean

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/powermode

Gets the power mode of the device

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/poe/(index)/powermode

Sets the power mode of the device

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (integer) –

    8-bit Integer value to set.

    May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/powerstate

Gets the power state of the device

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairsourcingclass/(pair)

Gets the sourcing class for a given pair.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/poe/(index)/pairsourcingclass/(pair)

Sets the sourcing class for a given pair.

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Request JSON Object:

  • value (integer) –

    8-bit Integer value to set.

    May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairrequestedclass/(pair)

Gets the requested class for a given pair.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairdiscoveredclass/(pair)

Gets the discovered class for a given pair.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairdetectionstatus/(pair)

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

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairvoltage/(pair)

Gets the Voltage for a given pair.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/paircurrent/(pair)

Gets the Current for a given pair.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairresistance/(pair)

Gets the Resistance for a given pair.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/paircapacitance/(pair)

Gets the Capacitance for a given pair

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairpower/(pair)

Get the instantaneous power consumption for a given pair

The equivalent of Voltage x Current

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/totalpower

Gets the total instantaneous power consumption

The equivalent of Pair1(Voltage x Current) + Pair2(Voltage x Current)

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/pairaccumulatedpower/(pair)

Gets the accumulated power for a given pair.

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/poe/(index)/pairaccumulatedpower/(pair)

Sets the accumulated power for a given pair.

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

  • pair –

    Selects PoE pair to access

    • 0 = Pair 1/2

    • 1 = Pair 3/4

Request JSON Object:

  • value (integer) –

    32-bit Integer value to set.

    May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/poe/(index)/totalaccumulatedpower

Gets the total Accumulated Power

See JSON Schema for Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/poe/(index)/totalaccumulatedpower

Sets the total accumulated power

See JSON Schema for Request Object and Response Object

Parameters:

  • serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

  • index – Index of entity to access. Default is 0.

Request JSON Object:

  • value (integer) –

    32-bit Integer value to set.

    May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

  • response.value (integer) – Value formatted as an integer

  • response.rawValue (integer) – Unformatted value