Add note about containers (#6511)

This commit is contained in:
Fabian Affolter 2018-10-04 18:28:33 +02:00 committed by GitHub
parent 28b6ff4f59
commit 746b3cb303
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -16,6 +16,13 @@ ha_iot_class: "Local Push"
The `cpuspeed` sensor platform to allow you to monitor the current CPU speed.
<p class='note warning'>
You can't use this sensor in a Container (like Hass.io) as it requires access to the physical CPU. Also, not all [ARM CPUs](https://github.com/workhorsy/py-cpuinfo/#cpu-support) are supported.
</p>
## {% linkable_title Configuration %}
To add this platform to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -24,6 +31,10 @@ sensor:
- platform: cpuspeed
```
Configuration variables:
- **name** (*Optional*): Name of the sensor.
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: CPU speed
{% endconfiguration %}