-
Notifications
You must be signed in to change notification settings - Fork 49
Infinitude API calls
nebulous edited this page Apr 5, 2023
·
4 revisions
All requests are relative to your instance of Infinitude.
/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/blightreturns backlight level -
/api/config/modereturns current mode -
/api/config/humidityAway/humidifierreturns the value of keyhumidifierin thehumidityAwaystructure.
To mutate one of the above, use POST or PUT. eg
POST /api/config
blight=2
Despite not being correctly RESTy, Infinitude will also allow mutations with the GET verb, but one must make their intentions explicit to Infinitude with a set_changes flag. eg
GET /api/config?blight=10&set_changes=true
/api/:zone_id/hold
parameters
- zone_id (1 thru 8)
- hold:
onoroff(defaulton) - activity:
home,away,sleep,wake,manual(defaulthome) - until:
foreverorHH:MM(defaults to an hour in the future. MM must be one of00,15,30,45)
example
set zone 1 mode to away until 11:45PM
/api/1/hold
activity=away
until=23:45
/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