Skip to content
Martin Pihrt edited this page Oct 11, 2026 · 3 revisions

OSPy documentation

OSPy — Open Sprinkler Python — is a Raspberry Pi irrigation controller for scheduled watering, manual control, weather-aware adjustments, sensors, plug-ins and remote access. This Wiki turns the project documentation into a task-oriented guide instead of sending readers to a source-code directory.

Česká dokumentace: Začněte českým průvodcem webovým rozhraním. Instalace je zatím vedena anglicky v podrobném instalačním průvodci.

Start here

I want to… Documentation
Install OSPy on a Raspberry Pi or Debian system Quick start · Complete installation guide
Learn the web interface Choose a language
Create irrigation schedules Programs and scheduling
Add hardware, integrations or automation Official plug-ins
Use the Android application or API Mobile API v1
See recent changes Changelog · Archive
Ask a question or report a problem Support and feedback

Recommended reading order

  1. Use Getting started for the supported installation path and first-login checklist.
  2. Continue with the web interface guide in your language.
  3. Read Programs before creating advanced schedules, groups, calendar rules or sunrise/sunset programs.
  4. Browse the live plug-in catalog when you need extra hardware, monitoring, notifications, automation or integrations.
  5. Keep the installation safe by following the remote-access and password guidance in the complete installation guide.

Documentation languages

The complete web-interface guide is available in Czech, English, German, Polish, Russian, Serbian and Slovak.

Project resources

The detailed pages in this Wiki are maintained from the documentation in the stable master branch. The repository remains the authoritative source when a Wiki copy and source file ever differ.

Clone this wiki locally