Added readme with instructions on how to use sdbus++

Added instructions for using sdbus++.

Change-Id: Ibdd89f6971e05f16797ee04a2eeb1c4fc6a8676b
Signed-off-by: Abhishek Pandit <abhishekpandit@google.com>
1 file changed
tree: 4d72aa6aff202be4b9c5c33de9d0ecc79840c7bf
  1. mapbox/
  2. sdbusplus/
  3. test/
  4. tools/
  5. .gitignore
  6. bootstrap.sh
  7. configure.ac
  8. LICENSE
  9. Makefile.am
  10. README.md
README.md

sdbusplus

sdbusplus is a library and a tool for generating C++ bindings to dbus.

How to use tools/sdbus++

The path of your file will be the interface name. For example, for an interface xyz.openbmc_project.control.Chassis, you would create the following file: xyz/openbmc_project/control/Chassis.interface.yaml. Similary, for errors, you would create xyz/openbmc_project/control/Chassis.errors.yaml.

Generating all the files:

root_dir=$(readlink -f ../phosphor-dbus-interfaces)
desired_interface=xyz.openbmc_project.control.Chassis
file_prefix=chassis_interface
file_exp_prefix=chassis_interface_exceptions
outdir=../phosphor-chassis-control/generated

# Server bindings
python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir interface server-header $desired_interface > $outdir/$file_prefix.hpp
python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir interface server-cpp $desired_interface > $outdir/$file_prefix.cpp

# Exception bindings
python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir error exception-header $desired_interface > $outdir/$file_exp_prefix.hpp
python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir error exception-cpp $desired_interface > $outdir/$file_exp_prefix.cpp

# Docs
python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir interface markdown $desired_interface > $outdir/$file_prefix.md
python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir error markdown $desired_interface > $outdir/$file_exp_prefix.md