Skip to content
Device API v1 is enabled per client on request and is not on by default. See what is available today.

Schedules

A controller holds up to 20 schedules, numbered 0 to 19, each switching one equipment slot on between a start and end time on selected days. Times are minutes since midnight in the controller’s local time zone; an end time before the start runs past midnight, and a start equal to the end means all day. Days are seven booleans starting with Monday.

GET…/scheduleInfo

{
"status": "SUCCESS",
"data": {
"scheduleInfo": {
"schedules": [
{
"schedule_num": 3,
"schedule_id": 3,
"schedule_name": "Morning filter",
"schedule_state": true,
"aux_slot": 0,
"slot_num": 0,
"aux_type_code": 31,
"start_time": 480,
"end_time": 960,
"week_days": [true, true, true, true, true, false, false],
"pump_speed": 60
}
]
}
}
}
Field Meaning
schedule_num Schedule slot on the controller, 0 to 19. schedule_id is the same value
schedule_state Enabled
aux_slot Equipment slot the schedule drives. slot_num is the same value
aux_type_code Type of the equipment in that slot when the schedule was written
start_time, end_time Minutes since midnight
week_days Monday to Sunday
pump_speed Percent, main-pump schedules only; omitted when 0
turn_over Main-pump schedules only: pool turnovers × 10 as entered in the SplashMe app, informational. Omitted when 0, and never set through this API

The order of the list is not guaranteed; sort by schedule_num. The list is cached for 10 minutes and, like the other reads, served from the cache while the API’s controller link is down; with no cached copy and the link down the call returns 500.

main_pump_status on the dashboard reports a pump running under its schedule as the lowest-numbered main-pump schedule plus one, which is not necessarily the window that is active.

POST…/changeScheduleStatus

{ "schedule_id": 3, "schedule_state": false }

The field is schedule_id here, not schedule_num. A missing or misspelt number is sent as 0 and acts on schedule 0.

POST…/createSchedule

{
"aux_slot": 0,
"start_time": 480,
"end_time": 960,
"day_of_week": [true, true, true, true, true, false, false],
"schedule_name": "Morning filter",
"pump_speed": 60,
"pool_volume": 0
}
Field Meaning
aux_slot Equipment slot to drive; the main pump is 0
start_time, end_time Minutes since midnight. The controller accepts 0 to 1440
day_of_week Seven booleans, Monday first. Missing entries count as false; without the array the schedule never runs
schedule_name Free text; names need not be unique
pump_speed Percent, 40 to 100, required when aux_slot is 0; other values return 400 pump_speed must be 40-100 for the main pump (got N). Ignored for other slots
pool_volume Accepted for compatibility and ignored by the controller

Beyond pump_speed, the API does not range-check schedule bodies. The controller validates the slot and the times; a refusal comes back as 422 (see Responses and errors).

The controller takes the lowest free schedule number, enables the new schedule at once and does not return the number. Read scheduleInfo afterwards and find the entry by schedule_name, or compare the list before and after.

POST…/updateSchedule

Same body as create plus schedule_num. Send the complete schedule: every field is replaced, including pump_speed, so changing only the times of a pump schedule still needs its current pump_speed in the body (the API rejects a main-pump schedule without it). The schedule is enabled after an update even if it was disabled before; call changeScheduleStatus afterwards to keep it off.

{
"schedule_num": 3,
"aux_slot": 0,
"start_time": 420,
"end_time": 960,
"day_of_week": [true, true, true, true, true, true, true],
"schedule_name": "Morning filter",
"pump_speed": 60,
"pool_volume": 0
}

POST…/deleteSchedule

{ "schedule_num": 3 }

Deleting an empty slot also succeeds. For this write data.message is not an acknowledgement but the controller’s list of the remaining schedules in the same group of ten, in the controller’s own field names.

Every write waits up to 3 seconds for the controller, plus any time spent behind other commands to the same controller, returns 200 with data.message holding the controller’s reply, and clears the cached schedule list.

A schedule the controller refuses returns 422 with message set to controller rejected the request: followed by the controller’s reason: Invalid aux_slot or time, Schedule max number limit is 20!, Schedule number out of range (0-19) or Schedule not saved: NVS full. Nothing was changed on the controller in that case.

Transport failures are 500 with messages such as failed to create schedule: timeout waiting for response, 429 with messages such as failed to create schedule: device busy: … when the controller is busy, or 503 when the controller link is down.