Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-virtual-sensor / b4cea1b1004a067be3503c59454aa21e8b369250
commitb4cea1b1004a067be3503c59454aa21e8b369250[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Wed Sep 04 09:05:33 2024 -0400
committerPatrick Williams <patrick@stwcx.xyz>Wed Sep 04 09:05:33 2024 -0400
tree640cc8cc1d377668934bebe9d9ef34d3c6f75d23
parentc1f822c01b5fbfc2cf68d08e12341d1b76966359 [diff]
prettier: use config from docs

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I4f202295ce74399f4c31438889c18493177c8ead
2 files changed
tree: 640cc8cc1d377668934bebe9d9ef34d3c6f75d23
  1. subprojects/
  2. test/
  3. .clang-format
  4. .editorconfig
  5. .gitignore
  6. .prettierrc.yaml
  7. calculate.cpp
  8. calculate.hpp
  9. dbusSensor.cpp
  10. dbusSensor.hpp
  11. dbusUtils.cpp
  12. dbusUtils.hpp
  13. exprtkTools.hpp
  14. LICENSE
  15. meson.build
  16. meson.options
  17. OWNERS
  18. phosphor-virtual-sensor.service.in
  19. README.md
  20. thresholds.hpp
  21. virtual_sensor_config.json
  22. virtualSensor.cpp
  23. virtualSensor.hpp
README.md

phosphor-virtual-sensor

phosphor-virtual-sensor reads the configuration file virtual_sensor_config.json from one of three locations:

  1. The current directory.
  2. /var/lib/phosphor-virtual-sensor
  3. /usr/share/phosphor-virtual-sensor

By default the repository will install a sample config into (3).

There are two types of data in this file.

virtual sensor configuration information

See virtual_sensor_config.json in this repository for an example. Sensors added this way can use any expression that is accepted by exprtk.

information to get a virtual sensor configuration from D-Bus

For example:

{
  "Desc": {
    "Config": "D-Bus",
    "Type": "ModifiedMedian"
  }
}

Sensors added this way can only use a set of restricted calculations. Currently the only type supported is modifiedMedian.

The virtual sensor configuration information needs to be added into the relevant hardware configuration file in entity-manager. This method of adding a virtual sensor allows a recipe that builds for different hardware configurations to have different virtual sensors for each configuration.

The virtual sensor configuration in entity manager follows a different format to the JSON in virtual_sensor_config.json (specified in entity-manager/schemas/VirtualSensor.json).