Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rgc99 committed Nov 7, 2022
1 parent c7535c2 commit 1e0b31c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ Each controller has an associated (master) sensor which shows on/off status and

Zones also have an associated sensor which, like the master, shows on/off status and various attributes. Zones sensors have service calls that can enable/disable and provide manual runs. Also adjust run times in automation scripts using information from integrations that collect weather data like [OpenWeatherMap](https://www.home-assistant.io/integrations/openweathermap/), [BOM](https://github.com/bremor/bureau_of_meteorology), [weatherunderground](https://www.home-assistant.io/integrations/wunderground/) and many others. Go crazy with projects like [HAsmartirrigation](https://github.com/jeroenterheerdt/HAsmartirrigation). Easily integrate probes and sensors from [ESPHome](https://esphome.io) for real-time adjustments. Examples provided [below](#9-automation).

View and control your system with the Irrigation Unlimited [companion card](https://github.com/rgc99/irrigation-unlimited-card). A compact card where you can monitor upcoming schedules along with irrigation history.

## 2. Features

1. Unlimited controllers.
Expand Down
18 changes: 12 additions & 6 deletions info.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Irrigation Unlimited

[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]][license]
Expand All @@ -18,22 +20,26 @@ This integration is for irrigation systems large and small. It can offer some co
1. Unlimited controllers.
2. Unlimited zones.
3. Unlimited schedules. Schedule by absolute time or sun events (sunrise/sunset). Select by days of the week (mon/tue/wed...). Select by days in the month (1/2/3.../odd/even). Select by months in the year (jan/feb/mar...). Overlapped schedules.
4. Hardware independent. Use your own switches/valve controllers.
5. Software independent. Pure play python.
4. Unlimited sequences. Operate zones one at a time in a particular order with a delay in between. A 'playlist' for your zones.
5. Suitable for indoor (greenhouse, hothouse, undercover areas) and outdoor (gardens, lawns, crops).
6. Hardware independent. Use your own switches/valve controllers.
7. Software independent. Pure play python.

*Practical limitations will depend on your hardware.

![example][exampleimg]
From release 2022.4.0 a [companion card](https://github.com/rgc99/irrigation-unlimited-card) is available. This card works well on mobile devices.

![companion card collapsed](./examples/companion_card_collapsed.png)

{% if not installed %}
and expands to

![companion card expanded](./examples/companion_card_expanded.png)

## Installation

1. Click install.
2. See the [repository][irrigation_unlimited] for detailed setup instructions.

{% endif %}

## Configuration is done in the configuration.yaml

<!---->
Expand Down

0 comments on commit 1e0b31c

Please sign in to comment.