mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Update PM Sensor documentation to standards (#6508)
Update configuration variable section and move "complete" configuration example (including the optional value) as a second example. Have the main configuration example only include required variables. Bring more attention to the list of supported sensors. (List of supported sensors is still current with the pmsensor library used by this component.) Related to #6385.
This commit is contained in:
parent
56f912aab9
commit
b5cff3d63e
@ -17,6 +17,8 @@ Particulate matter sensors measure the amount of very small particles in the air
|
||||
|
||||
Cheap LED based sensors usually use a GPIO interface that is hard to attach to computers. However, there are a lot of laser LED based sensors on the market that use a serial interface and can be [connected to your Home Assistant system easily with an USB to serial converter](https://www.open-homeautomation.com/2016/07/20/connecting-an-particulate-matter-sensor-to-your-pc-or-mac/).
|
||||
|
||||
## {% linkable_title Supported Sensors %}
|
||||
|
||||
At this time, the following sensors are supported:
|
||||
|
||||
* oneair,s3
|
||||
@ -28,8 +30,34 @@ At this time, the following sensors are supported:
|
||||
* plantower,pms2003
|
||||
* plantower,pms3003
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your PM sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: serial_pm
|
||||
serial_device: /dev/tty.SLAB_USBtoUART
|
||||
brand: oneair,s3
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
serial_device:
|
||||
description: The serial port to use. On *nix systems, it can often be identified by `$ ls /dev/tty*`
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name displayed in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
brand:
|
||||
description: Manufacturer and type of the sensor. (Use a value from the supported sensors list.).
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Named Sensor Configuration Example %}
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: serial_pm
|
||||
@ -38,7 +66,3 @@ sensor:
|
||||
brand: novafitness,sds011
|
||||
```
|
||||
|
||||
- **serial_device** (*Required*): The serial port to use. On *nix systems, it can often be identified by `$ ls /dev/tty*`
|
||||
- **name** (*Optional*): The name displayed in the frontend.
|
||||
- **brand** (*Required*): Manufacturer and type of the sensor.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user