Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-virtual-sensor / aedd2e2bb93b8b714d6c9fc3707ad5f9e8464447
commitaedd2e2bb93b8b714d6c9fc3707ad5f9e8464447[log] [tgz]
authorJiaqing Zhao <jiaqing.zhao@intel.com>Sat May 21 22:14:20 2022 +0800
committerJiaqing Zhao <jiaqing.zhao@intel.com>Sat May 21 22:25:54 2022 +0800
tree8cbadee53166b9c6f6ac4a17e2ab32ef1839ec59
parent27faf7ca7d7b6ed3d47b450763b09bc240ccf91e [diff]
README: Update Type for D-Bus config

According to entity-manager schema, the first M of ModifiedMedian
should be capitalized. Also adds a hyperlink to the schema.

Tested:
Configure phosphor-virtual-sensor with "Type": "ModifiedMedian", the
sensor defined in entity-manager json is exposed successfully.

Change-Id: I90fa91d3c45e24914610245eec43dd2924957855
Signed-off-by: Jiaqing Zhao <jiaqing.zhao@intel.com>
1 file changed
tree: 8cbadee53166b9c6f6ac4a17e2ab32ef1839ec59
  1. subprojects/
  2. .clang-format
  3. .editorconfig
  4. .gitignore
  5. .markdownlint.yaml
  6. .prettierrc.yaml
  7. dbusSensor.hpp
  8. dbusUtils.hpp
  9. exprtkTools.hpp
  10. LICENSE
  11. MAINTAINERS
  12. meson.build
  13. OWNERS
  14. phosphor-virtual-sensor.service.in
  15. README.md
  16. thresholds.hpp
  17. virtual_sensor_config.json
  18. virtualSensor.cpp
  19. virtualSensor.hpp
README.md

phosphor-virtual-sensor

phosphor-virtual-sensor reads in virtual_sensor_config.json 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 configuraton from D-Bus

For example:

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

Sensors added this way can only use a set of restricted calculations. At this stage 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).