jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 23:36:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move platform yaml to integration yaml for Scrape integration (#24727)

Browse Source
This commit is contained in:
G Johansson 2022-10-31 10:44:41 +01:00 committed by GitHub
parent 027ca343a3
commit ff08590c49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 142 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

229
source/_integrations/scrape.markdown
View File

@ -25,78 +25,133 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: scrape:
- platform: scrape - resource: https://www.home-assistant.io
resource: https://www.home-assistant.io sensor:
select: ".current-version h1" - name: "Current version"
select: ".current-version h1"
``` ```
{% configuration %} {% configuration %}
resource: resource:
description: The URL to the website that contains the value. description: The resource or endpoint that contains the value.
required: true required: true
type: string type: string
select: resource_template:
description: "Defines the HTML tag to search for. Check Beautifulsoup's [CSS selectors](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#css-selectors) for details." description: The resource or endpoint that contains the value with template support.
required: true required: true
type: string
attribute:
description: Get value of an attribute on the selected tag.
required: false
type: string
index:
description: Defines which of the elements returned by the CSS selector to use.
required: false
default: 0
type: integer
name:
description: Name of the sensor.
required: false
default: Web scrape
type: string
value_template:
description: Defines a template to get the state of the sensor.
required: false
type: template type: template
unit_of_measurement: method:
description: Defines the units of measurement of the sensor, if any. description: The method of the request. Either `POST` or `GET`.
required: false required: false
type: string type: string
device_class: default: GET
description: The [type/class](/integrations/sensor/#device-class) of the sensor to set the icon in the frontend. payload:
required: false description: The payload to send with a POST request. Depends on the service, but usually formed as JSON.
type: device_class
default: None
state_class:
description: The [state_class](https://developers.home-assistant.io/docs/core/entity/sensor#available-state-classes) of the sensor.
required: false
type: string
default: None
authentication:
description: Type of the HTTP authentication. Either `basic` or `digest`.
required: false required: false
type: string type: string
verify_ssl: verify_ssl:
description: Enables/disables verification of SSL-certificate, for example if it is self-signed. description: Verify the SSL certificate of the endpoint.
required: false required: false
type: boolean type: boolean
default: true default: True
timeout:
description: Defines max time to wait data from the endpoint.
required: false
type: integer
default: 10
authentication:
description: Type of the HTTP authentication. `basic` or `digest`.
required: false
type: string
username: username:
description: The username for accessing the website. description: The username for accessing the REST endpoint.
required: false required: false
type: string type: string
password: password:
description: The password for accessing the website. description: The password for accessing the REST endpoint.
required: false required: false
type: string type: string
headers: headers:
description: Headers to use for the web request. description: The headers for the requests.
required: false required: false
type: string type: [list, template]
unique_id: params:
description: An ID that uniquely identifies this scrape entity. description: The query params for the requests.
required: false required: false
type: string type: [list, template]
scan_interval:
description: Define the refrequency to call the REST endpoint in seconds.
required: false
type: integer
default: 30
sensor:
description: A list of sensors to create from the shared data. All configuration settings that are supported by [RESTful Sensor](/integrations/sensor.rest#configuration-variables) not listed above can be used here.
required: true
type: map
keys:
name:
description: Defines a template to get the name of the entity.
required: false
type: template
select:
description: "Defines the HTML tag to search for. Check Beautifulsoup's [CSS selectors](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#css-selectors) for details."
required: true
type: string
attribute:
description: Get value of an attribute on the selected tag.
required: false
type: string
index:
description: Defines which of the elements returned by the CSS selector to use.
required: false
default: 0
type: integer
value_template:
description: Defines a template to get the state of the sensor.
required: false
type: template
unique_id:
description: An ID that uniquely identifies this entity. Will be combined with the unique ID of the configuration block if available. This allows changing the `name`, `icon` and `entity_id` from the web interface.
required: false
type: string
icon:
description: Defines a template for the icon of the entity.
required: false
type: template
availability:
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
required: false
type: template
default: true
unit_of_measurement:
description: "Defines the units of measurement of the sensor, if any. This will also display the value based on the user profile Number Format setting and influence the graphical presentation in the history visualization as a continuous value."
required: false
type: string
default: None
state_class:
description: "The [state_class](https://developers.home-assistant.io/docs/core/entity/sensor#available-state-classes) of the sensor. This will also display the value based on the user profile Number Format setting and influence the graphical presentation in the history visualization as a continuous value."
required: false
type: string
default: None
picture:
description: Defines a template for the entity picture of the sensor.
required: false
type: template
attributes:
description: Defines templates for attributes of the sensor.
required: false
type: map
keys:
"attribute: template":
description: The attribute and corresponding template.
required: true
type: template
device_class:
description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). It does not set the `unit_of_measurement`.
required: false
type: device_class
default: None
{% endconfiguration %} {% endconfiguration %}
## Examples ## Examples
@ -110,13 +165,13 @@ The current release Home Assistant is published on [https://www.home-assistant.i
{% raw %} {% raw %}
```yaml ```yaml
sensor: scrape:
# Example configuration.yaml entry # Example configuration.yaml entry
- platform: scrape - resource: https://www.home-assistant.io
resource: https://www.home-assistant.io sensor:
name: Release - name: Release
select: ".current-version h1" select: ".current-version h1"
value_template: '{{ value.split(":")[1] }}' value_template: '{{ value.split(":")[1] }}'
``` ```
{% endraw %} {% endraw %}
@ -129,12 +184,12 @@ Get the counter for all our implementations from the [Component overview](/integ
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: scrape:
- platform: scrape - resource: https://www.home-assistant.io/integrations/
resource: https://www.home-assistant.io/integrations/ sensor:
name: Home Assistant impl. - name: Home Assistant impl.
select: 'a[href="#all"]' select: 'a[href="#all"]'
value_template: '{{ value.split("(")[1].split(")")[0] }}' value_template: '{{ value.split("(")[1].split(")")[0] }}'
``` ```
{% endraw %} {% endraw %}
@ -145,13 +200,13 @@ The German [Federal Office for Radiation protection (Bundesamt für Strahlenschu
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: scrape:
- platform: scrape - resource: https://www.bfs.de/DE/themen/opt/uv/uv-index/prognose/prognose_node.html
resource: https://www.bfs.de/DE/themen/opt/uv/uv-index/prognose/prognose_node.html sensor:
name: Coast Ostsee - name: Coast Ostsee
select: "p" select: "p"
index: 19 index: 19
unit_of_measurement: "UV Index" unit_of_measurement: "UV Index"
``` ```
### IFTTT status ### IFTTT status
@ -160,11 +215,11 @@ If you make heavy use of the [IFTTT](/integrations/ifttt/) web service for your
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: scrape:
- platform: scrape - resource: https://status.ifttt.com/
resource: https://status.ifttt.com/ sensor:
name: IFTTT status - name: IFTTT status
select: ".component-status" select: ".component-status"
``` ```
### Get the latest podcast episode file URL ### Get the latest podcast episode file URL
@ -173,13 +228,13 @@ If you want to get the file URL for the latest episode of your [favorite podcast
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: scrape:
- platform: scrape - resource: https://hasspodcast.io/feed/podcast
resource: https://hasspodcast.io/feed/podcast sensor:
name: Home Assistant Podcast - name: Home Assistant Podcast
select: "enclosure" select: "enclosure"
index: 1 index: 1
attribute: url attribute: url
``` ```
### Energy price ### Energy price
@ -190,14 +245,14 @@ This example tries to retrieve the price for electricity.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: scrape:
- platform: scrape - resource: https://elen.nu/timpriser-pa-el-for-elomrade-se3-stockholm/
resource: https://elen.nu/timpriser-pa-el-for-elomrade-se3-stockholm/ sensor:
name: Electricity price - name: Electricity price
select: ".text-lg:is(span)" select: ".text-lg:is(span)"
index: 1 index: 1
value_template: '{{ value | replace (",", ".") | float }}' value_template: '{{ value | replace (",", ".") | float }}'
unit_of_measurement: "öre/kWh" unit_of_measurement: "öre/kWh"
``` ```
{% endraw %} {% endraw %}