Reference

Technical reference documentation

Reference

Complete technical reference documentation for OctoMY™. This section provides accurate, detailed specifications.

Pro Tip

Reference documentation is designed for looking things up, not reading cover-to-cover. Use the glossary to find definitions, the API reference for class details, and the specific sections (nodes, plans, comms) for topical deep dives.

Quick reference

Resource Description
Glossary Terminology and definitions
API reference Auto-generated class and function documentation

Reference sections

Section Description
Nodes Agent, Remote, Hub, and Zoo specifications
Plans Plan file format and commands
OPAL OPAL command interface for LLM integration
Communications Protocols, couriers, and sessions
Media Audio and video processing, device management, streaming
Hardware Actuators, sensors, lobes, and ArduMY
Configuration Settings, key storage, and CLI options
Editions The edition.json schema for branded builds
Qbs Build System Qbs architecture, modules, probes, and configuration
Build tools The C++ programs the build uses, and how to run one by hand
Kiln The kiln command, kiln test and its profiles, and the .kiln keys
Test harnesses The shared fakes, fixtures and helpers that test suites use
Android Build Android build architecture, configuration, and deployment
Batch artifacts The job contract for files: inputs and outputs by hash, how they travel between nodes, and the artifact tasks
Fleet Rented machines: configuration keys, lifecycle states, reconcile findings, and the fleet and oci tasks
In this section
Topics
reference technical documentation
See also