mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 05:46:52 +00:00
e-integrations: add glossary reference to config file (#32754)
This commit is contained in:
c0ffeeca7
GitHub
parent
02ee39a27c
commit
e5d95eeeed
@ -108,7 +108,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha
|
||||
1. Log in to your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password.
|
||||
2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'. **If the system support XMPP, disable XMPP by invalidating the configuration in the XMPP menu (for example by changing the user name). This is required for recent firmwares of the GATE-03 system as it does not use the Reporting server at all in the case of a valid XMPP configuration.**
|
||||
3. The Egardia integration relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e., the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia integration to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
|
||||
4. Once you have the codes, update your `configuration.yaml`:
|
||||
4. Once you have the codes, update your {% term "`configuration.yaml`" %}:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
egardia:
|
||||
|
||||
@ -146,7 +146,7 @@ The complete list of trouble statuses are:
|
||||
|
||||
## Manual configuration
|
||||
|
||||
Alternatively, configuration through the `configuration.yaml` file
|
||||
Alternatively, configuration through the {% term "`configuration.yaml`" %} file
|
||||
is supported (example below).
|
||||
|
||||
Both methods of configuration support "auto configuration". This works by
|
||||
@ -561,7 +561,7 @@ Speak a word. The list of words is defined in the ElkM1 ASCII Protocol documenta
|
||||
Debug logs are often required to solve an issue. Follow the instructions on [Enabling debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging).
|
||||
|
||||
Sometimes, for example, a problem can occur while starting Home Assistant. In this case, follow these instructions.
|
||||
Add the following to your `configuration.yaml` file in your Home Assistant `config` directory:
|
||||
Add the following to your {% term "`configuration.yaml`" %} file in your Home Assistant `config` directory:
|
||||
|
||||
```yaml
|
||||
logger:
|
||||
|
||||
@ -131,7 +131,7 @@ You can find the `event_data` `id` by going to {% my developer_events title="Dev
|
||||
|
||||
An EnOcean light can take many forms. Currently only one type has been tested: Eltako FUD61 dimmer.
|
||||
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file:
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -166,7 +166,7 @@ The EnOcean sensor platform currently supports the following device types:
|
||||
- [temperature sensor](#temperature-sensor)
|
||||
- [window handle](#window-handle)
|
||||
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file:
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -197,7 +197,7 @@ device_class:
|
||||
|
||||
This has been tested with a Permundo PSC234 switch, but any device sending EEP **A5-12-01** messages will work.
|
||||
|
||||
Add the following to your `configuration.yaml` file:
|
||||
Add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -217,7 +217,7 @@ The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/spec
|
||||
- **A5-04-02** - Temp. and Humidity Sensor, Range -20°C to +60°C and 0% to 100%
|
||||
- **A5-10-10** to **A5-10-14** - Room Operating Panels
|
||||
|
||||
Add the following to your `configuration.yaml` file:
|
||||
Add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -246,7 +246,7 @@ The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/spec
|
||||
Check the manual of your temperature sensor to figure out what EEP it uses.
|
||||
If you do not know, make an educated guess and check the reported values. It's easiest to validate the temperature at the boundaries of the range, so maybe put the sensor into the fridge for a while.
|
||||
|
||||
Add the following to your `configuration.yaml` file:
|
||||
Add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -290,7 +290,7 @@ However, some EEPs have a different, inverted range, which goes from 0 to 250. T
|
||||
- **A5-10-10** to **A5-10-14**
|
||||
- **A5-20-01** - Battery powered actuator (bi-dir)
|
||||
|
||||
Adapt the `configuration.yaml` for those sensors:
|
||||
Adapt the {% term "`configuration.yaml`" %} for those sensors:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for EEP A5-10-10
|
||||
@ -307,7 +307,7 @@ sensor:
|
||||
|
||||
As of now, the Hoppe SecuSignal window handle from Somfy has been successfully tested. However, any mechanical window handle that follows the EnOcean RPS telegram spec F6 10 00 (Hoppe AG) is supported.
|
||||
|
||||
To configure a window handle, add the following code to your `configuration.yaml`:
|
||||
To configure a window handle, add the following code to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for window handle EEP F6-10-00
|
||||
@ -330,7 +330,7 @@ The window handle sensor can have the following states:
|
||||
|
||||
An EnOcean switch can take many forms. Currently, only a few types have been tested: Permundo PSC234 and Nod On SIN-2-1-01.
|
||||
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file:
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -11,11 +11,15 @@ ha_domain: ephember
|
||||
ha_platforms:
|
||||
- climate
|
||||
ha_integration_type: integration
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
title: Configuration file
|
||||
---
|
||||
|
||||
The `ephember` climate platform lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a Wi-Fi gateway to control your EPH system and an account on the EMBER app.
|
||||
The `ephember` {% term integration %} lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a Wi-Fi gateway to control your EPH system and an account on the EMBER app.
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
|
||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
||||
|
||||
```yaml
|
||||
climate:
|
||||
|
||||
@ -57,7 +57,7 @@ ESPHome devices can make service calls to any [Home Assistant service](https://e
|
||||
|
||||
## Entity naming and IDs
|
||||
|
||||
ESPHome uses different naming and entity ID rules based on the configuration of the ESPHome device. It is recommended to set a `friendly_name` in the ESPHome `configuration.yaml` to take advantage of the newer naming structure, which is consistent with Home Assistant naming standards and makes it much easier to tell similar devices apart. The legacy naming rules apply when the `friendly_name` is not set in the `configuration.yaml`.
|
||||
ESPHome uses different naming and entity ID rules based on the configuration of the ESPHome device. It is recommended to set a `friendly_name` in the ESPHome {% term "`configuration.yaml`" %} to take advantage of the newer naming structure, which is consistent with Home Assistant naming standards and makes it much easier to tell similar devices apart. The legacy naming rules apply when the `friendly_name` is not set in the {% term "`configuration.yaml`" %}.
|
||||
|
||||
### Friendly naming
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user