xref: /openbmc/phosphor-virtual-sensor/README.md (revision 06f8874f26adff78f960c8937ce11b723ad31e87)
1# phosphor-virtual-sensor
2
3phosphor-virtual-sensor reads the configuration file
4`virtual_sensor_config.json` from one of three locations:
5
61. The current directory.
72. `/var/lib/phosphor-virtual-sensor`
83. `/usr/share/phosphor-virtual-sensor`
9
10By default the repository will install a sample config into (3).
11
12There are two types of data in this file.
13
14## virtual sensor configuration information
15
16See `virtual_sensor_config.json` in this repository for an example. Sensors
17added this way can use any expression that is accepted by exprtk.
18
19## information to get a virtual sensor configuration from D-Bus
20
21For example:
22
23```json
24{
25  "Desc": {
26    "Config": "D-Bus"
27  }
28}
29```
30
31Sensors added this way can only use a set of restricted calculations. Currently
32supported types are `Average`, `Maximum`, `Minimum`, `Sum` and `ModifiedMedian`.
33
34The virtual sensor configuration information needs to be added into the relevant
35hardware configuration file in entity-manager. This method of adding a virtual
36sensor allows a recipe that builds for different hardware configurations to have
37different virtual sensors for each configuration.
38
39The virtual sensor configuration in entity manager follows a different format to
40the JSON in `virtual_sensor_config.json` (specified in
41[entity-manager/schemas/VirtualSensor.json](https://github.com/openbmc/entity-manager/blob/master/schemas/virtual_sensor.json)).
42