You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/sensor.envirophat.markdown
+59-31Lines changed: 59 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -47,37 +47,65 @@ sensor:
47
47
- voltage_3
48
48
```
49
49
50
-
Configuration variables:
51
-
52
-
- **display_options** (*Optional*) array: List of readings to monitor. Default is monitoring all of them:
53
-
- **temperature**: ambient temperature in Celsius. Since the sensor is close to the Raspberry Pi, that might affect the accuracy of the reading (ie. the Pi might heat up the sensor)
54
-
- **pressure**: atmospheric pressure in hPa.
55
-
- **light**: ambient light, as an integer in the 0-65535 range
56
-
- **light_red**: red color reading scaled to the ambient light, as an integer in the 0-255 range
57
-
- **light_green**: green color reading scaled to the ambient light, as an integer in the 0-255 range
58
-
- **light_blue**: blue color reading scaled to the ambient light, as an integer in the 0-255 range
59
-
- **accelerometer_x**: accelerometer reading in units of G, along the X axis
60
-
- **accelerometer_y**: accelerometer reading in units of G, along the Y axis
61
-
- **accelerometer_z**: accelerometer reading in units of G, along the Z axis
62
-
- **magnetometer_x**: magnetometer reading, the X component of the raw vector
63
-
- **magnetometer_y**: magnetometer reading, the Y component of the raw vector
64
-
- **magnetometer_z**: magnetometer reading, the X component of the raw vector
65
-
- **voltage_0**: voltage reading on Analog In 0 in units of V
66
-
- **voltage_1**: voltage reading on Analog In 1 in units of V
67
-
- **voltage_2**: voltage reading on Analog In 2 in units of V
68
-
- **voltage_3**: voltage reading on Analog In 3 in units of V
69
-
- **use_led** (*Optional*) True / False boolean; Default value is False, declaring that the on-board LEDs are *not* used for the color measurements thus these readings are based on the ambient light. If the value is set to True, the on-board LEDs will blink whenever a reading is taken.
70
-
71
-
### Notes
72
-
73
-
* **X, Y, Z axes**
74
-
* X is parallel with the long edge of the board
75
-
* Y is parallel with the short edge of the board
76
-
* Z is perpendicular to the board
77
-
* **Voltages**
78
-
* voltage readings are done in the 0-3.3V range, please do not connect higher voltages than that! See the [Enviro pHAT's getting started guide](https://learn.pimoroni.com/tutorial/sandyj/getting-started-with-enviro-phat) regarding how to make a voltage divider
79
-
80
-
### Give the values friendly names & icons
50
+
{% configuration %}
51
+
display_options:
52
+
description: List of readings to monitor.
53
+
required: false
54
+
default: All the conditions
55
+
type: list
56
+
keys:
57
+
temperature:
58
+
description: Ambient temperature in Celsius. Since the sensor is close to the Raspberry Pi, that might affect the accuracy of the reading (ie. the Pi might heat up the sensor)
59
+
pressure:
60
+
description: Atmospheric pressure in hPa.
61
+
light:
62
+
description: Ambient light, as an integer in the 0-65535 range.
63
+
light_red:
64
+
description: Red color reading scaled to the ambient light, as an integer in the 0-255 range.
65
+
light_green:
66
+
description: Green color reading scaled to the ambient light, as an integer in the 0-255 range.
67
+
light_blue:
68
+
description: Blue color reading scaled to the ambient light, as an integer in the 0-255 range.
69
+
accelerometer_x:
70
+
description: Accelerometer reading in units of G, along the X axis.
71
+
accelerometer_y:
72
+
description: Accelerometer reading in units of G, along the Y axis.
73
+
accelerometer_z:
74
+
description: Accelerometer reading in units of G, along the Z axis.
75
+
magnetometer_x:
76
+
description: Magnetometer reading, the X component of the raw vector.
77
+
magnetometer_y:
78
+
description: Magnetometer reading, the y component of the raw vector.
79
+
magnetometer_z:
80
+
description: Magnetometer reading, the z component of the raw vector.
81
+
voltage_0:
82
+
description: Voltage reading on Analog In 0 in units of V.
83
+
voltage_1:
84
+
description: Voltage reading on Analog In 1 in units of V.
85
+
voltage_2:
86
+
description: Voltage reading on Analog In 2 in units of V.
87
+
voltage_3:
88
+
description: Voltage reading on Analog In 3 in units of V.
89
+
use_led:
90
+
description: Declaring that the on-board LEDs are *not* used for the color measurements thus these readings are based on the ambient light. If the value is set to True, the on-board LEDs will blink whenever a reading is taken.
91
+
required: false
92
+
default: false
93
+
type: boolean
94
+
{% endconfiguration %}
95
+
96
+
### {% linkable_title Notes %}
97
+
98
+
#### X, Y, Z axes
99
+
100
+
- X is parallel with the long edge of the board
101
+
- Y is parallel with the short edge of the board
102
+
- Z is perpendicular to the board
103
+
104
+
#### Voltages
105
+
106
+
- voltage readings are done in the 0-3.3V range, please do not connect higher voltages than that! See the [Enviro pHAT's getting started guide](https://learn.pimoroni.com/tutorial/sandyj/getting-started-with-enviro-phat) regarding how to make a voltage divider
107
+
108
+
### {% linkable_title Give the values friendly names & icons %}
81
109
82
110
Add something like the following to your [customize section](/docs/configuration/customizing-devices/):
0 commit comments