mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Minimizing of the configuration sample (#1048)
This commit is contained in:
parent
be80d1bb7b
commit
53c42e5fd9
@ -8,7 +8,7 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: ecobee.png
|
logo: ecobee.png
|
||||||
ha_category: Sensor
|
ha_category: Binary Sensor
|
||||||
ha_release: 0.9
|
ha_release: 0.9
|
||||||
ha_iot_class: "Local Push"
|
ha_iot_class: "Local Push"
|
||||||
---
|
---
|
||||||
|
@ -21,11 +21,8 @@ To enable it, add the following lines to your `configuration.yaml`:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: command_line
|
- platform: command_line
|
||||||
command: SENSOR_COMMAND
|
command: SENSOR_COMMAND
|
||||||
name: Command sensor
|
|
||||||
unit_of_measurement: "°C"
|
|
||||||
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -17,7 +17,6 @@ The `enocean` sensor platform currently only allows reading out the power measur
|
|||||||
|
|
||||||
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
|
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
|
@ -47,13 +47,10 @@ To setup a GPSD sensor in your installation, add the following to your `configur
|
|||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
senosr:
|
senosr:
|
||||||
- platform: gpsd
|
- platform: gpsd
|
||||||
host: 127.0.0.1
|
|
||||||
port: 2947
|
|
||||||
name: GPS USB
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
- **host** (*Optional*): The host where GPSD is running. Defaults to `localhost`.
|
- **host** (*Optional*): The host where GPSD is running. Defaults to `localhost`.
|
||||||
- **port** (*Optional*): The port which GPSD is using. Defaults to 2947.
|
- **port** (*Optional*): The port which GPSD is using. Defaults to `2947`.
|
||||||
- **name** (*Optional*): Friendly name to use for the frontend. Default to GPS.
|
- **name** (*Optional*): Friendly name to use for the frontend. Default to GPS.
|
||||||
|
@ -23,7 +23,6 @@ sensor:
|
|||||||
- platform: imap
|
- platform: imap
|
||||||
server: imap.gmail.com
|
server: imap.gmail.com
|
||||||
port: 993
|
port: 993
|
||||||
name: Emails
|
|
||||||
username: USERNAME
|
username: USERNAME
|
||||||
password: PASSWORD
|
password: PASSWORD
|
||||||
```
|
```
|
||||||
|
@ -23,12 +23,10 @@ sensor:
|
|||||||
- platform: imap_email_content
|
- platform: imap_email_content
|
||||||
server: imap.gmail.com
|
server: imap.gmail.com
|
||||||
port: 993
|
port: 993
|
||||||
name: Emails
|
|
||||||
username: USERNAME
|
username: USERNAME
|
||||||
password: PASSWORD
|
password: PASSWORD
|
||||||
senders:
|
senders:
|
||||||
- example@gmail.com
|
- example@gmail.com
|
||||||
value_template: TEMPLATE
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -21,7 +21,6 @@ To use this sensor in your installation, add the following to your `configuratio
|
|||||||
sensor:
|
sensor:
|
||||||
- platform: mhz19
|
- platform: mhz19
|
||||||
serial_device: /dev/tty.SLAB_USBtoUART
|
serial_device: /dev/tty.SLAB_USBtoUART
|
||||||
name: CO2
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- **serial_device** (*Required*): The serial port to use. On *nix systems, it can often be identified by `$ ls /dev/tty*`
|
- **serial_device** (*Required*): The serial port to use. On *nix systems, it can often be identified by `$ ls /dev/tty*`
|
||||||
|
@ -19,12 +19,20 @@ The sensor data may be used e.g. to signal bad air quality (too high air humidit
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: mold_indicator
|
- platform: mold_indicator
|
||||||
indoor_temp_sensor: sensor.temp
|
indoor_temp_sensor: sensor.temp
|
||||||
indoor_humidity_sensor: sensor.humidity
|
indoor_humidity_sensor: sensor.humidity
|
||||||
outdoor_temp_sensor: sensor.weather_temperature
|
outdoor_temp_sensor: sensor.weather_temperature
|
||||||
calibration_factor: 2.0 # Needs to be calibrated to the critical point in the room
|
calibration_factor: 2.0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Configuration variables:
|
||||||
|
|
||||||
|
- **indoor_temp_sensor** (*Required*): The enditiy ID of the indoor temperature sensor.
|
||||||
|
- **indoor_humidity_sensor** (*Required*): The enditiy ID of the indoor humidity sensor.
|
||||||
|
- **outdoor_temp_sensor** (*Required*): The enditiy ID of the outdoor temperature sensor.
|
||||||
|
- **calibration_factor** (*Required*): Needs to be calibrated to the critical point in the room.
|
||||||
|
|
||||||
In this case, the weather forecast temperature sensor is used for the outside temperature.
|
In this case, the weather forecast temperature sensor is used for the outside temperature.
|
||||||
|
|
||||||
## {% linkable_title Calibration %}
|
## {% linkable_title Calibration %}
|
||||||
|
@ -21,12 +21,8 @@ To use your MQTT sensor in your installation, add the following to your `configu
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: mqtt
|
- platform: mqtt
|
||||||
state_topic: "home/bedroom/temperature"
|
state_topic: "home/bedroom/temperature"
|
||||||
name: "MQTT Sensor"
|
|
||||||
qos: 0
|
|
||||||
unit_of_measurement: "°C"
|
|
||||||
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -10,6 +10,7 @@ footer: true
|
|||||||
logo: mysensors.png
|
logo: mysensors.png
|
||||||
ha_category: Sensor
|
ha_category: Sensor
|
||||||
featured: false
|
featured: false
|
||||||
|
ha_iot_class: "Local Push"
|
||||||
---
|
---
|
||||||
|
|
||||||
Integrates MySensors sensors into Home Assistant. See the [main component] for configuration instructions.
|
Integrates MySensors sensors into Home Assistant. See the [main component] for configuration instructions.
|
||||||
|
@ -22,6 +22,7 @@ You must have the [Nest component](/components/nest/) configured to use those se
|
|||||||
To set it up, add the following information to your `configuration.yaml` file:
|
To set it up, add the following information to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: nest
|
platform: nest
|
||||||
monitored_conditions:
|
monitored_conditions:
|
||||||
|
@ -8,7 +8,7 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: neurio.png
|
logo: neurio.png
|
||||||
ha_category: Sensor
|
ha_category: Energy
|
||||||
ha_iot_class: "Cloud Polling"
|
ha_iot_class: "Cloud Polling"
|
||||||
ha_release: 0.14
|
ha_release: 0.14
|
||||||
---
|
---
|
||||||
@ -24,7 +24,6 @@ sensor:
|
|||||||
platform: neurio_energy
|
platform: neurio_energy
|
||||||
api_key: API_KEY
|
api_key: API_KEY
|
||||||
api_secret: API_SECRET
|
api_secret: API_SECRET
|
||||||
sensor_id: "SENSOR_ID"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -23,7 +23,7 @@ To set it up, add the following information to your `configuration.yaml` file:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
sensor:
|
sensor:
|
||||||
platform: octoprint
|
- platform: octoprint
|
||||||
name: OctoPrint
|
name: OctoPrint
|
||||||
monitored_conditions:
|
monitored_conditions:
|
||||||
- Current State
|
- Current State
|
||||||
|
@ -28,10 +28,9 @@ To enable One wire sensors in your installation, add the following to your `conf
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: onewire
|
- platform: onewire
|
||||||
names:
|
names:
|
||||||
some_id: your name
|
some_id: your name
|
||||||
mount_dir: "/mnt/1wire"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -21,10 +21,6 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
|
|||||||
sensor:
|
sensor:
|
||||||
platform: rest
|
platform: rest
|
||||||
resource: http://IP_ADDRESS/ENDPOINT
|
resource: http://IP_ADDRESS/ENDPOINT
|
||||||
value_template: '{% raw %}{{ value_json.thermostat }}{% endraw %}'
|
|
||||||
method: GET
|
|
||||||
name: REST GET sensor
|
|
||||||
unit_of_measurement: "°C"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
or for a POST request:
|
or for a POST request:
|
||||||
@ -35,11 +31,7 @@ sensor:
|
|||||||
platform: rest
|
platform: rest
|
||||||
resource: http://IP_ADDRESS/ENDPOINT
|
resource: http://IP_ADDRESS/ENDPOINT
|
||||||
method: POST
|
method: POST
|
||||||
value_template: '{% raw %}{{ value_json.thermostat }}{% endraw %}'
|
|
||||||
payload: '{ "device" : "heater" }'
|
payload: '{ "device" : "heater" }'
|
||||||
name: REST POST sensor
|
|
||||||
unit_of_measurement: "°C"
|
|
||||||
verify_ssl: False
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
@ -17,6 +17,7 @@ First you have to set up your [rfxtrx hub](/components/rfxtrx/).
|
|||||||
The easiest way to find your sensors is to add this to your `configuration.yaml`:
|
The easiest way to find your sensors is to add this to your `configuration.yaml`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: rfxtrx
|
platform: rfxtrx
|
||||||
automatic_add: True
|
automatic_add: True
|
||||||
@ -32,6 +33,7 @@ Here the name is `0a52080000301004d240259` and you can verify that it works from
|
|||||||
Then you should update your configuration to:
|
Then you should update your configuration to:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: rfxtrx
|
platform: rfxtrx
|
||||||
devices:
|
devices:
|
||||||
@ -42,6 +44,7 @@ sensor:
|
|||||||
If you want to display several data types from one sensor:
|
If you want to display several data types from one sensor:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: rfxtrx
|
platform: rfxtrx
|
||||||
devices:
|
devices:
|
||||||
|
@ -7,7 +7,7 @@ sidebar: true
|
|||||||
comments: false
|
comments: false
|
||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: sleepiq
|
logo: sleepiq.png
|
||||||
ha_category: Sensor
|
ha_category: Sensor
|
||||||
ha_release: 0.29
|
ha_release: 0.29
|
||||||
ha_iot_class: "Local Polling"
|
ha_iot_class: "Local Polling"
|
||||||
|
@ -16,16 +16,12 @@ The TCP component allows the integration of some services for which a specific H
|
|||||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
sensor:
|
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
platform: tcp
|
sensor:
|
||||||
name: Central Heating Pressure
|
- platform: tcp
|
||||||
host: IP_ADDRESS
|
host: IP_ADDRESS
|
||||||
port: PORT
|
port: PORT
|
||||||
timeout: 5
|
|
||||||
payload: PAYLOAD
|
payload: PAYLOAD
|
||||||
value_template: "{% raw %}{{ value.split(';')[0] }}{% endraw %}"
|
|
||||||
unit: UNIT_OF_MEASUREMENT
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration options for the a TCP Sensor:
|
Configuration options for the a TCP Sensor:
|
||||||
|
@ -12,6 +12,5 @@ ha_category: Sensor
|
|||||||
featured: false
|
featured: false
|
||||||
---
|
---
|
||||||
|
|
||||||
Integrates Telldus Live sensors into Home Assistant. See the [main component] for configuration instructions.
|
Integrates Telldus Live sensors into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.
|
||||||
|
|
||||||
[main component]: /components/tellduslive/
|
|
||||||
|
@ -20,18 +20,28 @@ To use your TellStick device, you first have to set up your [Tellstick hub](http
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: tellstick
|
- platform: tellstick
|
||||||
|
```
|
||||||
|
|
||||||
|
Configuration variables:
|
||||||
|
|
||||||
|
- **ID: Name** (*Optional*): Entry for a sensor with the name for it and its ID.
|
||||||
|
- **only_named** (*Optional*): Only show the named sensors. Set to `True` to hide sensors.
|
||||||
|
- **temperature_scale** (*Optional*): The scale of the temperature value.
|
||||||
|
- **datatype_mask** (*Optional*): Mask to determine which sensor values to show based on. Please check the [TellCore tellcore.constants documentation](https://tellcore-py.readthedocs.org/en/v1.1.2/constants.html#module-tellcore.constants) for details.
|
||||||
|
|
||||||
|
## {% linkable_title Examples %}
|
||||||
|
|
||||||
|
In this section you find some real life examples of how to use this sensor.
|
||||||
|
|
||||||
|
### {% linkable_title Full configuration %}
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
sensor:
|
||||||
|
- platform: tellstick
|
||||||
135: Outside
|
135: Outside
|
||||||
21: Inside
|
21: Inside
|
||||||
only_named: True
|
only_named: True
|
||||||
temperature_scale: "°C"
|
temperature_scale: "°C"
|
||||||
datatype_mask: 1
|
datatype_mask: 1
|
||||||
```
|
|
||||||
|
|
||||||
Configuration variables:
|
|
||||||
|
|
||||||
- **ID: Name** *Optional*: Entry for a sensor with the name for it and its ID.
|
|
||||||
- **only_named** *Optional*: Only show the named sensors. Set to `True` to hide sensors.
|
|
||||||
- **temperature_scale** *Optional*: The scale of the temperature value.
|
|
||||||
- **datatype_mask** *Optional*: Mask to determine which sensor values to show based on. Please check the [TellCore tellcore.constants documentation](https://tellcore-py.readthedocs.org/en/v1.1.2/constants.html#module-tellcore.constants) for details.
|
|
||||||
|
|
||||||
|
@ -17,12 +17,16 @@ To use your TEMPer sensor in your installation, add the following to your `confi
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: temper
|
- platform: temper
|
||||||
name: 'My TEMPer'
|
|
||||||
scale: 1
|
|
||||||
offset: 0
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Configuration options for the a TCP Sensor:
|
||||||
|
|
||||||
|
- **name** (*Optional*): The name you would like to give the sensor in Home Assistant.
|
||||||
|
- **scale** (*Optional*): The scale for the sensor.
|
||||||
|
- **offset** (*Optional*): The offset to fix reported vales.
|
||||||
|
|
||||||
Since some of these sensors consistently show higher temperatures the scale and offset values can be used to fine-tune your sensor.
|
Since some of these sensors consistently show higher temperatures the scale and offset values can be used to fine-tune your sensor.
|
||||||
The calculation follows the formula `scale * sensor value + offset`.
|
The calculation follows the formula `scale * sensor value + offset`.
|
||||||
|
|
||||||
|
@ -35,7 +35,7 @@ Configuration variables:
|
|||||||
- **sensors** array (*Required*): List of your sensors.
|
- **sensors** array (*Required*): List of your sensors.
|
||||||
- **friendly_name** (*Optional*): Name to use in the Frontend.
|
- **friendly_name** (*Optional*): Name to use in the Frontend.
|
||||||
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
|
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
|
||||||
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
- **value_template** (*Required*): Defines a [template](/topics/templating/) to extract a value from the event bus.
|
||||||
- **entity_id** (*Optional*): Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update it's state.
|
- **entity_id** (*Optional*): Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update it's state.
|
||||||
|
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ To enable this sensor in your installation, add the following to your `configura
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
platform: thinkingcleaner
|
- platform: thinkingcleaner
|
||||||
```
|
```
|
||||||
|
|
||||||
This will automatically add sensors for each Thinking Cleaner in your network.
|
This will automatically add sensors for each Thinking Cleaner in your network.
|
||||||
|
@ -12,7 +12,7 @@ ha_category: Sensor
|
|||||||
featured: false
|
featured: false
|
||||||
---
|
---
|
||||||
|
|
||||||
Integrates Verisure sensors into Home Assistant. See the [main component] for configuration instructions.
|
Integrates Verisure sensors into Home Assistant. See the [main component](/components/verisure/) for configuration instructions.
|
||||||
|
|
||||||
The following sensor types are supported:
|
The following sensor types are supported:
|
||||||
|
|
||||||
@ -20,5 +20,3 @@ The following sensor types are supported:
|
|||||||
* Hygrometers
|
* Hygrometers
|
||||||
* Mouse detectors
|
* Mouse detectors
|
||||||
|
|
||||||
|
|
||||||
[main component]: /components/verisure/
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user