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

Pump and equipment control

Find the slot number of each piece of equipment with auxInfo first. Heaters, solar outputs and the dosers are run by the controller itself; they are not switchable here and auxInfo does not list them. Both writes below wait up to 10 seconds for the controller’s acknowledgement and clear the cached pumpInfo and auxInfo.

POST…/setPumpInfo

{ "aux_switch_state": 1, "aux_type_code": 31, "pump_speed": 60, "aux_slot_num": 0 }
Field Meaning
aux_switch_state 1 on, 0 off
aux_type_code 31, the main pump. The controller acts on the type assigned to the slot and ignores this value; send it for compatibility
pump_speed Percent, 40 to 100. 0 is accepted and sets 40. The value is stored as the controller’s manual speed, on an off command too, and is used whenever the pump runs outside a schedule, including when the controller starts it for an interlock. Sent while the pump is running under its schedule, it applies until that schedule window ends. Other values return 400 pump_speed must be 40-100 (got N)
aux_slot_num The pump’s slot from auxInfo.pump_devices, normally 0. Slots are 0 to 36
{ "status": "SUCCESS", "data": { "manual": { "info": "SLOT:0:STATUS:ON", "message": "Successfully switched!", "status": "SUCCESS" } } }

The three strings are fixed: info echoes the slot and the requested state. They mean the controller queued the command, not that the pump has changed state. Confirm with pumpInfo (motor_status 3, or actual_speed above 0 on a digitally driven pump) or with aux_status in auxInfo.

POST…/manualSet

{ "aux_switch_state": 1, "aux_type_code": 12, "aux_slot_num": 2 }

Switches the slot on (1) or off (0). The response has the same manual shape as above. Switching a spa actuator slot enters or leaves spa mode; see Heating and spa. As with the pump, aux_type_code is ignored by the controller; take aux_slot_num from auxInfo. Do not use this endpoint for slot 0: it is the pump command without pump_speed, so it resets the stored manual speed to 40.

UV, ozone, ioniser, pressure and in-floor cleaner, salt chlorinator and mineral chlorinator outputs need flow. While any of them is on and the pump is off, the controller switches the pump on about 5 seconds later, at the manual speed (the cleaner speed for a cleaner, and subject to the heater, solar and spa priorities below). Outside the pump’s schedule this start counts as a manual override, so the pump keeps running after the linked output goes off, until the pump’s next scheduled run ends or an off is sent. An off sent to the pump while such an output is still on stops it for about 5 seconds only. Chlorinator outputs are switched by the controller’s own ORP control (see Chemistry): switch the output off, or set orp_controlled to false, before trying to keep the pump off.

A command whose state differs from what the schedule wants at that moment (on outside the schedule window, off inside it) becomes a manual override: aux_trump is true for the slot in auxInfo. Do not read main_pump_status 99 as an override: it only says the pump is on while its schedule is not active, which is also the case during a heater cool-down, spa mode, solar heating or an interlock, and an off override inside the window shows 0.

The override ends when one of these happens:

  • a command arrives that matches the schedule’s current state: to hand the pump back outside the window, send off; inside the window, send on;
  • the slot’s scheduled run ends (the schedule’s on to off transition), including when the schedule is disabled or edited while it is in its window;
  • the slot’s auto-off timer (aux_timer in auxInfo) expires;
  • spa mode is switched off, which clears the pump and cleaner overrides;
  • the controller restarts.

Nothing clears it at midnight, and a slot with no schedule keeps its override until a matching command or a restart. A pump switched on in the evening therefore runs through the night and through the next day’s scheduled run.

Heater cool-down. When the pump is told off while the pool heater output is on, the controller acknowledges the command but keeps the pump running for the heater cool-down time (180 seconds by default, set in the SplashMe app) to protect the heater, then stops it. This applies to every pump off, including the end of a scheduled run; a heater the thermostat had already switched off does not start a cool-down. pumpInfo shows pump_cooldown: true with pump_cooldown_left counting down.

Do not send on during the cool-down. On current firmware it leaves the controller’s scheduler paused for every slot until the pump next completes an off: no schedule starts or stops and no override clears in the meantime. Send one off, then poll pumpInfo until pump_cooldown is false and the motor has stopped. A cool-down setting above 1200 seconds can never elapse on current firmware and leaves the pump running after every off; keep it at 1200 or below, or at 10 or below to disable it.

Speed priorities. While a heater output is on the pump runs at the heater pump speed (100% by default) whatever pump_speed says; solar heating, a cleaner and spa mode override that in turn, and the first minutes after a start run at 100% for priming. In manual mode the speed the controller settles on is saved as the new manual speed, so after a heating run the pump stays at the heater speed until a new pump_speed is sent.

Codes are listed on Equipment types.