ZoneFlow

Services

Each service targets a zone: any of its entities, or its device.

  • zoneflow.run_deep_soak and zoneflow.run_routine_irrigation run now. The routine run waters at once even when the routine is not due, and counts as the routine watering done. Pause, snooze, frost, rain falling right now and the runtime caps still apply.
  • zoneflow.snooze_today skips today's remaining cycles.
  • zoneflow.reset_lock is an emergency clear of a stuck in-progress lock.
  • zoneflow.add_rain adds rain you read by hand to an outdoor zone that has no rain gauge. It takes the amount and, if you want, when it fell, up to 14 days back. See Rain without a gauge.
  • zoneflow.test_pulse takes seconds (default 10, 1 to 120). It is a bench test that bypasses all gates.
  • zoneflow.water_now takes minutes. It waters for that long, split into pulses like the zone's own watering, but not while the zone is paused, never longer than the zone's runtime cap, and inside the day's cap. It counts in the water record and does not move the routine or deep soak schedule.
  • zoneflow.calibrate_flow takes volume (litres, or gallons on an imperial zone), area (m², or ft²) and minutes. It sets the flow rate and Zone Flow from a measured run. See Calibration.
  • zoneflow.send_weekly_summary sends the weekly summary now to every phone that has a zone with a Weekly Summary day. It is a preview: the week's counts carry on. It takes no target.
  • zoneflow.set_schedule sets when the routine watering and the deep soak start: a clock time (routine_time, deep_soak_time), or before or after sunrise or sunset (routine_sun_mode, deep_soak_sun_mode, with an offset of 0 to 180 minutes). Leave out what should stay as it is. The zone reloads to use the new times. It is the same as the Watering time button, for administrators, and is refused while the zone is watering. See Schedules and cadences.
  • zoneflow.delete_zone deletes the zone it names, the same as Delete on the device page. It cannot be undone, it is for administrators, and it never deletes "the only zone" unless that zone is named.

Areas

  • zoneflow.create_area takes a name and, if you like, a zone to put in it.

Plants

These work on a zone's plants. The plant_id is shown in the zone's Status attributes (plants).

  • zoneflow.add_plant takes a name and, if you like, a plant_type, ready_days and planted to follow a seedling.
  • zoneflow.set_plant_ready takes plant_id, ready_days and planted. It follows a seedling towards the day it can move. 0 stops following it, and leaving the days out uses the usual number for the plant type.
  • zoneflow.move_plant moves a plant to the zone you target. old_main says what becomes of the plant that is the main one there, and use_plant_settings brings the plant's watering settings too.
  • zoneflow.set_main_plant, zoneflow.remove_plant and zoneflow.rename_plant do what they say.
  • zoneflow.add_plant_note takes plant_id and text.

See Areas, plants and presets.

Presets

  • zoneflow.save_preset saves a zone's watering settings under a name.
  • zoneflow.copy_settings gives the targeted zone the settings of another zone (source_device_id) or of a saved preset.
  • zoneflow.delete_preset removes a saved preset by name.