Skip to content

update geizhals doc #6026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 2 commits into from
Sep 10, 2018
Merged

update geizhals doc #6026

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd36ec4
update geizhals doc
JulianKahnert Aug 16, 2018
57ac742
:pencil2: Tweak
frenck Aug 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions source/_components/sensor.geizhals.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: "0.51"
---


The `geizhals` sensor will give you the best price of a product from [Geizhals](https://geizhals.de) or related site. With this information can be used in e.g., automations to notify you when a price drops.

To enable this sensor, add the following lines to your `configuration.yaml` file:
Expand All @@ -23,16 +22,16 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
sensor:
- platform: geizhals
name: qc35
product_id: 1453021
product_id: 1696985
```

Configuration variables:
Copy link
Copy Markdown
Contributor

@DubhAd DubhAd Sep 1, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you're updating the config block anyway, now would be an ideal time to update this to use the new format as detailed in the documentation standards ;)

Copy link
Copy Markdown
Contributor Author

@JulianKahnert JulianKahnert Sep 6, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by that?

Copy link
Copy Markdown
Contributor

@DubhAd DubhAd Sep 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://developers.home-assistant.io/docs/en/documentation_standards.html#component-and-platform-pages


- **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 clicking on the *Price History* tab, e.g., [here](https://geizhals.de/?phist=1453021). The URL of this site reveals the ID, e.g., <https://geizhals.de/?phist=1453021> with `product_id: 1453021`.
- **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.
- **domain** (*Optional*): Domain which should be used for the request. Set this to `geizhals.at`, `geizhals.eu`, `geizhals.de`, `skinflint.co.uk` or `cenowarka.pl`. Defaults to `geizhals.de`.
- **regex** (*Optional*): Regular expression to parse the price. Default: `\D\s(\d*)[\,|\.](\d*)`.
- **locale** (*Optional*): Localisation which should be used for the request. Set this to `AT`, `EU`, `DE`, `UK` or `PL`. Defaults to `DE`.

#### {% linkable_title Extended example %}

Expand All @@ -41,8 +40,7 @@ Configuration variables:
sensor:
- platform: geizhals
name: qc35
product_id: 1453021
product_id: 1696985
description: "Bose QC35"
domain: 'geizhals.de'
regex: '\D\s(\d*)[\,|\.](\d*)'
locale: "DE"
```