Skip to content

Commit

Permalink
docs: adds opening scope description
Browse files Browse the repository at this point in the history
  • Loading branch information
= committed Apr 19, 2024
1 parent 7a94c67 commit 3e9bd40
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,22 @@ The `openings` configuration variable accepts a list of opening entities and ope
An opening entity is a sensor that can be in two states: `on` or `off`. If the state is `on` the opening is considered open, if the state is `off` the opening is considered closed.
The opening object can contain a timeout property that defines the time in seconds after which the opening is considered open even if the state is still `on`. This is useful if you would want to ignor windows opened only for a short time.

### Openings Scope

The `openings_scope` configuration variable defines the scope of the openings. If set to `all` or not defined, any open openings will turn off the current hvac device and it will be in the idle state. If set, only devices that operating in the defined HVAC modes will be turned off. For example, if set to `heat` only the heater will be turned off if any of the openings are open.

### Openings Scope Configuration

```yaml
openings_scope: [heat, cool, heat_cool, fan_only]
```

```yaml
openings_scope:
- heat
- cool
```

## Openings Configuration

```yaml
Expand All @@ -143,6 +159,7 @@ climate:
- binary_sensor.window2
- entity_id: binary_sensor.window3
timeout: 00:00:30
openings_scope: [heat, cool]
target_sensor: sensor.study_temperature
```

Expand Down Expand Up @@ -322,6 +339,19 @@ The internal values can be set by the component only and the external values can

`timeout: <value>` The time after which the opening is considered open even if the state is still `on` (timedata)</br>

### openings_scope

_(optional) (array[string])_ "The scope of the openings. If set to [`all`] or not defined, any open openings will turn off the current hvac device and it will be in the idle state. If set, only devices that operating in the defined HVAC modes will be turned off. For example, if set to `heat` only the heater will be turned off if any of the openings are open."

_default: `all`_

options:
- `all`
- `heat`
- `cool`
- `heat_cool`
- `fan_only`

### min_temp

_(optional) (float)_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ def any_opening_open(
# the requester sets it's scope and it's in the scope
# in case of ALL, it's always in the scope
or (
self.openings_scope is not [OpeningHvacModeScope.ALL]
self.openings_scope != [OpeningHvacModeScope.ALL]
and hvac_mode_scope in self.openings_scope
)
# the scope is not restricted at all
Expand Down

0 comments on commit 3e9bd40

Please sign in to comment.