rmf_api_msgs repository

Repository Summary

Checkout URI https://github.com/open-rmf/rmf_api_msgs.git
VCS Type git
VCS Version humble
Last Updated 2023-07-14
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.3

README

rmf_api_msgs

Collection of json message schemas which bridges the C++ and python components of RMF to the web interface

Usage

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.

  1. C++ example:
#include <rmf_api_msgs/schemas/task_state.hpp>

nlohmann::json schema = rmf_api_msgs::schemas::task_state

  1. Python example:
from rmf_api_msgs import schemas

# get schema
schema = schemas.task_state()

Python data model generation

To generate the data models based on the schemas, install datamodel-code-generator

pip3 install datamodel-code-generator

Recompile with colcon

colcon build --packages-select rmf_api_msgs
source install/setup.bash

The generated data models can then be accessed and used for development,

from rmf_api_msgs.models import task_state

# create task_state model
booking = task_state.Booking(id = "id0001")
task_state = task_state.TaskState(booking = booking)

CONTRIBUTING

No CONTRIBUTING.md found.

Repository Summary

Checkout URI https://github.com/open-rmf/rmf_api_msgs.git
VCS Type git
VCS Version iron
Last Updated 2023-07-14
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.1.1

README

rmf_api_msgs

Collection of json message schemas which bridges the C++ and python components of RMF to the web interface

Usage

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.

  1. C++ example:
#include <rmf_api_msgs/schemas/task_state.hpp>

nlohmann::json schema = rmf_api_msgs::schemas::task_state

  1. Python example:
from rmf_api_msgs import schemas

# get schema
schema = schemas.task_state()

Python data model generation

To generate the data models based on the schemas, install datamodel-code-generator

pip3 install datamodel-code-generator

Recompile with colcon

colcon build --packages-select rmf_api_msgs
source install/setup.bash

The generated data models can then be accessed and used for development,

from rmf_api_msgs.models import task_state

# create task_state model
booking = task_state.Booking(id = "id0001")
task_state = task_state.TaskState(booking = booking)

CONTRIBUTING

No CONTRIBUTING.md found.

Repository Summary

Checkout URI https://github.com/open-rmf/rmf_api_msgs.git
VCS Type git
VCS Version main
Last Updated 2024-01-16
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.2.1

README

rmf_api_msgs

Collection of json message schemas which bridges the C++ and python components of RMF to the web interface

Usage

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.

  1. C++ example:
#include <rmf_api_msgs/schemas/task_state.hpp>

nlohmann::json schema = rmf_api_msgs::schemas::task_state

  1. Python example:
from rmf_api_msgs import schemas

# get schema
schema = schemas.task_state()

Python data model generation

To generate the data models based on the schemas, install datamodel-code-generator

pip3 install datamodel-code-generator

Recompile with colcon

colcon build --packages-select rmf_api_msgs
source install/setup.bash

The generated data models can then be accessed and used for development,

from rmf_api_msgs.models import task_state

# create task_state model
booking = task_state.Booking(id = "id0001")
task_state = task_state.TaskState(booking = booking)

CONTRIBUTING

No CONTRIBUTING.md found.