Skip to content

openAMRobot/openamrobot-release

Repository files navigation

OpenAMRobot v0.0.1

The first public release of the OpenAMRobot platform.

This release is a frozen snapshot of the OpenAMRobot ecosystem, containing all repositories required to study, build, modify, reproduce, and extend the platform.


Included Repositories

  • openamr-platform-hw — Hardware
  • openamr-platform-sw — Software
  • openamr-platform-fw — Firmware
  • openamrobot-ui — User Interface
  • openamrobot-interfaces — Shared Interfaces
  • openamrobot-comm — Communication
  • openamrobot-docs — Documentation
  • .github — Governance & Community

Why a Custom Release Archive?

OpenAMRobot is developed across multiple repositories covering hardware, software, firmware, the user interface, shared interfaces, communication, and documentation.

GitHub's automatically generated source archives contain only this release-builder repository. They do not contain the complete OpenAMRobot platform.

The official product-level release is therefore:

OpenAMRobot-v0.0.1-source.zip

This archive combines the participating repositories into one frozen, versioned package for offline preservation, development, manufacturing, research, and education.


Start Here

1. Read the Release Documentation

Before using the platform, read:

  • RELEASE_NOTES.md
  • KNOWN_LIMITATIONS.md

These documents describe the scope of this release, supported functionality, known issues, and current limitations.


2. Hardware

Open:

openamr-platform-hw/README.md

This repository contains:

  • Bill of Materials (BOM)
  • CAD models
  • Manufacturing documentation
  • Electrical documentation
  • Wiring diagrams
  • Assembly instructions
  • Safety documentation

3. Firmware

Open:

openamr-platform-fw/README.md

This repository explains:

  • Firmware architecture
  • Flashing procedure
  • micro-ROS integration
  • Motor control
  • Calibration
  • Diagnostics

4. Software

Open:

openamr-platform-sw/README.md

Follow the software documentation to:

  • Install ROS 2 Jazzy
  • Build the workspace
  • Launch Gazebo simulation
  • Bring up the physical robot
  • Configure Navigation
  • Configure SLAM
  • Test Auto Docking

5. User Interface

Open:

openamrobot-ui/README.md

This repository contains:

  • Installation instructions
  • UI architecture
  • Blockly programming
  • Navigation interface
  • Diagnostics
  • Camera streaming
  • Voice / LLM interface

6. Documentation

Additional documentation is available in:

openamrobot-docs/

7. Verify the Release

Before using the release, verify:

  • VERSION
  • MANIFEST.json
  • checksums.sha256

Live Repositories


Demo Videos


Support OpenAMRobot

If you find this project useful, please consider supporting its development.

Your support helps us improve the hardware, firmware, software, documentation, educational materials, and future releases.

About

Official product releases of the OpenAMRobot platform. Each release is a frozen, versioned snapshot combining hardware, software, firmware, documentation, and UI into a reproducible package for research, education, and development.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

19 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages