Update Geizhals sensor component configuration (#7192)

This commit is contained in:
Klaas Schoute 2018-10-28 17:41:00 +01:00 committed by Fabian Affolter
parent e8e770e11f
commit b815312c0a

View File

@ -21,17 +21,30 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry
sensor:
- platform: geizhals
name: qc35
product_id: 1696985
name: PRODUCT_NAME
product_id: PRODUCT_ID
```
Configuration variables:
- **name** (*Required*): The internal name of the product in Home Assistant.
- **product_id** (*Required*): ID of the product. Get the ID from the Geizhals website of your chosen product by opening the *Price History* in a new browser tab (right-click on the price history > open in new tab).
The URL of this site reveals the ID, e.g., `https://geizhals.de/?phist=1696985` with a `product_id` of `1696985`.
- **description** (*Optional*): The name of the product in the front end.
- **locale** (*Optional*): Localisation which should be used for the request. Set this to `AT`, `EU`, `DE`, `UK` or `PL`. Defaults to `DE`.
{% configuration %}
name:
description: The internal name of the product in Home Assistant.
required: true
type: string
product_id:
description: "ID of the product. Get the ID from the Geizhals website of your chosen product by opening the *Price History* in a new browser tab (right-click on the price history > open in new tab). The URL of this site reveals the ID, e.g., `https://geizhals.de/?phist=1696985` with a `product_id` of `1696985`."
required: true
type: integer
description:
description: The name of the product in the front end.
required: false
default: price
type: string
locale:
description: Localisation which should be used for the request. Set this to `AT`, `EU`, `DE`, `UK` or `PL`.
required: false
default: DE
type: string
{% endconfiguration %}
#### {% linkable_title Extended example %}