Plans Reference

Plan file format and commands

Plan syntax reference

Plans are declarative configuration files that describe robot behavior, hardware setup, and automation rules.

Did You Know?

Plans in OctoMY™ are designed to be both human-readable and LLM-editable. The JSON-based schema means an AI assistant can generate or modify plans through OPAL commands, while humans can still open and edit them in any text editor. This dual-audience design is why plans use descriptive keys rather than terse abbreviations.


Reference

Topic Description
Syntax File format and structure
Commands Available commands
Conditions Condition expressions
Examples Example plan files

Overview

Plans use a JSON-based schema that nodes interpret to configure themselves. A plan can include:

  • Triggers and actions
  • Hardware configuration
  • Lobe configuration
  • References to other nodes
  • Shared secrets