Skip to content

Infinitude API calls

nebulous edited this page Mar 6, 2023 · 4 revisions

The following is subject to change. In particular, Infinitude will likely disable modifications using http GET requests. Presently any http verb works.

All requests are relative to your instance of Infinitide.

get system variables

/api/config/<path> returns system configuration as seen by the infinitude client

example

/api/config/ returns entire system configuration

If the optional path parameter is specified, drill down to more targeted data.

for example:

  • /api/config/blight returns backlight level
  • /api/config/mode returns current mode
  • /api/config/humidityAway/humidifier returns the value of key humidifier in the humidityAway structure.

To mutate one of the above, use POST or PUT. eg

POST /api/config

blight=2

set hold

/api/:zone_id/hold

parameters

  • zone_id (1 thru 8)
  • hold: on or off (default on)
  • activity: home, away, sleep, wake, manual (default home)
  • until: forever or HH:MM (defaults to an hour in the future. MM must be one of 00,15,30,45)

example

set zone 1 mode to away until 11:45PM /api/1/hold

activity=away
until=23:45

set scheduled climate mode, setpoints, fan

/api/:zone_id/activity/:activity

parameters

  • zone_id (1 thru 8)
  • activity: home, away, sleep, wake, manual
  • clsp (cool setpoint temperature)
  • htsp (heat setpoint temperature)
  • fan (off, low, med, high)

example

set zone 1 cool setpoint to 69 with fan low

/api/1/activity/sleep

clsp=69
fan=low