Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions source/_docs/scripts.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ The most important one is the action to call a service. This can be done in vari
brightness: 100
```

#### Activate a Scene

Scripts may also use a shortcut syntax for activating scenes instead of calling the `scene.turn_on` service.

```yaml
- scene: scene.morning_living_room
```

### Test a Condition

While executing a script you can add a condition to stop further execution. When a condition does not return `true`, the script will stop executing. There are many different conditions which are documented at the [conditions page].
Expand Down
41 changes: 41 additions & 0 deletions source/_integrations/airly.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "Airly"
description: "Instructions on how to integrate Airly within Home Assistant."
logo: airly.png
ha_category:
- Health
ha_release: 0.101
ha_iot_class: Cloud Polling
---

The `airly` integration uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location.

## Setup

To generate an Airly API key, go to [Airly for developers](https://developer.airly.eu/register) page.

## Configuration

To add Airly to your installation, go to **Configuration** >> **Integrations** in the UI and enable the Airly integration. By default, the values will be taken from the Home Assistant configuration.

{% configuration %}
api_key:
description: The Airly API key.
required: true
type: string
name:
description: Manually specify Name.
required: false
type: string
default: Airly
latitude:
description: Manually specify latitude.
required: false
type: float
default: Provided by Home Assistant configuration
longitude:
description: Manually specify longitude.
required: false
type: float
default: Provided by Home Assistant configuration
{% endconfiguration %}
4 changes: 2 additions & 2 deletions source/_integrations/alarmdecoder.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,11 @@ zones:
required: false
type: integer
relayaddr:
description: "Address of the relay expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed."
description: "Address of the relay or zone expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed."
required: inclusive
type: integer
relaychan:
description: "Channel of the relay expander board to associate with the zone. (ex: 1, 2, 3, or 4)"
description: "Channel of the relay or zone expander board to associate with the zone. (ex: 1, 2, 3, or 4 for relay expander boards, 1 - 8 for zone expander boards)"
required: inclusive
type: integer
{% endconfiguration %}
Expand Down
8 changes: 5 additions & 3 deletions source/_integrations/generic_thermostat.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ ac_mode:
min_cycle_duration:
description: Set a minimum amount of time that the switch specified in the *heater* option must be in its current state prior to being switched either off or on.
required: false
type: [time, integer]
type: time
cold_tolerance:
description: Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor equals or goes below 24.5.
required: false
Expand All @@ -69,7 +69,7 @@ hot_tolerance:
keep_alive:
description: Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid climate integration state (either on or off).
required: false
type: [time, integer]
type: time
initial_hvac_mode:
description: Set the initial HVAC mode. Valid values are `off`, `heat` or `cool`. Value has to be double quoted. If this parameter is not set, it is preferable to set a *keep_alive* value. This is helpful to align any discrepancies between *generic_thermostat* and *heater* state.
required: false
Expand All @@ -85,12 +85,14 @@ precision:
default: "`0.5` for Celsius and `1.0` for Fahrenheit."
{% endconfiguration %}

A full configuration example looks like the one below. `min_cycle_duration` and `keep_alive` must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`.
__Notes__
Time for `min_cycle_duration` and `keep_alive` must be set as wrapped in quotes representation of time in form of "hh:mm:ss", time in seconds (without quotes) or it must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`.

Currently the `generic_thermostat` climate platform supports 'heat', 'cool' and 'off' hvac modes. You can force your `generic_thermostat` to avoid starting by setting HVAC mode to 'off'.

Please note that when changing the preset mode to away, you will force a target temperature change as well that will get restored once the preset mode is set to none again.

__Example__
```yaml
# Full example configuration.yaml entry
climate:
Expand Down
79 changes: 0 additions & 79 deletions source/_integrations/hipchat.markdown

This file was deleted.

3 changes: 2 additions & 1 deletion source/_integrations/hive.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,15 @@ The platform supports the following Hive products:

### Climate

The `hive` climate platform integrates your Hive thermostat into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.
The `hive` climate platform integrates your Hive thermostat and Hive radiator valves into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.

A short boost for Hive Heating can be set by using the **Boost** preset, this will turn on the boost feature for 30 minutes at 0.5 degrees higher than the current temperature.

The platform supports the following Hive products:

- Hive Active Heating
- Hive Multi-zone
- Hive Radiator Valve

### Light

Expand Down
1 change: 1 addition & 0 deletions source/_integrations/homematicip_cloud.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ Within this delay the device registration should be completed in the App, otherw
* Combined Alarm Control Panal with INTERNAL and EXTERNAL Security zones (*HmIP-SecurityZone*)

* homematicip_cloud.binary_sensor
* Acceleration Sensor (*HMIP-SAM*)
* Window and door contact (*HmIP-SWDO, -I*)
* Contact Interface flush-mount – 1 channel (*HmIP-FCI1*)
* Contact Interface (*HmIP-SCI*)
Expand Down
93 changes: 0 additions & 93 deletions source/_integrations/hydroquebec.markdown

This file was deleted.

6 changes: 6 additions & 0 deletions source/_integrations/jewish_calendar.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ havdalah_minutes_after_sunset:
- omer_count: An integer sensor indicating the day of the Omer (1-49) or 0 if it is not currently the Omer.

### Time sensors

*Note: Due to the variety of rabbinic opinions on how to calculate the different times, we do not take any responsibility on your religious reliance upon these calculations.*

Time sensor states are represented as ISO8601 formatted *UTC time*.
For easier use in automations, all time sensors have a `timestamp` attribute, which returns the UNIX timestamp.

- first_light: First light of dawn (Alot Hashachar - עלות השחר).
- gra_end_shma: Last time for reading of the Shma according to the GR"A.
- mga_end_shma: Last time for reading of the Shma according to the MG"A.
Expand Down
19 changes: 18 additions & 1 deletion source/_integrations/neato.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,27 @@ description: "Instructions on how to integrate your Neato within Home Assistant.
logo: neato.png
ha_category:
- Camera
- Sensor
- Switch
- Vacuum
ha_release: 0.33
ha_config_flow: true
---

The `neato` integration allows you to control your [Neato Botvac Connected Robots](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/).

To enable `neato` in your installation, add the following to your `configuration.yaml` file:
To activate `neato` in your installation, you can set it up from the integration screen or add it to your `configuration.yaml` file.

## Setup the integration via the integrations screen

Menu: *Configuration* -> *Integrations*

Search for or select **Neato** from the list and configure the integration. You will need to enter your username and password and whether you are using a Neato or Vorwerk device.
After that, all the entities will automatically show up in Home Assistant.

## Setup the integration via configuration.yaml

Add the following to your configuration.yaml:

```yaml
# Example configuration.yaml entry
Expand Down Expand Up @@ -92,6 +105,10 @@ Some information about the capabilities might be found on the [Neato Developer P

The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).

## Sensor

The `neato` sensor platform allows you to view the battery level for your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).

## Switch

The `neato` switch platform allows you to enable or disable the schedule of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
Expand Down
Loading