No version for distro humble. Known supported distros are highlighted in the buttons above.
No version for distro galactic. Known supported distros are highlighted in the buttons above.
No version for distro foxy. Known supported distros are highlighted in the buttons above.
Repository Summary
| Checkout URI | https://github.com/open-rmf/rmf_api_msgs.git |
| VCS Type | git |
| VCS Version | main |
| Last Updated | 2022-05-17 |
| Dev Status | DEVELOPED |
| CI status | No Continuous Integration |
| Released | RELEASED |
| Tags | No category tags. |
| Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
| Name | Version |
|---|---|
| rmf_api_msgs | 0.0.1 |
README
rmf_api_msgs
Collection of json message schemas which bridges the C++ and python components of RMF to the web interface
Usage
Download pkg for python model generation
pip3 install datamodel-code-generator
Compile with colcon is recommended
colcon build --packages-select rmf_api_msgs
source install/setup.bash
Subsequently, to access the schemas, the user just needs to include/import the cpp header or py module into their source code.
- C++ example:
#include <rmf_api_msgs/schemas/task_state.hpp>
nlohmann::json schema = rmf_api_msgs::schemas::task_state
- Python example:
from rmf_api_msgs import schemas
from rmf_api_msgs.models import task_state
# get schema
schema = schemas.task_state()
# create task_state model
booking = task_state.Booking(id = "id0001")
task_state = task_state.TaskState(booking = booking)
CONTRIBUTING
No CONTRIBUTING.md found.
No version for distro noetic. Known supported distros are highlighted in the buttons above.
No version for distro melodic. Known supported distros are highlighted in the buttons above.
No version for distro ardent. Known supported distros are highlighted in the buttons above.
No version for distro bouncy. Known supported distros are highlighted in the buttons above.
No version for distro crystal. Known supported distros are highlighted in the buttons above.
No version for distro eloquent. Known supported distros are highlighted in the buttons above.
No version for distro dashing. Known supported distros are highlighted in the buttons above.
No version for distro lunar. Known supported distros are highlighted in the buttons above.
No version for distro jade. Known supported distros are highlighted in the buttons above.
No version for distro indigo. Known supported distros are highlighted in the buttons above.
No version for distro hydro. Known supported distros are highlighted in the buttons above.
No version for distro kinetic. Known supported distros are highlighted in the buttons above.