Documentation

OctoMY Documentation

Welcome to OctoMY™ documentation

OctoMY™ is an open-source robotics platform that enables secure, distributed communication between robots (Agents), controllers (Remotes), and coordination servers (Hubs).

Getting Started

New to OctoMY™? Start with the Tutorials section. It will guide you through installation, your first Agent, your first Remote, and making your first connection.

Documentation sections

Section Description
Tutorials Learn OctoMY™ step by step. Start here if you're new.
How-to guides Practical guides for common tasks like pairing and hardware setup.
Reference Complete specifications for APIs, protocols, and configuration.
Explanation Background concepts and architecture decisions.
Resource Description
Glossary Terminology and definitions
API reference Auto-generated class documentation

For developers

Resource Description
Build from source Compile OctoMY™ yourself
Contributing How to contribute to OctoMY™