Tools
The CyberiadaPro and Cyberiada IDE diagram editors, code generators, dispatchers and the firmware flasher.
Editors
Cyberiada IDE
Cyberiada IDE is an HSM programming environment for cyber-physical platforms: Windows 10 and newer, Linux, macOS 10.13 and newer. It is the release of Lapki IDE, developed in the open repository. From a diagram the environment builds and flashes the program for a platform:
- Arduino Uno and Arduino Micro;
- CyberBear;
- the TJC-HSM boards on the STM32G030 microcontroller;
- TJC-IR;
- the drones of the Berloga: Apiary Defence game.
The build is done by lapki-compiler, the flashing by lapki-flasher. The documentation of the environment is lapki-docserver.
Cyberiada IDE also supports finite automata simulator launching out of a box.
CyberiadaPro
CyberiadaPro is a development environment and an editor of HSM diagrams built on Qt, for Ubuntu and Windows.
- Several documents in tabs, undo and redo, search.
- Document modes: an HSM diagram, a finite automaton, a read-only inspection, a comparison of two versions of a diagram, text (Markdown, JSON, C, C++, C#, Python).
- The code of the actions highlighted in the language of the diagram’s platform.
- Export of a diagram to PNG and SVG; a batch mode for scripts and tests.
- Plugins that generate, run and check diagrams (below).
- The interface in English and Russian.
| Plugin | What it does | Repository |
|---|---|---|
| HSM Maker | draws a diagram from a description in a natural language | cybersphere-hsm-maker |
| HSM to Python | generates a Python program and runs it | hsm-to-python |
| Finite Automata | runs a finite automaton on a tape of symbols, step by step too | fa-dispatcher-py |
| HSM ROS2 | checks the diagram, generates, builds and tests a ROS2 package | hsm_robot_ros_generator |
| HSM Turtle | drives the turtle of the turtlesim simulator | turtle_driver |
| Git | commits the diagram and shows the changes state by state | cybersphere-git-plugin |
| Lapki Compiler | builds the firmware for Arduino Uno, TJC-HSM, CyberBear | lapki-compiler-plugin |
The Unity editor
ReferenceEditor is the reference CyberiadaML-GraphML diagram editor on Unity. The graph model, the conversion to GraphML and the interpreter interfaces come from the CyberiadaLogic package.
Code generators
- lapki-compiler generates and compiles the code for Arduino, TJC-HSM and TJC-IR; it receives the diagrams over a web socket from Cyberiada IDE and CyberiadaPro.
- hsm_robot_ros_generator turns a diagram into a ROS 2 node in Python with a hardware access layer.
- hsm-to-python turns a diagram into
a Python program run by the dispatcher; the commands
hsm-run,hsm-gencode,hsm-check.
Dispatchers
A dispatcher runs a diagram itself, without generating code.
- hsm-dispatcher-py runs HSM diagrams in Python 3.
- fa-dispatcher-py runs deterministic finite automata (the FA extension): it reads a tape of symbols or text and gives the verdict and the output symbols; it serves the step-by-step runs of CyberiadaPro.
Flasher
lapki-flasher is the Cyberiada IDE module that finds the connected boards and flashes them: Arduino Uno, Micro and Mega, TJC-HSM, CyberBear. It works on Windows 7 and newer, Linux, macOS.
Language models
cybersphere-hsm-maker draws a
diagram from a description of the system in a natural language. The model
writes the structure of the diagram in a compact notation; the tool checks it
and returns the errors to the model until the diagram is right, then builds and
lays out the CyberiadaML-GraphML file. It works with any server compatible with
the chat-completions or the messages protocol and runs from the command line
(hsm-maker) or as a CyberiadaPro plugin.