diff --git a/source/_components/binary_sensor.ecobee.markdown b/source/_components/binary_sensor.ecobee.markdown index 154b478d4e7..189c943bf97 100644 --- a/source/_components/binary_sensor.ecobee.markdown +++ b/source/_components/binary_sensor.ecobee.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ecobee.png -ha_category: Sensor +ha_category: Binary Sensor ha_release: 0.9 ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index 814ab0461c9..6c7f6a42b48 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -21,11 +21,8 @@ To enable it, add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry sensor: - platform: command_line - command: SENSOR_COMMAND - name: Command sensor - unit_of_measurement: "°C" - value_template: '{% raw %}{{ value.x }}{% endraw %}' + - platform: command_line + command: SENSOR_COMMAND ``` Configuration variables: diff --git a/source/_components/sensor.enocean.markdown b/source/_components/sensor.enocean.markdown index 654c054a923..347d5430067 100644 --- a/source/_components/sensor.enocean.markdown +++ b/source/_components/sensor.enocean.markdown @@ -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: - ```yaml # Example configuration.yaml entry sensor: diff --git a/source/_components/sensor.gpsd.markdown b/source/_components/sensor.gpsd.markdown index 0b955d6b678..1209bd6fee5 100644 --- a/source/_components/sensor.gpsd.markdown +++ b/source/_components/sensor.gpsd.markdown @@ -47,13 +47,10 @@ To setup a GPSD sensor in your installation, add the following to your `configur # Example configuration.yaml entry senosr: - platform: gpsd - host: 127.0.0.1 - port: 2947 - name: GPS USB ``` Configuration variables: - **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. diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown index 7001f25e6f1..631751d5476 100644 --- a/source/_components/sensor.imap.markdown +++ b/source/_components/sensor.imap.markdown @@ -23,7 +23,6 @@ sensor: - platform: imap server: imap.gmail.com port: 993 - name: Emails username: USERNAME password: PASSWORD ``` diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown index 8487def7b58..78cd12caee0 100644 --- a/source/_components/sensor.imap_email_content.markdown +++ b/source/_components/sensor.imap_email_content.markdown @@ -23,12 +23,10 @@ sensor: - platform: imap_email_content server: imap.gmail.com port: 993 - name: Emails username: USERNAME password: PASSWORD senders: - example@gmail.com - value_template: TEMPLATE ``` Configuration variables: diff --git a/source/_components/sensor.mhz19.markdown b/source/_components/sensor.mhz19.markdown index 15e05e8f87d..659bf7357dc 100644 --- a/source/_components/sensor.mhz19.markdown +++ b/source/_components/sensor.mhz19.markdown @@ -21,7 +21,6 @@ To use this sensor in your installation, add the following to your `configuratio sensor: - platform: mhz19 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*` diff --git a/source/_components/sensor.moldindicator.markdown b/source/_components/sensor.moldindicator.markdown index e892e01e7c3..4fffa502843 100644 --- a/source/_components/sensor.moldindicator.markdown +++ b/source/_components/sensor.moldindicator.markdown @@ -19,12 +19,20 @@ The sensor data may be used e.g. to signal bad air quality (too high air humidit ```yaml # Example configuration.yaml entry sensor: - platform: mold_indicator - indoor_temp_sensor: sensor.temp - indoor_humidity_sensor: sensor.humidity - outdoor_temp_sensor: sensor.weather_temperature - calibration_factor: 2.0 # Needs to be calibrated to the critical point in the room + - platform: mold_indicator + indoor_temp_sensor: sensor.temp + indoor_humidity_sensor: sensor.humidity + outdoor_temp_sensor: sensor.weather_temperature + 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. ## {% linkable_title Calibration %} diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index 29510c858a5..8c8ffe7d804 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -21,12 +21,8 @@ To use your MQTT sensor in your installation, add the following to your `configu ```yaml # Example configuration.yml entry sensor: - platform: mqtt - state_topic: "home/bedroom/temperature" - name: "MQTT Sensor" - qos: 0 - unit_of_measurement: "°C" - value_template: '{% raw %}{{ value.x }}{% endraw %}' + - platform: mqtt + state_topic: "home/bedroom/temperature" ``` Configuration variables: diff --git a/source/_components/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index 5e40de148fc..0db855d0f47 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -10,6 +10,7 @@ footer: true logo: mysensors.png ha_category: Sensor featured: false +ha_iot_class: "Local Push" --- Integrates MySensors sensors into Home Assistant. See the [main component] for configuration instructions. diff --git a/source/_components/sensor.nest.markdown b/source/_components/sensor.nest.markdown index 55f6e35ed42..94420feaf6b 100644 --- a/source/_components/sensor.nest.markdown +++ b/source/_components/sensor.nest.markdown @@ -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: ```yaml +# Example configuration.yaml entry sensor: platform: nest monitored_conditions: diff --git a/source/_components/sensor.neurio_energy.markdown b/source/_components/sensor.neurio_energy.markdown index 6ef192d7459..5fea433c7e6 100644 --- a/source/_components/sensor.neurio_energy.markdown +++ b/source/_components/sensor.neurio_energy.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: neurio.png -ha_category: Sensor +ha_category: Energy ha_iot_class: "Cloud Polling" ha_release: 0.14 --- @@ -24,7 +24,6 @@ sensor: platform: neurio_energy api_key: API_KEY api_secret: API_SECRET - sensor_id: "SENSOR_ID" ``` Configuration variables: diff --git a/source/_components/sensor.octoprint.markdown b/source/_components/sensor.octoprint.markdown index 0cdc090fd68..db6bfda7966 100644 --- a/source/_components/sensor.octoprint.markdown +++ b/source/_components/sensor.octoprint.markdown @@ -23,12 +23,12 @@ To set it up, add the following information to your `configuration.yaml` file: ```yaml sensor: - platform: octoprint - name: OctoPrint - monitored_conditions: - - Current State - - Temperatures - - Job Percentage + - platform: octoprint + name: OctoPrint + monitored_conditions: + - Current State + - Temperatures + - Job Percentage ``` Configuration variables: diff --git a/source/_components/sensor.onewire.markdown b/source/_components/sensor.onewire.markdown index fc1ddb212c6..fe843bbad3a 100644 --- a/source/_components/sensor.onewire.markdown +++ b/source/_components/sensor.onewire.markdown @@ -28,10 +28,9 @@ To enable One wire sensors in your installation, add the following to your `conf ```yaml # Example configuration.yaml entry sensor: - platform: onewire - names: - some_id: your name - mount_dir: "/mnt/1wire" + - platform: onewire + names: + some_id: your name ``` Configuration variables: diff --git a/source/_components/sensor.rest.markdown b/source/_components/sensor.rest.markdown index 1d919c161a4..755ecedafae 100644 --- a/source/_components/sensor.rest.markdown +++ b/source/_components/sensor.rest.markdown @@ -21,10 +21,6 @@ To enable this sensor, add the following lines to your `configuration.yaml` file sensor: platform: rest 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: @@ -35,11 +31,7 @@ sensor: platform: rest resource: http://IP_ADDRESS/ENDPOINT method: POST - value_template: '{% raw %}{{ value_json.thermostat }}{% endraw %}' payload: '{ "device" : "heater" }' - name: REST POST sensor - unit_of_measurement: "°C" - verify_ssl: False ``` Configuration variables: diff --git a/source/_components/sensor.rfxtrx.markdown b/source/_components/sensor.rfxtrx.markdown index 62d36e88c32..dabffea8e95 100644 --- a/source/_components/sensor.rfxtrx.markdown +++ b/source/_components/sensor.rfxtrx.markdown @@ -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`: ```yaml +# Example configuration.yaml entry sensor: platform: rfxtrx 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: ```yaml +# Example configuration.yaml entry sensor: platform: rfxtrx devices: @@ -42,6 +44,7 @@ sensor: If you want to display several data types from one sensor: ```yaml +# Example configuration.yaml entry sensor: platform: rfxtrx devices: diff --git a/source/_components/sensor.sleepiq.markdown b/source/_components/sensor.sleepiq.markdown index f7efe29b44d..6740af6ab83 100644 --- a/source/_components/sensor.sleepiq.markdown +++ b/source/_components/sensor.sleepiq.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -logo: sleepiq +logo: sleepiq.png ha_category: Sensor ha_release: 0.29 ha_iot_class: "Local Polling" diff --git a/source/_components/sensor.tcp.markdown b/source/_components/sensor.tcp.markdown index 6e5bc6a0a46..f2a40d603c8 100644 --- a/source/_components/sensor.tcp.markdown +++ b/source/_components/sensor.tcp.markdown @@ -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`: ```yaml -sensor: # Example configuration.yaml entry - platform: tcp - name: Central Heating Pressure - host: IP_ADDRESS - port: PORT - timeout: 5 - payload: PAYLOAD - value_template: "{% raw %}{{ value.split(';')[0] }}{% endraw %}" - unit: UNIT_OF_MEASUREMENT +sensor: + - platform: tcp + host: IP_ADDRESS + port: PORT + payload: PAYLOAD ``` Configuration options for the a TCP Sensor: diff --git a/source/_components/sensor.tellduslive.markdown b/source/_components/sensor.tellduslive.markdown index 43fffd40249..b4b47c5d0ba 100644 --- a/source/_components/sensor.tellduslive.markdown +++ b/source/_components/sensor.tellduslive.markdown @@ -12,6 +12,5 @@ ha_category: Sensor 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/ diff --git a/source/_components/sensor.tellstick.markdown b/source/_components/sensor.tellstick.markdown index d4bbbdb841d..431217096fe 100644 --- a/source/_components/sensor.tellstick.markdown +++ b/source/_components/sensor.tellstick.markdown @@ -20,18 +20,28 @@ To use your TellStick device, you first have to set up your [Tellstick hub](http ```yaml # Example configuration.yaml entry sensor: - platform: tellstick - 135: Outside - 21: Inside - only_named: True - temperature_scale: "°C" - datatype_mask: 1 + - 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. +- **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 + 21: Inside + only_named: True + temperature_scale: "°C" + datatype_mask: 1 diff --git a/source/_components/sensor.temper.markdown b/source/_components/sensor.temper.markdown index 2c03ee62102..2f6eddfb7e9 100644 --- a/source/_components/sensor.temper.markdown +++ b/source/_components/sensor.temper.markdown @@ -17,12 +17,16 @@ To use your TEMPer sensor in your installation, add the following to your `confi ```yaml # Example configuration.yaml entry sensor: - platform: temper - name: 'My TEMPer' - scale: 1 - offset: 0 + - platform: temper ``` + +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. The calculation follows the formula `scale * sensor value + offset`. diff --git a/source/_components/sensor.template.markdown b/source/_components/sensor.template.markdown index 188feb040a5..06a28e344cd 100644 --- a/source/_components/sensor.template.markdown +++ b/source/_components/sensor.template.markdown @@ -35,7 +35,7 @@ Configuration variables: - **sensors** array (*Required*): List of your sensors. - **friendly_name** (*Optional*): Name to use in the Frontend. - **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. diff --git a/source/_components/sensor.thinkingcleaner.markdown b/source/_components/sensor.thinkingcleaner.markdown index 5d427ed6610..6c75256a721 100644 --- a/source/_components/sensor.thinkingcleaner.markdown +++ b/source/_components/sensor.thinkingcleaner.markdown @@ -20,7 +20,7 @@ To enable this sensor in your installation, add the following to your `configura ```yaml # Example configuration.yaml entry sensor: - platform: thinkingcleaner + - platform: thinkingcleaner ``` This will automatically add sensors for each Thinking Cleaner in your network. diff --git a/source/_components/sensor.verisure.markdown b/source/_components/sensor.verisure.markdown index 7087133f0be..4435630d5ba 100644 --- a/source/_components/sensor.verisure.markdown +++ b/source/_components/sensor.verisure.markdown @@ -12,13 +12,11 @@ ha_category: Sensor 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: * Thermometers * Hygrometers * Mouse detectors - - -[main component]: /components/verisure/ +