Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-virtual-sensor / 2030a56a6e5be0e957d17eb329c8231952f3ea2e
commit2030a56a6e5be0e957d17eb329c8231952f3ea2e[log] [tgz]
authorGeorge Liu <liuxiwei@ieisystem.com>Fri Oct 25 15:44:41 2024 +0800
committerGeorge Liu <liuxiwei@ieisystem.com>Fri Oct 25 15:44:41 2024 +0800
tree416b4500d826f355ba221262e382b8ccf668fd3c
parentbfb172149b9d55cdc417a75a323491f83dcb8c72 [diff]
README.md: Update Type supported types

Currently supported types are `Average`, `Maximum`, `Minimum`, `Sum`
and `ModifiedMedian`.

Change-Id: I0c262fdb1564987a1a4f559cc8a7389022a48c3c
Signed-off-by: George Liu <liuxiwei@ieisystem.com>
1 file changed
tree: 416b4500d826f355ba221262e382b8ccf668fd3c
  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 supported types are Average, Maximum, Minimum, Sum and 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).