Communication protocols, APIs, middleware bridges, transport layers, and interoperability definitions for the OpenAMRobot ecosystem.
Status: Planned, no code yet
The directory layout below is scaffolding. No protocol, schema, or bridge is defined yet, and nothing here is stable enough to depend on.
This repository defines communication patterns and integration contracts between OpenAMRobot subsystems, including:
- UI to robot communication
- ROS 2 bridge definitions
- REST API conventions
- WebSocket event streams
- MQTT topics
- serial communication conventions
- cloud or fleet-management bridges
- telemetry schemas
- command schemas
- interoperability documentation
openamrobot-comm/
├── protocols/
│ ├── rest/
│ ├── websocket/
│ ├── mqtt/
│ ├── serial/
│ └── ros2_bridge/
│
├── middleware/
│ ├── ros2/
│ ├── ui_bridge/
│ ├── cloud_bridge/
│ └── fleet_management/
│
├── schemas/
│ ├── json/
│ └── yaml/
│
├── docs/
├── examples/
├── tests/
└── tools/
This repository defines communication contracts and middleware patterns.
ROS 2 package implementations belong in:
openamr-platform-sw
Embedded firmware implementations belong in:
openamr-platform-fw
Shared ROS 2 messages, services, and actions belong in:
openamrobot-interfaces
User interface implementation belongs in:
openamrobot-ui
Communication interfaces should be:
- clearly documented
- versioned
- secure by design
- transport-aware
- reusable
- testable
- compatible with simulation and real hardware
- suitable for future fleet and cloud integration
Planned future work may include:
- REST API specification
- WebSocket telemetry schema
- MQTT topic conventions
- serial protocol definitions
- UI-to-ROS bridge documentation
- fleet management communication contracts
- security and authentication guidelines
MIT License.
OpenAMRobot is a project initiated, operated, and controlled by Botshare LTD (Cyprus Company ID HE479056). Botshare LTD owns the transferable economic rights in original OpenAMRobot material created by or validly assigned to it. Third-party material remains subject to its respective ownership, licences, and notices.
Original OpenAMRobot software and firmware are licensed under MIT, documentation under CC BY 4.0, and hardware design source under CERN-OHL-P-2.0, as mapped in LICENSING.md. Public distribution grants the permissions stated in the applicable licence; it does not transfer ownership of underlying copyright, trademarks, patents, or other intellectual property.
Accepted external contributions require DCO sign-off and an applicable Individual or Corporate Contributor Agreement. See the organization IP Policy, Contribution Guide, and Contributor Agreement Process.