Skip to content

Commit

Permalink
Update readme_new.md
Browse files Browse the repository at this point in the history
  • Loading branch information
petergridge authored Oct 28, 2024
1 parent c68889d commit b8fbda7
Showing 1 changed file with 24 additions and 36 deletions.
60 changes: 24 additions & 36 deletions readme_new.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,73 @@
# PROGRAM DEFINITION
# Configuration

## Program Name
## Program definition

The name of the program this is used to generate a recognisable switch entity that is the foundation of the component.

## Program wide frequency
### Name
The name of the program is used to generate a recognisable switch entity that is the foundation of the component.

### Program wide frequency
This provides the frequency of operation for all zones that do not have a specific frequency option defined. If you intend to enable independant frequency for each zone this can be disabled.

## Frequency options

### Frequency options
The options selected/created here are used across the program and zone frequency selectors.
This supports:
- numeric values: 1 = every day, 2 = every second day and so on.
- day of week: valid values are mon,tue,wed,thu,fri,sat,sun. When mon is selected the program will only execute on Monday
- day groups: mon,wed,thu. When selected the program will run on Monday, Wednesday and Thursday.

## Monitor controller

### Monitor controller
This option supports monitoring if the controller is online. If the controller is offline the program will not attempt to start.

## Controller type

### Controller type
If you have a RainBird controller this will result in the RainBird API being used to start the zones bypassing the default runtime limitation.

# ZONE DEFINITION

## Zone
## Zone Definition

### Zone
The Valve or Switch that is exposed in home assistant that operates the irrigation solenoid.

## Zone Frequency

### Zone Frequency
Specifying the Zone frequency option will provide the ability for a zone to have an independant frequency from the rest of the program. For example, pot plants can be watered daily but lawns every three days in a single program definition.

The frequency options are defined in the program configuration.

## ECO feature

### ECO feature
Selecting the ECO feature will provide the Wait/Repeat options to support multiple short watering cycles to limit the run off. Particularly useful to allow water to penetrate pot plants.

## Pump

### Pump
Defining the Pump valve/switch supports the control of a pump or master solenoid. The pump remains on for several seconds after a zone completes.

## Flow sensor

### Flow sensor
When defined the system operates on the delivery of volume rather than watering for a specified time. The flow sensor is monitored to determine the volume of water delivered for each cycle.

When coupled with the ECO setting the specified volume is delivered for each repeated cycle.

When the Adjustment sensor is defined the volume to be delivered will be adjusted by thefactor provided

## Adjustment Sensor

### Adjustment Sensor
It is expected that the senor will provide a multiplying factor to change the defined watering time. If there has been rain or rain is expected you could reduce the watering requirement or if a hot spell is expected you can increase the watering requirement.

See: [OpenWeatherMap History component](https://github.com/petergridge/openweathermaphistory)

## Rain Sensor
💡check out this component [OpenWeatherMap History](https://github.com/petergridge/openweathermaphistory)

### Rain Sensor
This expects a true/false binary input. If the value is True the zone will be suspended and the zone status indication updated. Watering will continue if the rain sensor is activated once watering commences.

## Water Source

This expects a tru/false binary input. Used to monitor a well status and prevent watering if the water drops below a certain level. Watering will be stopped if this sensor is activated.

## Zone Order
### Water Source
This expects a true/false binary input. Used to monitor a well status and prevent watering if the water drops below a certain level. Watering will be stopped if this sensor is activated.

### Zone Order
Use this to alter the run sequence of the zones. The value increments by 10 as a default to support easier redefintion of the sort order.


# ADVANCED OPTIONS
## Advanced options

## Concurrent program execution (interlock)
### Concurrent program execution (interlock)

This option prevents two programs executing concurrently, the second program to run will terminate the running program. A log entry will is created to highlight the occurence.

Note: if both programs have identical start times neither program will run.
⚠️ Warning: if both programs have identical start times neither program will run.

## Start time options
### Start time options

Options available:
- Time selector, supporting the selction of a single start time for the program
Expand Down

0 comments on commit b8fbda7

Please sign in to comment.