ReferenceConsole, CLI, environment
Console, CLI and environment
The options and shortcuts of the Robot Console and the Actuator Console, the cloud command line tool, environment variables, ports and the files the SDK writes.
The Robot Console
.\RobotConsole.bat [options] # Windows, in PowerShell in the kit folder
./robot_console.sh [options] # Linux
makiina-console [options] # any shell with the SDK environment active| Option | Meaning |
|---|---|
--port 8726 | the port the console serves on |
--host | the address it listens on; 127.0.0.1 by default, so only your PC can open it |
--robot NAME | sign in and open this fleet robot's session at start |
--no-browser | serve without opening a browser |
--demo | seven simulated drives: the maintenance tools work, a session does not |
--record-dir DIR | where the console's recorder writes; default recordings |
--tee-forward PORT | send the session's traffic to your own recorder on this port instead of the console's |
--sidecar [PORT] | watch, read only, a session that another program on this PC owns and copies to this port (default 17999) |
--state-hz HZ | how often the page receives state |
--arms-dir DIR | where the per-robot folders live; default robot-calibrations/ |
The same console runs on a robot's head computer as its Robot admin page, at http://<robot>.local:8726 (the name on the robot's card) on the robot's network: software updates, SSH keys, camera calibration and the robot's own boards. Use the Robot admin page shows how to open it.
Pages
Each page has an address you can bookmark:
| Address | Page |
|---|---|
#/ | the landing page |
#/local | On this PC |
#/fleet/login | the fleet sign in |
#/fleet | the fleet list |
#/fleet/add | Add robot |
#/control/local, #/control/fleet/acme-robot-02 | the cockpit |
#/tuning/local, #/tuning/fleet/acme-robot-02 | Tuning |
#/calibrate/..., #/firmware/..., #/software/... | the maintenance tools |
#/cameras/fleet/acme-robot-02 | a fleet robot's camera calibration |
#/ssh/fleet/acme-robot-02, #/cloud/fleet/acme-robot-02 | a fleet robot's SSH access and Cloud pages |
Keyboard
| Key | Does |
|---|---|
| Space | STOP: end a Go neutral or Go zero move at its last step |
| W, E | the gripper handle moves or rotates |
| Esc | close the open card; cancel a session start |
| [, ] | previous and next page of the console's whole page list (landing, Sign in, Fleet, This PC, Control, Tuning, Calibrate, Firmware, Software, SSH, Cloud), whatever the robot; a step from Control or Tuning to any other page ends the session |
| Enter on Tuning | push the drafts |
| Esc in a Tuning field | drop that draft |
The Actuator Console
Start with Set up the actuator and First move. Use the Actuator Console explains its motion tools, tuning profiles and telemetry with pictures.
.\ActuatorConsole.bat [options] # Windows, in PowerShell in the kit folder
./actuator_console.sh [options] # Linux
makiina-actuator-console [options] # any shell with the SDK environment activeIt opens http://127.0.0.1:8727 with every actuator on every USB CAN adapter of your PC: firmware one board at a time, zero and setup, control in every mode with test signals, every drive setting with its readback, and live telemetry. It has no sign in, so it serves your PC only. It holds the adapters while it runs: close it before the Robot Console or a script uses them. On Windows it opens the USB CAN adapters directly. On Linux it uses the Linux CAN interfaces (socketcan) such as can0, which must be up at 1 Mbit/s, unless you start it with --interface candle (Install the SDK).
| Option | Meaning |
|---|---|
--port 8727 | the port it serves on |
--no-browser | serve without opening a browser |
--exit-on-close | exit after the last tab closes, allowing five seconds for refreshes and waiting for hardware jobs; desktop launchers enable it, --no-browser ignores it |
--sim [N] | simulated actuators instead of hardware: 11, or the first N of them |
--interface candle | the CAN backend: candle (the USB path, the default on Windows) or socketcan (the default on Linux) |
--channels "candle:<serial>:0;candle:<serial>:0" | use only these adapters |
--watchdog-s 1.0 | stop every enabled drive when the page has been silent this long, s |
--watchdog-action hold | what that stop is: hold where they are, or off to release the motors |
--profiles-dir DIR | where saved tunings go; default ~/.makiina/actuator-console/profiles |
--stream-hz 100 | motion target rate in Hz, from 10 to 250 |
Closing the page normally holds enabled drives with the default watchdog; it does not request Torque off. Read Stop and release before ending a session with a loaded actuator.
The cloud command line tool
python -m makiina.cloud.makiina_cli login you@example.com # asks for the password and the two step code
python -m makiina.cloud.makiina_cli robots # your robots and who is using them
python -m makiina.cloud.makiina_cli logout # ends this sign in and removes it from this PC
python -m makiina.cloud.makiina_cli claim BCDF-GHJK-LMNP # add a robot with the claim code from its card
python -m makiina.cloud.makiina_cli release acme-robot-02 # owners: a claim code for the next ownerRun it with the SDK's Python (.venv\Scripts\python.exe or .venv/bin/python). login saves the sign in, never your password, and Robot.connect, Fleet.login and the console's Saved login use it. claim needs an account whose email address is confirmed; --new-org puts the robot in a new organization. release asks for your password; add --code when your account has two step sign in. --url before the command points the tool at another cloud endpoint. The other commands are for MAKIINA staff.
makiina.cloud
| Call | Returns |
|---|---|
Fleet.login(email=None, password=None, base_url=None) | a signed-in view of your account's robots |
fleet.robots() | one dict per robot: name, id, online, status, status_detail, last_seen, active_session, agent_version, inventory, console |
fleet.console_url(robot) | http://<lan address>:<port>/ of the robot's Robot admin page, or None |
login_client(email=None, password=None, base_url=None) | a signed-in CloudClient for Robot.connect(cloud=...) |
cached_token_path() | where the saved sign in lives |
Environment variables
| Variable | Used by | Meaning |
|---|---|---|
MAKIINA_EMAIL, MAKIINA_PASSWORD | Robot.connect, Fleet.login, the console | cloud credentials, for an account without two step sign in |
MAKIINA_CLOUD_URL | the same | another cloud endpoint |
MAKIINA_TEE_PORT | your session | send a copy of the traffic to a recorder on this port |
MAKIINA_RECORDINGS_DIR | python -m makiina.recorder | where the recorder writes; default recordings |
MAKIINA_ROBOT_DIR | the robot server | the per-robot folder to use |
MAKIINA_ARM_SIDE | the robot server | the side of an arm whose boards do not say it |
MAKIINA_ROBOTS_BASE | the model registry | a separate folder of robot models |
Ports
| Port | Who listens |
|---|---|
| 8726 | the Robot Console; on a robot, its Robot admin page |
| 8727 | the Actuator Console |
| 8770 | the robot server of Robot.connect_local(); a second session needs another |
| 8766 | your PC in Robot.connect_direct() |
| 17999 | the session recorder, and the console's --sidecar |
Files the SDK writes
| Path | What it holds |
|---|---|
robot-calibrations/<name>/robot.toml | the robot's name, role, 3D model and camera settings |
robot-calibrations/<name>/actuators.toml | the limits and main gains every session sets, per joint (What a new session sets) |
robot-calibrations/<name>/cameras/ | on a dual arm system: the stereo cameras' calibration |
logs/<name>-server.log | the log of a robot server on your PC; read it when a connection fails |
recordings/<date>_<time>/ | a recorded session: packets.mkrec and meta.json |
~/.makiina/token.json | the saved cloud sign in, readable by you only; with the keyring package installed it goes to your system's keyring instead |
~/.makiina/actuator-console/profiles/ | tunings saved in the Actuator Console |
The robot-calibrations folder of an arm on your PC is in the kit folder, and <name> is your PC's name, or arm-auto for Arm.connect() with no name, which writes that folder again at every call. A dual arm system keeps its own on its head computer, in ~/repos/core/robot-calibrations/<name>/, <name> being the name on the robot's card, which a new name in your account does not change; your PC has no copy, and you reach it over SSH (Add SSH keys).
To keep one of the settings a session sets, change its line in that actuators.toml; a line for any other key has no effect. The file already has the tables [classes], [defaults] (every joint but the grippers), [joints.J1] to [joints.J6] (that joint on both sides), [joints.gripper] (both grippers) and [joints.head]: change the line in the table that is there, and add only a table that is not in the file, such as [joints.left_J2] for one side. A table name written twice stops the file from loading, and no session starts. The next session uses the file (Keep settings for good).