mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 13:26:54 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
c367e46007
@ -5,7 +5,7 @@ description: "Details about YAML to configure Home Assistant."
|
||||
|
||||
Home Assistant uses the [YAML](https://yaml.org/) syntax for configuration. YAML might take a while to get used to but is really powerful in allowing you to express complex configurations.
|
||||
|
||||
While more and more integrations are configured through the UI, for some, you will add code in your `configuration.yaml` file to specify its settings.
|
||||
While more and more integrations are configured through the UI, for some, you will add code in your [`configuration.yaml`](/docs/configuration/) file to specify its settings.
|
||||
|
||||
The following example entry assumes that you would like to set up the [notify integration](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet).
|
||||
|
||||
@ -19,7 +19,7 @@ notify:
|
||||
- An **integration** provides the core logic for some functionality (like `notify` provides sending notifications).
|
||||
- A **platform** makes the connection to a specific software or hardware platform (like `pushbullet` works with the service from pushbullet.com).
|
||||
|
||||
The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a `-` while mappings have the format `key: value`. This is somewhat similar to a Hash table or more specifically a dictionary in Python. These can be nested as well. **Beware that if you specify duplicate keys, the last value for a key is used**.
|
||||
The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a `-` while mappings have the format `key: value`. This is somewhat similar to a Hash table or more specifically a dictionary in Python. These can be nested as well. **Beware that if you specify duplicate keys, the last value for a key is used**.
|
||||
|
||||
Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested "inside" things that are one level higher. So in the above example, `platform: pushbullet` is a property of (nested inside) the `notify` integration.
|
||||
|
||||
|
||||
@ -18,6 +18,6 @@ Home Assistant is an open platform and so home energy management is not restrict
|
||||
- [Integrate your water consumption](/docs/energy/water/)
|
||||
- [Integrate individual devices](/docs/energy/individual-devices/)
|
||||
|
||||
If you have a sensor that returns instantaneous power readings (W or kW), then to add a sensor that returns energy usage or generation (kWh) refer to [Riemann sum integral integration](/integrations/integration/#energy)
|
||||
If you have a sensor that returns instantaneous power readings (W or kW), then to add a sensor that returns energy usage or generation (kWh), refer to the [Riemann sum integral integration](/integrations/integration/#energy).
|
||||
|
||||
<img src='/images/docs/energy/energy-overview.png' alt='Visual representation of how all different energy forms relate.' style='border: 0;box-shadow: none;'>
|
||||
|
||||
@ -19,7 +19,7 @@ Some battery vendors have an API to integrate the data into your Home Assistant
|
||||
|
||||
CT clamp sensors measure your energy usage by looking at the current passing through an electrical wire. This makes it possible to calculate the energy usage. In Home Assistant we have support for off-the-shelf CT clamp sensors and you can build your own.
|
||||
|
||||
The off-the-shelf solution that we advise is the [Shelly EM](https://shop.shelly.cloud/shelly-em-2-x-120a-clamp-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality integration.
|
||||
The off-the-shelf solution that we advise is the [Shelly EM](https://www.shelly.com/en/products/shop/shelly-em-120a/shelly-em-50a?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality [integration](/integrations/shelly/).
|
||||
|
||||
You can build your own using ESPHome's [CT Clamp Current sensor](https://esphome.io/components/sensor/ct_clamp.html) or energy meter sensors like the [ATM90E32](https://esphome.io/components/sensor/atm90e32.html). For the DIY route, check out [this video by digiblur](https://www.youtube.com/watch?v=n2XZzciz0s4) to get started.
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@ In countries like Germany, SML (Smart Message Language) is used typically. ESPHo
|
||||
|
||||
CT clamp sensors measure your energy usage by looking at the current passing through an electrical wire. This makes it possible to calculate the energy usage. In Home Assistant we have support for off-the-shelf CT clamp sensors and you can build your own.
|
||||
|
||||
The off-the-shelf solution that we advise is the [Shelly EM](https://shop.shelly.cloud/shelly-em-2-x-120a-clamp-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality integration.
|
||||
The off-the-shelf solution that we advise is the [Shelly EM](https://www.shelly.com/en/products/shop/shelly-em-120a/shelly-em-50a?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality [integration](/integrations/shelly/).
|
||||
|
||||
You can build your own using ESPHome's [CT Clamp Current sensor](https://esphome.io/components/sensor/ct_clamp.html) or energy meter sensors like the [ATM90E32](https://esphome.io/components/sensor/atm90e32.html) or [PZEM-004T V3](https://esphome.io/components/sensor/pzemac.html). For the DIY route, check out [this video by digiblur](https://www.youtube.com/watch?v=n2XZzciz0s4) to get started.
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ That said, if you can sample Power values fast enough (every few seconds) you ca
|
||||
|
||||
If you are using a 3rd party device (e.g. not reading directly from your utility meter device or from the utility provider cloud service) you need HA to split your energy measurements into 2 (or more) tariffs, in order to track these energy consumptions separately.
|
||||
|
||||
To accomplish such, you can use [the utility_meter integration](/integrations/utility_meter/). With this integration, you define as many tariffs as required (in accordance with your utility provider contract) and HA will be able to differentiate energy consumptions in each of the tariffs. Please note that each utility provider has its own time schedules for peak and off-peak and you are required to create an automation that switches the utility_meter entity from one tariff to the other.
|
||||
To accomplish such, you can use the [utility_meter integration](/integrations/utility_meter/). With this integration, you define as many tariffs as required (in accordance with your utility provider contract) and HA will be able to differentiate energy consumptions in each of the tariffs. Please note that each utility provider has its own time schedules for peak and off-peak and you are required to create an automation that switches the utility_meter entity from one tariff to the other.
|
||||
|
||||
## The Energy panel is not visible
|
||||
|
||||
|
||||
@ -19,10 +19,12 @@ CT clamp sensors measure the instantaneous current passing through an electrical
|
||||
|
||||
In Home Assistant we have support for off-the-shelf CT clamp sensors and you can build your own with ESPHome's [CT Clamp Current sensor](https://esphome.io/components/sensor/ct_clamp.html).
|
||||
|
||||
The off-the-shelf solution that we advice is the [Shelly EM](https://shop.shelly.cloud/shelly-em-2-x-120a-clamp-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality integration.
|
||||
The off-the-shelf solution that we advise is the [Shelly EM](https://www.shelly.com/en/products/shop/shelly-em-120a/shelly-em-50a?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality [integration](/integrations/shelly/).
|
||||
|
||||
_Attention! Installing CT clamp sensor devices requires opening your electrical cabinet. This work should be done by someone familiar with electrical wiring. Your qualified installer will know how to do this._
|
||||
|
||||
_Disclaimer: Some links on this page are affiliate links._
|
||||
|
||||
### Connecting to your inverter
|
||||
|
||||
Some solar inverters have APIs that can be read by Home Assistant.
|
||||
|
||||
@ -5,8 +5,8 @@
|
||||
<li>{% active_link /common-tasks/os/ Home Assistant Operating System %}</li>
|
||||
<li>{% active_link /common-tasks/container/ Home Assistant Container %}</li>
|
||||
<li>{% active_link /common-tasks/core/ Home Assistant Core %}</li>
|
||||
<li>{% active_link /common-tasks/supervised/ Home Assistant Supervised %}
|
||||
<li>{% active_link /common-tasks/general/ Installation independent %}</li>
|
||||
<li>{% active_link /common-tasks/supervised/ Home Assistant Supervised %}</li>
|
||||
<li>{% active_link /common-tasks/general/ Installation independent %}</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
@ -118,8 +118,7 @@
|
||||
<b>{% active_link /docs/frontend/ Frontend %}</b>
|
||||
<ul>
|
||||
<li>
|
||||
{% active_link /docs/frontend/browsers/ Browser Compatibility List
|
||||
%}
|
||||
{% active_link /docs/frontend/browsers/ Browser Compatibility List %}
|
||||
</li>
|
||||
<li>{% active_link /dashboards Dashboards %}</li>
|
||||
<li>{% active_link /docs/frontend/icons/ Icons%}</li>
|
||||
@ -161,8 +160,7 @@
|
||||
<li>{% active_link /integrations/mqtt/#mqtt-discovery Discovery %}</li>
|
||||
<li>{% active_link /integrations/mqtt/#publish--dump-services Publish service %}</li>
|
||||
<li>
|
||||
{% active_link /integrations/mqtt/#birth-and-last-will-messages Birth and last will messages
|
||||
%}
|
||||
{% active_link /integrations/mqtt/#birth-and-last-will-messages Birth and last will messages %}
|
||||
</li>
|
||||
<li>{% active_link /integrations/mqtt/#testing-your-setup Testing your setup %}</li>
|
||||
<li>{% active_link /integrations/mqtt/#logging Logging %}</li>
|
||||
@ -170,12 +168,16 @@
|
||||
</li>
|
||||
<li>
|
||||
<b>Hardware</b>
|
||||
<ul>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://green.home-assistant.io/">Home Assistant Green</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://yellow.home-assistant.io/">Home Assistant Yellow</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://skyconnect.home-assistant.io/">Home Assistant SkyConnect</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -55,8 +55,8 @@ To update Home Assistant Core when you run Home Assistant {{ page.installation_n
|
||||
content: |
|
||||
|
||||
```bash
|
||||
docker-compose pull homeassistant
|
||||
docker-compose up -d
|
||||
docker compose pull homeassistant
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
{% endtabbed_block %}
|
||||
|
||||
@ -6,6 +6,7 @@ ha_category:
|
||||
- Camera
|
||||
- Environment
|
||||
- Sensor
|
||||
- Weather
|
||||
ha_release: 0.14
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_domain: bloomsky
|
||||
|
||||
@ -13,7 +13,7 @@ The `facebox` image processing platform allows you to detect and recognize faces
|
||||
|
||||
## Setup
|
||||
|
||||
Facebox runs in a Docker container and it is recommended that you run this container on a x86 machine with a minimum of 2 GB RAM (an ARM version is not available). On your machine with Docker, run the Facebox container with:
|
||||
Facebox runs in a Docker container, and it is recommended that you run this container on a x86 machine (an ARM version is not available) with a minimum of 2 GB RAM. On your machine with Docker, run the Facebox container with:
|
||||
|
||||
```bash
|
||||
MB_KEY="INSERT-YOUR-KEY-HERE"
|
||||
@ -37,13 +37,13 @@ services:
|
||||
- MB_FACEBOX_DISABLE_RECOGNITION=false
|
||||
```
|
||||
|
||||
You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bear in mind that the integration does not encrypt these credentials and this approach does not guarantee security on an unsecured network.
|
||||
You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"`, but bear in mind that the integration does not encrypt these credentials, and this approach does not guarantee security on an unsecured network.
|
||||
|
||||
After you created an account at [Machinebox](https://machinebox.io/account), you can grab your `MB_KEY` at [your Account page](https://developer.veritone.com/machinebox/overview).
|
||||
|
||||
If you only require face detection (number of faces) you can disable face recognition by adding `-e "MB_FACEBOX_DISABLE_RECOGNITION=true"` in the `docker run` command.
|
||||
If you only require face detection (counting the number of faces), you can disable face recognition by adding `-e "MB_FACEBOX_DISABLE_RECOGNITION=true"` in the `docker run` command.
|
||||
|
||||
If your host machine does not support [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) and you experience issues running the `machinebox/facebox` image there is an alternative image without AVX support available at `machinebox/facebox_noavx`(*HINT*: This image is currently not supported by machinebox and should only be used if necessary)
|
||||
If your host machine does not support [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) and you experience issues running the `machinebox/facebox` image, there is an alternative image without AVX support available at `machinebox/facebox_noavx` (*HINT*: This image is currently not supported by machinebox and should only be used if necessary).
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -83,7 +83,7 @@ source:
|
||||
type: map
|
||||
keys:
|
||||
entity_id:
|
||||
description: A camera entity id to get picture from.
|
||||
description: A camera entity ID to get picture from.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
@ -121,9 +121,9 @@ The service `facebox.teach_face` can be used to teach Facebox faces.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | Entity ID of Facebox entity.
|
||||
| `name` | no | The name to associate with a face.
|
||||
| `file_path` | no | The path to the image file.
|
||||
| `entity_id` | no | Entity ID of Facebox entity. |
|
||||
| `name` | no | The name to associate with a face.|
|
||||
| `file_path` | no | The path to the image file. |
|
||||
|
||||
A valid service data example:
|
||||
|
||||
@ -169,7 +169,7 @@ system_log:
|
||||
fire_event: true
|
||||
```
|
||||
|
||||
you can create an automation to receive notifications on Facebox errors:
|
||||
You can create an automation to receive notifications on Facebox errors:
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The HomeKit integration allows you to make your Home Assistant entities available in Apple HomeKit,
|
||||
The HomeKit Bridge integration allows you to make your Home Assistant entities available in Apple HomeKit,
|
||||
so they can be controlled from Apple's Home app and Siri; even if those devices do not natively support HomeKit.
|
||||
|
||||
Please make sure that you have read the [considerations](#considerations) listed below to save you
|
||||
@ -26,7 +26,7 @@ some trouble later. However, if you do encounter issues, check out the
|
||||
<div class="note">
|
||||
|
||||
If you want to control HomeKit-only devices with Home Assistant,
|
||||
check out the [HomeKit controller](/integrations/homekit_controller/) integration,
|
||||
check out the [HomeKit Device](/integrations/homekit_controller/) integration,
|
||||
which provides the possibility to pull HomeKit-enabled devices into Home Assistant.
|
||||
|
||||
</div>
|
||||
@ -277,7 +277,7 @@ homekit:
|
||||
|
||||
## Setup
|
||||
|
||||
To enable the HomeKit integration in Home Assistant, add the following to your configuration file:
|
||||
To enable the HomeKit Bridge integration in Home Assistant, add the following to your configuration file:
|
||||
|
||||
```yaml
|
||||
# Example for HomeKit setup
|
||||
|
||||
@ -44,7 +44,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The [HomeKit](https://developer.apple.com/apple-home/) Device integration allows you to connect accessories with the "Works with HomeKit" logo to Home Assistant. This integration should not be confused with the [HomeKit](/integrations/homekit/) integration, which allows you to control Home Assistant devices via HomeKit.
|
||||
The [HomeKit](https://developer.apple.com/apple-home/) Device integration allows you to connect accessories with the "Works with HomeKit" logo to Home Assistant. This integration should not be confused with the [HomeKit Bridge](/integrations/homekit/) integration, which allows you to control Home Assistant devices via HomeKit.
|
||||
|
||||
# Adding a HomeKit device
|
||||
|
||||
@ -58,7 +58,7 @@ There are different methods to add a HomeKit device to Home Assistant:
|
||||
|
||||
## Adding a HomeKit device via Ethernet or Wi-Fi
|
||||
|
||||
The HomeKit controller integration automatically detects HomeKit [compatible devices](#supported-devices) on your network when they are ready to pair.
|
||||
The HomeKit Device integration automatically detects HomeKit [compatible devices](#supported-devices) on your network when they are ready to pair.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@ -74,19 +74,19 @@ The HomeKit controller integration automatically detects HomeKit [compatible dev
|
||||
- Otherwise you won't be able to pair it with Home Assistant.
|
||||
- **Explanation:** Adding the device to the Home app and then removing it again has two effects:
|
||||
- It adds the device to your network. It stays in the network even after you removed it from the app.
|
||||
- Removing the device from the app opens it up for pairing with Home Assistant's HomeKit Controller integration directly. HomeKit devices can only be paired to a single controller at once.
|
||||
- Removing the device from the app opens it up for pairing with Home Assistant's HomeKit Device integration directly. HomeKit devices can only be paired to a single controller at once.
|
||||
|
||||
|
||||
### To add a HomeKit device via Ethernet or Wi-Fi
|
||||
|
||||
1. The device should have been discovered under **{% my integrations title="Settings > Devices & Services" %}**.
|
||||
2. On the HomeKit integration, select **Configure**.
|
||||
2. On the HomeKit Device integration, select **Configure**.
|
||||
|
||||
|
||||
3. Enter your HomeKit pairing code.
|
||||
- Add the device to a room and select **Finish**.
|
||||
- The device should now be added to your Home Assistant instance.
|
||||
4. Once Home Assistant is configured to work with the device, you can export it back to Siri and Apple Home with the [`HomeKit`](/integrations/homekit/) integration.
|
||||
4. Once Home Assistant is configured to work with the device, you can export it back to Siri and Apple Home with the [`HomeKit Bridge`](/integrations/homekit/) integration.
|
||||
|
||||
## Adding a HomeKit device through Bluetooth
|
||||
|
||||
@ -106,7 +106,7 @@ You can add a HomeKit [compatible device](#supported-devices) to Home Assistant
|
||||
|
||||
1. Power up your HomeKit device.
|
||||
- If you have Bluetooth enabled, the device should be discovered under **{% my integrations title="Settings > Devices & Services" %}**.
|
||||
2. On the HomeKit integration, select **Configure**.
|
||||
2. On the HomeKit Bridge integration, select **Configure**.
|
||||
|
||||
|
||||
3. To pair the device, enter the HomeKit pairing code.
|
||||
|
||||
@ -43,7 +43,7 @@ longitude:
|
||||
type: integer
|
||||
diaspora:
|
||||
required: false
|
||||
description: Consider the location as diaspora or not for calculation of the weekly portion and holidays.
|
||||
description: Consider the location as diaspora (חוץ לארץ) for calculation of the weekly portion and holidays. By default it will consider the location as Israel (One day Yom Tov), setting it to true will show a second day Yom Tov.
|
||||
default: false
|
||||
type: string
|
||||
candle_lighting_minutes_before_sunset:
|
||||
|
||||
@ -21,7 +21,7 @@ Integrates LD2410 BLE sensors from [Hi-Link](http://www.hlktech.net/) into Home
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
You can currently configure the settings for motion/static triggers by USB with either the [desktop software](https://drive.google.com/drive/folders/1p4dhbEJA3YubyIjIIC7wwVsSo8x29Fq-?usp=sharing) or the Bluetooth [mobile app](https://www.pgyer.com/Lq8p).
|
||||
You can currently configure the settings for motion/static triggers by USB with either the [desktop software](https://drive.google.com/drive/folders/1p4dhbEJA3YubyIjIIC7wwVsSo8x29Fq-?usp=sharing) via Bluetooth. Download HLKRadarTool on [Google Play](https://play.google.com/store/apps/details?id=com.hlk.hlkradartool) or the [App Store](https://apps.apple.com/app/hlkradartool/id1638651152).
|
||||
|
||||
(This integration may not work if you reconfigure the default password or the number of gates.)
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ To use HomeKit Controller:
|
||||
### Pairing with Home Assistant
|
||||
|
||||
- Go to {% my integrations title="Settings >> Devices & Services" %} in the Home Assistant UI.
|
||||
- Click the button with + sign, and from the list of integrations, select ***HomeKit Controller***.
|
||||
- Click the button with + sign, and from the list of integrations, select ***HomeKit Device***.
|
||||
- Select the `MyQ-...` bridge.
|
||||
- Enter the pairing code that is physically printed on a sticker on the bridge.
|
||||
- Complete the remaining steps.
|
||||
@ -64,6 +64,6 @@ To use HomeKit Controller:
|
||||
If you want the devices to be accessible via HomeKit, create a HomeKit Bridge using the following steps:
|
||||
|
||||
- Go to {% my integrations title="Settings >> Devices & Services" %} in the Home Assistant UI.
|
||||
- Click the button with + sign, and from the list of integrations, select ***HomeKit***.
|
||||
- Click the button with + sign, and from the list of integrations, select ***HomeKit Bridge***.
|
||||
- Create a bridge for the `cover` domain.
|
||||
- Follow the instructions to pair with the bridge.
|
||||
|
||||
@ -18,8 +18,8 @@ ha_integration_type: integration
|
||||
|
||||
The `nissan_leaf` integration offers integration with the [NissanConnect EV](https://www.nissan.co.uk/dashboard.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. It offers:
|
||||
|
||||
- sensors for the battery status, range and charging status
|
||||
- a switch to start and stop the climate control
|
||||
- sensors for the battery status, range and charging status.
|
||||
- a switch to start and stop the climate control.
|
||||
- a button to request the car starts charging.
|
||||
- service to request updates from the car.
|
||||
|
||||
|
||||
@ -28,9 +28,11 @@ There is currently support for the following device types within Home Assistant:
|
||||
You need an API key, which is free, but requires a [registration](https://home.openweathermap.org/users/sign_up).
|
||||
|
||||
<div class='note'>
|
||||
|
||||
If you register an new API key with OpenWeatherMap, it will be activated automatically, this typically takes between 10 minutes and 2 hours
|
||||
after your successful registration. Keep in mind when configuring this integration, that you new API key might
|
||||
not be activated yet. Recent policy changes limit the API access for new registered users with a free plan, they should select the `hourly` mode. The other modes require a paid subscription plan. Invalid API-key errors might occur if your API key is used with the other modes.
|
||||
|
||||
</div>
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -18,6 +18,8 @@ ha_integration_type: service
|
||||
The `ovo_energy` integration allows you to monitor your energy consumption data
|
||||
in Home Assistant.
|
||||
|
||||
Currently, this integration only supports OVO Energy in the UK.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Sensors
|
||||
|
||||
@ -76,3 +76,18 @@ unit_of_measurement:
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### Examples
|
||||
|
||||
In this section you find am example of how this sensor can be used.
|
||||
|
||||
Create a random sensor called "My random sensor" which will return a number between 10 (minimum) and 500 (maximum).
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: random
|
||||
name: "My random sensor"
|
||||
minimum: 10
|
||||
maximum: 500
|
||||
```
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Supla
|
||||
description: Instructions for integration with Supla Cloud's Web API
|
||||
title: SUPLA
|
||||
description: Instructions for integration with SUPLA-CLOUD's Web API
|
||||
ha_release: 0.92
|
||||
ha_category:
|
||||
- Cover
|
||||
@ -15,22 +15,25 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The [Supla](https://supla.org/) is an Open Source home automation system for ESP8266 based devices. It has its own set of protocols, its own firmware and commercially available devices (produced for example by [Zamel](https://zamel.pl/pl-PL/produkty/supla-sterowanie-wi-fi))
|
||||
The SUPLA integration allows you to use [SUPLA](https://supla.org/) devices in Home Assistant.
|
||||
|
||||
Currently only covers (shutters in Supla's lingo), gates, garage doors and switches are supported, but, thanks to comprehensive and universal REST API, it's pretty easy to add more.
|
||||
SUPLA-DEV is an open source home automation system for Raspberry Pi, Arduino or ESP8266-based devices. It has its own protocols, firmware and commercially available devices, such as those produced by [Zamel](https://supla.zamel.com/en/).
|
||||
|
||||
Right now it's impossible to add a device -- all of them are discovered from Supla Cloud's servers or yours.
|
||||
Devices disabled on Supla Cloud will not be loaded into Home Assistant.
|
||||
Currently, only covers (shutters in SUPLA's terminology), gates, garage doors, and switches are supported, but thanks to comprehensive and universal REST API, it's pretty easy to add more.
|
||||
|
||||
Right now, it's impossible to add a device -- all of them are discovered from SUPLA-CLOUD's servers or yours.
|
||||
|
||||
Devices disabled on SUPLA-CLOUD will not be loaded into Home Assistant.
|
||||
|
||||
## Configuration
|
||||
|
||||
To use Supla devices in your installation, add the following to your `configuration.yaml`:
|
||||
To use SUPLA devices in your installation, add the following to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
supla:
|
||||
servers:
|
||||
- server: svr1.supla.org
|
||||
access_token: YOUR_ACCESS_TOKEN
|
||||
- server: "svr1.supla.org"
|
||||
access_token: "YOUR_ACCESS_TOKEN"
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
@ -40,11 +43,11 @@ servers:
|
||||
type: list
|
||||
keys:
|
||||
server:
|
||||
description: Address of your Supla Cloud server (either IP or DNS name)
|
||||
description: Address of the SUPLA-CLOUD server (either IP address or DNS name); can either be the (cloud hosted)[https://cloud.supla.org] instance, or a (self hosted)[https://github.com/SUPLA/supla-cloud] instance.
|
||||
required: true
|
||||
type: string
|
||||
access_token:
|
||||
description: An access token for REST API configuration. Can be acquired from `http[s]://your.server.org/integrations/tokens` (please add at least Channel's Read and Action Execution permissions).
|
||||
description: An access token for REST API configuration. Under **Scopes** > **Channels**, at least the **Read** and **Action execution** permissions are required to be enabled. A token can be obtained from the Security section of SUPLA-CLOUD for [Personal Access Token](https://cloud.supla.org/security/personal-access-tokens) page, or from your own self hosted instance.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -1,11 +1,81 @@
|
||||
---
|
||||
title: "Security"
|
||||
description: "Information about disclosing security vulnerabilities in Home Assistant."
|
||||
description: "Home Assistant takes its security seriously. This page contains information about how we handle security issues, how to report them, and also information on past security issues."
|
||||
---
|
||||
|
||||
If you think that you have found a security vulnerability in Home Assistant, please disclose it to us via our security e-mail address at [security@home-assistant.io](mailto:security@home-assistant.io).
|
||||
Home Assistant takes its security seriously. We will do everything in our power to ensure that our users are safe.
|
||||
|
||||
Please do not make vulnerabilities public without notifying us and giving us at least 3 days to respond.
|
||||
This page is intended to provide information about how to report security issues with us, and how they are handled. Additionally, it provides details about reported security issues we have [handled in the past](#past-advisories).
|
||||
|
||||
If you are going to write about Home Assistant's security, please get in touch, so we can make sure that all claims are correct.
|
||||
|
||||
## Reporting a vulnerability
|
||||
|
||||
So, you have found a security vulnerability in Home Assistant? Please, be sure to [**responsibly disclose**](https://en.wikipedia.org/wiki/Coordinated_vulnerability_disclosure) it to us by [reporting a vulnerability using GitHub's Security Advisory](https://github.com/home-assistant/core/security/advisories/new).
|
||||
|
||||
**DO NOT MAKE A PUBLIC ISSUES FOR SECURITY VULNERABILITIES!**
|
||||
|
||||
We are mostly interested in reports by actual Home Assistant users that are familiar with the platform, but all high quality contributions are welcome. Please do your best to describe a clear and realistic impact for your report.
|
||||
|
||||
For the sake of the security of our users, please 🙏 do not make vulnerabilities public without notifying us and giving us at least 90 days to release a fixed version. We will do our best to respond to your report within 7 days and also to keep you informed of the progress of our efforts to resolve the issue, but understand that Home Assistant, like many open source projects, is relying heavily on volunteers that aren't full-time resources. We may not be able to respond as quickly as you would like due to other responsibilities.
|
||||
|
||||
If you are going to write about Home Assistant’s security, please [get in touch](mailto:hello@home-assistant.io), so we can ensure that all claims are correct.
|
||||
|
||||
### Non-qualifying vulnerabilities
|
||||
|
||||
We will not accept reports of vulnerabilities of the following types:
|
||||
|
||||
- Reports from automated tools or scanners.
|
||||
- Theoretical attacks without proof of exploitability.
|
||||
- Attacks that are the result of a third-party application or library (these should instead be reported to the library maintainers).
|
||||
- Social engineering.
|
||||
- Attacks that require the user to have access to the Home Assistant host system.
|
||||
- Attacks involving physical access to a user’s device, or involving a device or network that’s already seriously compromised (like, man-in-the-middle).
|
||||
- Attacks that require the user to install a malicious other software, like a third-party integration, add-on, or plugin.
|
||||
- Attacks that the user can only perform against their own setup.
|
||||
- Privilege escalation attacks for logged in users. Home Assistant assumes every user is trusted and does not enforce user privileges. It assumes every logged in user has the same access as an owner account ([more information](/docs/authentication/#user-accounts)).
|
||||
|
||||
### Supported versions
|
||||
|
||||
We only accept reports against the latest stable & official versions of Home Assistant or any versions beyond that are currently in development or beta test. The latest version can be found on our [GitHub releases page](https://github.com/home-assistant/core/releases).
|
||||
|
||||
We do not accept reports against forks of Home Assistant.
|
||||
|
||||
### Severity scoring
|
||||
|
||||
If you are familiar with [CVSS3.1](https://www.first.org/cvss/v3.1/specification-document), please provide the vulnerability score in your report in the shape of a vector string. There’s a [calculator](https://www.first.org/cvss/calculator/3.1) that can be helpful. If you are unsure how or unable to score a vulnerability, state that in your report, and we will look into it.
|
||||
|
||||
If you intend to provide a score, please familiarize yourself with CVSS first (we strongly recommend reading the [Specification](https://www.first.org/cvss/v3.1/specification-document) and [Scoring Guide](https://www.first.org/cvss/v3.1/user-guide#Scoring-Guide)), as we will not accept reports that use it incorrectly.
|
||||
|
||||
### Public disclosure & CVE assignment
|
||||
|
||||
We will publish GitHub Security Advisories and through those, will also request CVEs, for valid vulnerabilities that meet the following criteria:
|
||||
|
||||
- The vulnerability is in Home Assistant itself, not a third-party library.
|
||||
- The vulnerability is not already known to us.
|
||||
- The vulnerability is not already known to the public.
|
||||
- CVEs will only be requested for vulnerabilities with a severity of medium or higher.
|
||||
|
||||
### Bounties
|
||||
|
||||
As an open source project, Home Assistant cannot offer bounties for security vulnerabilities. However, if so desired, we of course will credit the discoverer of a vulnerability.
|
||||
|
||||
## Past advisories
|
||||
|
||||
The following is a list of past security advisories that have been published by the Home Assistant project.
|
||||
|
||||
**2023-03-08: Authentication bypass Supervisor API**
|
||||
Severity: _Critical (CVSS: 10.0)_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-2j8f-h4mr-qr25)_
|
||||
Assigned CVE: _[CVE-2023-27482](https://nvd.nist.gov/vuln/detail/CVE-2023-27482)_
|
||||
Discovered by: _[Joseph Surin](https://jsur.in/) from [elttam](https://www.elttam.com/)_
|
||||
Fixed in: _Core 2023.3.2, Supervisor 2023.03.3_
|
||||
|
||||
**2017-10-11: Cross-site scripting in Markdown output**
|
||||
Severity: _Medium (CVSS: 6.1)_
|
||||
Detailed information: _[Pull request](https://github.com/home-assistant/frontend/pull/514)_
|
||||
Assigned CVE: _[CVE-2017-16782](https://nvd.nist.gov/vuln/detail/CVE-2017-16782)_
|
||||
Discovered by: _Marcin Teodorczyk from [intive.com](https://intive.com/)_
|
||||
Fixed in: _Core 0.57_
|
||||
|
||||
---
|
||||
|
||||
_This security page is heavily inspired by the one from [OctoPrint](https://octoprint.org). ❤️ If you are into 3D printing, check them out!_
|
||||
|
||||
@ -34,7 +34,7 @@ If the voice assistant doesn't understand you, you may need to rephrase your sen
|
||||
To get an idea of the specific sentences that are supported for your language, you can do the following:
|
||||
|
||||
1. Take a look at the test sentences:
|
||||
- On github, in the [tests](https://github.com/home-assistant/intents/tree/main/sentences) folder, open the subfolder for your language.
|
||||
- On GitHub, in the [tests](https://github.com/home-assistant/intents/tree/main/sentences) folder, open the subfolder for your language.
|
||||
- Look through the test files to see the example sentences that have been tested.
|
||||
- The second part of the file name shows the {% term intent %}, the first part shows the domain. For some domains, such as covers, fans, and light, there are specific sentences.
|
||||
The other domains are covered by the generic *homeassistant_*.
|
||||
@ -47,7 +47,7 @@ To get an idea of the specific sentences that are supported for your language, y
|
||||
|
||||
|
||||
2. View the sentence definition:
|
||||
- On github, in the [tests](https://github.com/home-assistant/intents/tree/main/tests) folder, open the subfolder for your language.
|
||||
- On GitHub, in the [tests](https://github.com/home-assistant/intents/tree/main/tests) folder, open the subfolder for your language.
|
||||
- Open the file of interest.
|
||||
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user