httpctrl

HTTP controller

Configuration

Example:

controllers:
  http:
    enabled: true
    addr: ":8080"

API

Endpoints

GET /v1

• Description: Retrieve a snapshot with the current attributes of the thermostat.
• Method: GET
• Example Request: GET /v1

Snapshot response:

{
  "device_id": "my-thermocktat",
  "enabled": true,
  "temperature_setpoint": 22,
  "temperature_setpoint_min": 16,
  "temperature_setpoint_max": 28,
  "mode": "auto",
  "fan_speed": "auto",
  "ambient_temperature": 21,
  "fault_code": 0
}

POST /v1/:attribute

• Description: Update a specific attribute of the thermostat.
• Method: POST
• Request Body: JSON object with the format {"value": <value>}
• Example Request: POST /v1/enabled {"value": true}

GET /healthz

Returns "ok" if server is running.

Examples

• Enable the thermostat:

  POST /v1/enabled
  {
    "value": true
  }
  

• Set the temperature setpoint:

  POST /v1/setpoint
  {
    "value": 21
  }
  

• Change the operating mode:

  POST /v1/mode
  {
    "value": "heat"
  }