Repo symbol

rmf_api_msgs repository

rmf_api_msgs

Repository Summary

Checkout URI https://github.com/open-rmf/rmf_api_msgs.git
VCS Type git
VCS Version humble
Last Updated 2024-04-16
Dev Status DEVELOPED
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)

Repo symbol

rmf_api_msgs repository

rmf_api_msgs

Repository Summary

Checkout URI https://github.com/open-rmf/rmf_api_msgs.git
VCS Type git
VCS Version jazzy
Last Updated 2024-06-14
Dev Status DEVELOPED
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.3.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)

Repo symbol

rmf_api_msgs repository

rmf_api_msgs

Repository Summary

Checkout URI https://github.com/open-rmf/rmf_api_msgs.git
VCS Type git
VCS Version kilted
Last Updated 2025-05-10
Dev Status DEVELOPED
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.5.0

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)

Repo symbol

rmf_api_msgs repository

rmf_api_msgs

Repository Summary

Checkout URI https://github.com/open-rmf/rmf_api_msgs.git
VCS Type git
VCS Version main
Last Updated 2025-06-16
Dev Status DEVELOPED
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.6.0

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)

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

rmf_api_msgs

Repository Summary

Checkout URI https://github.com/open-rmf/rmf_api_msgs.git
VCS Type git
VCS Version iron
Last Updated 2024-07-12
Dev Status DEVELOPED
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.2

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)

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository

Repo symbol

rmf_api_msgs repository