API reference

Where you look things up. The Python API pages are generated from the API's source at v0.9.1: the signature and the docstring of every public method of RobotClient, the tool methods, the registered tools, the error codes, the environment variables and the controller's options, with notes written around them. The build fails when a page names a method the API no longer has, and the tests fail when a method is on no page.

• Python API

  ---

  Every method by category: motion, jogging and servoing, control, queries, synchronization, tools, I/O, configuration, the status fields, the errors, the controller.

• RBTscript

  ---

  Every command of the commander's program language, with its arguments.

• The serial protocol

  ---

  The packets between the PC and the control board, byte by byte, and the command codes.

• Firmware and test firmware

  ---

  The firmware's parameters per joint, and the test firmware's commands.

Comments

---

Found a mistake on this page? Edit it on GitHub · Report it · Get help · This page as Markdown · llms.txt · The whole manual as PDF