12b6447a5f
* Create sensor.simulated.markdown * Fix seed ref * Update sensor.simulated.markdown * Update sensor.simulated.markdown * Update sensor.simulated.markdown
2.8 KiB
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_iot_class | ha_release |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | Simulated sensor | Component for simulating a numerical sensor. | 2018-02-20 08:00 | true | false | true | true | home-assistant.png | Sensor | Local Polling | 0.65 |
This component provides a simulated sensor that generates a time-varying signal V(t) given by the function:
V(t) = M + A sin((2 pi (t - t_0) / w) + P) + N(s)
where:
- M = the mean value of the sensor
- A = the amplitude of the periodic contribution
- t = the time when a value is generated
- t_0 = the time when the sensor is started
- w = the time period in seconds for a single complete cycle of the periodic contribution
- P = the phase offset to add to the periodic contribution, in units of degrees
- N(s) = the random Gaussian noise with spread s
A simulated sensor with default values can be added to home-assistant using the following config:
sensor:
- platform: simulated
To give an example of simulating real world data, a simulated relative humidity sensor (in %) can be added using the following config:
sensor:
- platform: simulated
name: 'simulated relative humidity'
unit: '%'
amplitude: 0 # Turns off the periodic contribution
mean: 50
spread: 10
seed: 999
Configuration variables: {% configuration %} name: description: The name of the sensor required: false default: Defaults to 'simulated' type: string unit: description: The unit to apply required: false default: Defaults to 'value' type: string amplitude: description: The amplitude of periodic contribution required: false default: 1 type: float mean: description: The mean level of the sensor required: false default: 0 type: float period: description: The time in seconds for one complete oscillation of the periodic contribution required: false default: 0 type: seconds phase: description: The phase offset (in degrees) to apply to the periodic component required: false default: 0 type: float seed: description: The seed value for the random noise component required: false default: 999 type: int spread: description: The spread is the range of the randomly distributed values about their mean. This is sometimes referred to as the Full Width at Half Maximum (FWHM) of the random distribution required: false default: None type: float {% endconfiguration %}