Controller Settings Methods
Get and set the controller configuration. The following is a glossary of the fields available through the API.
Controller Data
name (string)
- The arbitrary name assigned this controller by the userpostal_code (string)
- The postal code of the controlleron (boolean)
- Whether the controller is watering or notversion (string)
- The current software version installed on the controller [read only]country (string)
- The country of the controllerwater_times (string)
- Comma delimited string with controller watering start timesschedule_type (string)
- Can be one of the following [read only]- smart watering
Zone Data
zone_num (string)
- The number of the zonename (string)
- The name of the zoneduration (int)
- The duration for the zoneon (boolean)
- Whether the zone is on or offstatus (string)
- Can be one of the following [read only]- wired
- not wired
- short detected
plant (string)
- The plants in the zone. Any of the following, comma separated:- grass
- shrubs
- trees
- ground_cover
shade (string)
- How shady the zone is. One of the following:- none
- partial
- full
slope (string)
- Whether any part of the zone has a slope. One of the following:- none
- slight
- steep
sprinkler (string)
- The sprinkler in the zone. Any of the following, comma separated:- spray
- rotary
- drip
Table of Contents #
- GET /controllers/{controller_id}/all.config
- GET /controllers/{controller_id}/controller.config
- PUT /controllers/{controller_id}/controller.config
- GET /controllers/{controller_id}/zone.config/{zone_num}
- PUT /controllers/{controller_id}/zone.config/{zone_num}
GET /controllers/{controller_id}/all.config #
Gets all the controller data fields, zone data, and custom schedule data in a single call.
Query Fields
controller_id (string)
- The id for the controller
Response
controller_data
- The controller datazones_data
- The zones data for the controller in an array
$.ajax({ type: 'GET', url: '[api url]/controllers/{controller_id}' });
GET /controllers/{controller_id}/controller.config #
Gets all the controller data fields, zone data, and custom schedule data.
Query Fields
controller_id (string)
- The id for the controller
Response
controller_data
- The controller data
$.ajax({ type: 'GET', url: '[api url]/controllers/{controller_id}' });
PUT /controllers/{controller_id}/controller.config #
Update a controller's configuration
Query Fields
controller_id (string)
- The id for the controller
Post Fields
Any of the non read only controller data fields.
Response
success (boolean)
- The success of the call
$.ajax({ type: 'PUT', url: '[api url]/controllers/{controller_id}', data: { "name": "new name" } });
GET /controllers/{controller_id}/zone.config/{zone_num} #
Returns the controller current zone configuration settings
Query Fields
controller_id (string)
- The id for the controllerzone_num (string)
- The number of the zone
Response
The zone data for the given zone number.
$.ajax({ type: 'GET', url: '[api url]/controllers/{controller_id}/zone.config/{zone_num}' });
PUT /controllers/{controller_id}/zone.config/{zone_num} #
Update a specific zone of a controller.
Query Fields
controller_id (string)
- The public id for the controller
Post Fields
Any of the non read only zone data fields.
Response
success (boolean)
- The success of the call
$.ajax({ type: 'PUT', url: '[api url]/controllers/{controller_id}/zone.config/{zone_num}', data: { "slope" : "slight" } });