MAKIINASDK

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

Shell
.\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
OptionMeaning
--port 8726the port the console serves on
--hostthe address it listens on; 127.0.0.1 by default, so only your PC can open it
--robot NAMEsign in and open this fleet robot's session at start
--no-browserserve without opening a browser
--demoseven simulated drives: the maintenance tools work, a session does not
--record-dir DIRwhere the console's recorder writes; default recordings
--tee-forward PORTsend 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 HZhow often the page receives state
--arms-dir DIRwhere 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:

AddressPage
#/the landing page
#/localOn this PC
#/fleet/loginthe fleet sign in
#/fleetthe fleet list
#/fleet/addAdd robot
#/control/local, #/control/fleet/acme-robot-02the cockpit
#/tuning/local, #/tuning/fleet/acme-robot-02Tuning
#/calibrate/..., #/firmware/..., #/software/...the maintenance tools
#/cameras/fleet/acme-robot-02a fleet robot's camera calibration
#/ssh/fleet/acme-robot-02, #/cloud/fleet/acme-robot-02a fleet robot's SSH access and Cloud pages

Keyboard

KeyDoes
SpaceSTOP: end a Go neutral or Go zero move at its last step
W, Ethe gripper handle moves or rotates
Escclose 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 Tuningpush the drafts
Esc in a Tuning fielddrop 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.

Shell
.\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 active

It 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).

OptionMeaning
--port 8727the port it serves on
--no-browserserve without opening a browser
--exit-on-closeexit 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 candlethe 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.0stop every enabled drive when the page has been silent this long, s
--watchdog-action holdwhat that stop is: hold where they are, or off to release the motors
--profiles-dir DIRwhere saved tunings go; default ~/.makiina/actuator-console/profiles
--stream-hz 100motion 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

Shell
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 owner

Run 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

CallReturns
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

VariableUsed byMeaning
MAKIINA_EMAIL, MAKIINA_PASSWORDRobot.connect, Fleet.login, the consolecloud credentials, for an account without two step sign in
MAKIINA_CLOUD_URLthe sameanother cloud endpoint
MAKIINA_TEE_PORTyour sessionsend a copy of the traffic to a recorder on this port
MAKIINA_RECORDINGS_DIRpython -m makiina.recorderwhere the recorder writes; default recordings
MAKIINA_ROBOT_DIRthe robot serverthe per-robot folder to use
MAKIINA_ARM_SIDEthe robot serverthe side of an arm whose boards do not say it
MAKIINA_ROBOTS_BASEthe model registrya separate folder of robot models

Ports

PortWho listens
8726the Robot Console; on a robot, its Robot admin page
8727the Actuator Console
8770the robot server of Robot.connect_local(); a second session needs another
8766your PC in Robot.connect_direct()
17999the session recorder, and the console's --sidecar

Files the SDK writes

PathWhat it holds
robot-calibrations/<name>/robot.tomlthe robot's name, role, 3D model and camera settings
robot-calibrations/<name>/actuators.tomlthe 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.logthe 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.jsonthe 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).