Get AC

Edit online

Retrieves information about the air conditioning units in the library.

Request syntax

GET /v1/acUnits
Retrieves information about the air conditioning units in the library.

GET /v1/acUnits/{location}

Retrieves information about the air conditioning units in the library.

Path parameters

location (string)

The unique location of the frame the ac unit is installed in.

Example

> GET /v1/acUnits
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992
[
      {
            "location": "frame_F1",
            "controlSetpoint": 98.5,
            "state": "online",
            "operation": "cooling",
            "externalTemperature": 32.7
       }
]

Attributes

location (string)

The unique location of the frame.

controlSetpoint (number)

The temperature in Celsius set for the control set point being used by controller.

state (string)
Alarm status in priority order:
Table 1.
State Description
unknown (gray) Unknown state encountered
unreachable (red) The library is unable to communicate with the AC unit.
alarm (red) One or more alarm statuses are present in the AC unit.
warning (yellow) One or more warning statuses are present in the AC unit.
online (green) The AC unit is online and operational.
operation (string)
AC operational state
  • off: All outputs are off
  • idle: Internal blower on
  • cooling: Ambient blower and compressor on
  • heating: Internal blower and heater on
  • testing: testing procedure running
  • unknown: unknown state encountered
externalTemperature (number)

External sensor reading