Reading state
All reads are GET under /api-gateway/v1/iot-shadow/device/{deviceId}/ and return the standard envelope. See Overview for caching behaviour and units.
Dashboard
Section titled “Dashboard”GET…/dashboardInfo
The same overview the SplashMe app shows on its home screen.
{ "status": "SUCCESS", "data": { "dashboard": { "actual_ph": 74, "actual_orp": 652, "d_ph": 74, "d_orp_mineral": 650, "d_orp_liquid": 650, "chemistry_stable": true, "ph_switch_status": false, "orp_switch_status": true, "actual_pump_speed": 60, "actual_flow_rate": 180, "actual_pressure": 12, "main_pump_status": 99, "dry_run_status": 3, "flow_status": 1, "pump_calib": false, "heater_state": false, "solar_state": false, "spa_heater_state": false, "desired_water_temp": 28, "water_temp": 265, "solar_temp": 2450, "solar_mode": 0, "is_naked": false, "cost_savings": [0, 0, 0, 0], "backwash_pressure": 150, "prime_pressure": 0 } }}| Field | Meaning |
|---|---|
actual_ph, actual_orp |
Current readings, pH × 10 and mV |
d_ph, d_orp_mineral, d_orp_liquid |
Set points for pH, the salt or mineral chlorinator ORP and liquid chlorine ORP |
chemistry_stable |
Flow or pressure has been present for 2 minutes, so the readings have settled and dosing may run |
ph_switch_status, orp_switch_status |
The acid doser output, and any chlorinator or liquid chlorine output, is energised right now |
actual_pump_speed |
Main pump speed, percent; 0 unless the motor reports that it is running |
actual_flow_rate |
Measured flow, L/min |
actual_pressure, prime_pressure |
Filter pressure now, and the pressure recorded when the pump last primed, kPa |
backwash_pressure |
The backwash alert threshold setting, kPa; not a measurement |
flow_status |
0 not evaluated yet, 1 flow established, 2 no flow |
main_pump_status |
0 off. 1 to 20 when the pump is on and its schedule is active: the value is schedule_num + 1 of the first main-pump schedule in the list, so with several pump schedules it is not necessarily the one running. 99 when the pump is on but the scheduler is not driving it: a manual override, heater cool-down, spa mode, solar, a cleaner or an interlock |
dry_run_status |
3 normal, including after a trip; 4 dry run suspected, the controller is retrying the start; 1 tripped, reported for about 6 seconds while the pump is switched off. 0 and 2 are defined but never reported |
pump_calib |
Pump power calibration has been completed |
heater_state, solar_state, spa_heater_state |
Heat source outputs currently on. heater_state includes a combined pool and spa heater |
desired_water_temp |
Pool heating set point, whole °C |
water_temp |
Current water temperature, °C × 10, the same reading as ambientTemp. 250 is reported if the sensor reads above 100 °C |
solar_temp |
Roof or air sensor, °C × 100, the same reading as ambientTemp.ambient_temp |
solar_mode |
0 off, 1 solar only, 2 solar plus heater, 3 heater only |
is_naked |
A Naked ioniser was assigned to a slot when the controller started |
cost_savings |
Four numbers: savings per hour, reduction percentage, current running cost and accumulated savings, each divided by 100 |
This read waits up to 10 seconds for the controller when there is no cached copy. The cached copy does not expire on its own: it is refreshed in the background and cleared by writes that affect it, as described in How reads work.
Chemistry card
Section titled “Chemistry card”GET…/chemistryCard
Four reads in one: current chemistry, pH dosing settings, chlorine settings and the equipment slot assignment. Each part is fetched in turn; a part that fails is null, partial is true, and errors lists one "<part>: <message>" string per failed part. The call fails outright only when all four parts fail, with the same joined messages.
{ "status": "SUCCESS", "data": { "chemistry": { "ph_value": 74, "orp_value": 652, "tds_value": 2731, "desire_ph_value": 74, "desire_orp_value": 650, "desire_tds_value": 3600, "device_array": [ { "name": "Mineral Chlorinator", "status": 1, "volume": -1 }, { "name": "", "status": 0, "volume": 0 }, { "name": "pH Doser", "status": 0, "volume": 20000 } ] }, "phSettings": { "ph_dosing": true, "ph_dosing_time": 60, "desired_ph_level": 74, "acid_drum_volume": 20000, "remain_acid_volume": 12000, "reset_acid_volume": false, "max_dose_pre_day": 10, "current_dose_today": 2, "dose_intervals": 30, "ph_doser_timer": 0, "ph_dose_rate": 120 }, "chlorineSettings": { "orp_controlled": true, "desired_orp_level_mineral": 650, "mineral_max_duration_preday": 0, "mineral_dosing_duration_today": 0, "liquid_chlorine_dosing": false, "desired_orp_level_liquid": 650, "chlorine_dosing_time": 60, "chlorine_drum_volume": 20000, "remain_chlorine_volume": 15000, "reset_chlorine_volume": false, "max_dose_pre_day": 10, "current_dose_today": 0, "dose_intervals": 30, "liquid_doser_timer": 0, "liquid_dose_rate": 120 }, "auxAssign": { "aux_assign": [31, 6, 12, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], "aux_name": ["Main Pump", "pH Doser", "Pool Light", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", ""], "aux_timer": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], "equipment": [ { "type_code": 6, "type": "6", "brand": "pH doser", "label": "pH Doser", "slot": 1 }, { "type_code": 12, "type": "12", "brand": "Astral pool light", "label": "Pool Light", "slot": 2 }, { "type_code": 0, "type": "0", "brand": "None", "label": "None", "slot": 3 } ] } }}chemistry: ph_value and desire_ph_value are pH × 10; orp_value is mV and desire_orp_value is the salt or mineral chlorinator set point in mV, even on a liquid chlorine system. tds_value and desire_tds_value are placeholders (the controller reports a random number and a constant); ignore them. device_array always has three entries: the chlorinator-type device (the last assigned of salt chlorinator, mineral chlorinator, Naked ioniser, ozone or UV), the liquid chlorine doser and the pH doser, in that order. An entry whose device is not assigned has an empty name. status is 1 while that output is energised. volume is the drum capacity in mL for the two dosers and -1 for the chlorinator-type entry; it is not the remaining volume.
phSettings and chlorineSettings are the objects you send back to the write endpoints; their fields are described on Chemistry. ph_doser_timer and liquid_doser_timer are live second counters of the current dose and rest cycle, current_dose_today counts doses since 03:01 controller time, and mineral_dosing_duration_today is the seconds the chlorinator has run today.
auxAssign: the three arrays have one entry per controller slot, 37 on current firmware: aux_assign[i] is the equipment type code in slot i, aux_name[i] the user’s label and aux_timer[i] the slot’s auto-off time in seconds (0 for none). Slot 0 is the main pump. equipment lists slots from index 1 upward, including empty ones with type_code 0, so the main pump is not in it; type is type_code as a string, label is the user’s label or, when the slot has no label, the type name, and brand is always the type name. has_ecoclear appears, as true, when a Mineral Swim V2 unit is connected over RS485; equipment then also contains a synthetic entry with type_code 999, label Mineral Swim V2 and slot 21, which is unrelated to the real slot 21 of expander 2.
GET…/pumpInfo
{ "status": "SUCCESS", "data": { "pump": { "pump_type": "SplashMe VSD", "pump_brand": "SplashMe", "pump_model": "SM-1500", "motor_status": 3, "actual_speed": 60, "actual_flowrate": 180, "pump_cooldown": false, "flow_state": [120, 180, 240, 300], "speed_priority": 2, "dry_run_supported": true, "dry_run": [3, 3, 0, 0], "dry_run_info": { "status": 3, "total_rounds": 3, "current_round": 0, "protection_remaining_second": 0, "activated": false } } }}| Field | Meaning |
|---|---|
pump_type, pump_brand, pump_model |
The pump configured at commissioning, as free text. Pumps the controller drives digitally have type SplashMe VSD, 3 Speed or Inverter/VFD. A controller whose pump was never configured reports Others / Single Speed with an empty model: it switches the pump through a relay and reports speed, flow and power as 0 |
motor_status |
0 not ready, 1 sending defaults, 2 ready, 3 running, 4 starting, 5 stopping, 6 stopped, 7 error, 8 over temperature, 9 idle |
actual_speed |
Percent, for digitally driven pumps; always 0 for a relay-driven pump. Unlike the dashboard value it is not forced to 0 when the motor is not running |
actual_flowrate |
Measured flow, L/min |
flow_state |
The four calibrated flow values, L/min, measured at 40, 60, 80 and 100% during pump calibration |
speed_priority |
Bit mask of what is setting the speed: bit 0 manual, 1 schedule, 2 spa, 3 solar, 4 pool heater, 5 spa heater, 6 shared heater, 7 cleaner. Omitted when 0 |
pump_cooldown |
A heater cool-down window is open: the pump is kept running after a heater switched off. pump_cooldown_left is the remaining seconds and is omitted when 0. With the cool-down setting at 10 seconds or less the pump stops at once but the flag still shows until the window passes |
prime_time_left |
Seconds of priming allowance left after a start. It drops to 0 as soon as flow or pressure is confirmed and holds at the full value while a dry-run retry is in progress. Omitted when 0 |
dry_run_supported |
Dry-run protection is available (firmware 2.5.28 or later). On older firmware dry_run and dry_run_info are omitted |
dry_run |
[status, configured retry cycles, retries so far, seconds left of a dry-check disable window]. status uses the dry_run_status codes above; [3, 3, 0, 0] is normal |
dry_run_info |
The same four values as status, total_rounds, current_round and protection_remaining_second, plus activated |
dry_run_info.activated |
A start or retry check is in progress (current_round above 0 and status not 1). It is true for roughly the first 20 seconds of every pump start and does not mean the pump is being held off |
Some older firmware reports flow_state as a single number, in which case this endpoint returns 500.
Equipment slots
Section titled “Equipment slots”GET…/auxInfo
Every slot that holds switchable equipment, with its current state, plus the same entries grouped by category. Heaters, solar outputs, the pH doser and the liquid chlorine doser are controlled by the controller itself and are not listed; see Chemistry card for the full slot assignment.
{ "status": "SUCCESS", "data": { "manual": { "aux": [ { "aux_tag": "Main Pump", "aux_type_code": 31, "aux_status": true, "aux_trump": false, "aux_slot_num": 0, "pump_speed": 60, "actual_flow_rate": 180 }, { "aux_tag": "Pool Light", "aux_type_code": 12, "aux_status": false, "aux_trump": false, "aux_slot_num": 2, "pump_speed": 0, "actual_flow_rate": 0, "aux_timer": 3600 } ], "pump_devices": [ { "aux_tag": "Main Pump", "aux_type_code": 31, "aux_status": true, "aux_trump": false, "aux_slot_num": 0, "pump_speed": 60, "actual_flow_rate": 180 } ], "other_devices": [ { "aux_tag": "Pool Light", "aux_type_code": 12, "aux_status": false, "aux_trump": false, "aux_slot_num": 2, "pump_speed": 0, "actual_flow_rate": 0, "aux_timer": 3600 } ] } }}| Field | Meaning |
|---|---|
aux_slot_num |
The controller’s slot index; the main pump is 0. Send this and aux_type_code when switching the slot |
aux_type_code |
Equipment type |
aux_tag |
The user’s label for the slot; empty when none has been set |
aux_status |
The output is on. For the main pump this is the motor reporting that it runs; for a slot on a wireless expander it is the commanded state |
aux_trump |
A manual override is holding this slot and the schedule is not driving it. See Manual overrides. The controller also sets it on the main pump itself during a heater cool-down, and all spa actuator slots share one flag |
pump_speed |
On the main pump entry, the stored manual speed in percent, as last set with setPumpInfo; not the current speed, which is pumpInfo.actual_speed. 0 on other entries |
actual_flow_rate |
On the main pump entry, measured flow in L/min. 0 on other entries |
aux_timer |
Configured auto-off time in seconds; omitted when none. aux_timer_remain_sec is the running countdown and is present only while it runs: the slot is on under a manual override with a timer configured |
Groups: pump_devices (the main pump), spa (spa actuators), spa_devices (spa jets and blowers), pump_linked_devices (UV, ozone, ioniser and cleaners that run with the pump) and other_devices, which includes lights, auxiliaries and the salt and mineral chlorinators. Entries in the groups are full copies of the aux entries. A group that would be empty is omitted.
Temperatures
Section titled “Temperatures”GET…/ambientTemp
{ "status": "SUCCESS", "data": { "ambientTemp": { "water_temp": 265, "water_temp_offset": 0, "ambient_temp": 2450, "ambient_temp_offset": 0 } } }water_temp is °C × 10 (26.5 °C); ambient_temp is °C × 100 (24.5 °C) and reads 0 when there is no air sensor. The offsets are calibration corrections already applied to the readings.

