Note: This assumes you have some knowledge of working with Python and Python as well as Pip installed.
- Download this repository.
- Download the necessary requirements for this project by running
pip install -r requirements.txtin the root of the project. - Run the compiler by executing the following command in the root of the project
python -m src INPUT_FILENAME(whereINPUT_FILENAMEis the path to the file that should be compiled). Furthermore there are multiple optional flags that can be used, runningpython -m src --helpgives you the following explanation for them:
Usage: python -m src [OPTIONS] INPUT_FILENAME
Arguments:
INPUT_FILENAME The path to the file that should be converted. [required]
Options:
--output-filename TEXT The name of the file the code should be
written to. If none is provided the code
will just be printed.
--ast / --no-ast Indicates if the AST representation should
also be outputted. [default: no-ast]
--ast-filename TEXT Indicates where to write the AST
representation to if --ast is used. If none
is provided the representation will just be
printed.
--safe / --no-safe Indicates if safer code should be outputted,
the code might be more verbose. [default:
no-safe]
--best-effort / --no-best-effort
Indicates if the code should be generated
even if it contains blocks that are not
translatable (will be skipped). [default:
best-effort]
--help Show this message and exit.
A compiler from the Scratch-like programming language used by the 51515 Robot Inventor Lego set to Python.
A great feature of the latest generation of Mindstorms is that they can be programmes using both a Scratch-like language (great for beginners) and Python (great for more experienced users). Sadly however making the switch from the Scratch-like language to Python can be a bit tricky as there is no way to generate the equivalent Python code for your past projects. This is where this program comes into play it takes as input your project.lms file and outputs the equivalent Python code.
The root of the project contains a lot of uninteresting files which you can ignored unless you want to dive into the weeds of how the project works.
The source code can be found in ./src this is a Python module which itself contains other Python modules the entry point is ./src/__main__.py from which you should be able to follow the flow through all other files.
The test can be found in ./tests more precisely the input files for the tests are in ./tests/inputs structured by the class of the blocks that are in the files. Each test input is a folder containing 3 files, the FILE.lms file with FILE the same name as the folder, the project.json this is the underlying json representation extracted from the the FILE.lms and icon.scg also extracted from the which in essence is a screenshot of the blocks that are in the project.
Note: If you save a file a .lms project file to ./tests/inputs and run the ./format_input.sh script on it it will automatically generate a folder with the same name as the file that will contain all 3 files discussed above.
The test themselves are written using pytest and are split into 3 categories, which test the JSON-extraction, AST-generation and Code-generation respectively. These can be run using pipenv run pytest.
Some of the blocks are not currently supported because their behavior can't be replicated using the Python API, this includes but is not limited to the following: Blocks related to animations, Blocks related to Pitch effects, Blocks related to Parallelization(most event blocks). Maybe in the future if the Python API evolves these blocks can be supported.
A set of the most used blocks is already supported (see the list below). On top of generating the equivalent Python code the compiler can also output the abstract syntax tree representation of a program. The representation is done using Graphviz a simple example of such a AST visualization can be seen below together with the generated python code.
my_variable = 10.0
motor_pair = MotorPair('A', 'B')
motor_pair.set_default_speed(50) # Note: Needed since the default speed is 100, which is too fast.
motor_pair.set_default_speed(int(my_variable)) # Note: This methods expects an integer so wee need to convert the value.
motor_pair.move(10.0, 'cm')| Block | # Configurations |
|---|---|
| Motors | |
| Run Motor for Duration | 11 |
| Motor Go to Position | 8 |
| Start Motor | 6 |
| Stop Motor | 5 |
| Set Motor Speed | 7 |
| Motor Position | 3 |
| Motor Speed | 3 |
| Movement | |
| Move for Duration | 9 |
| Move with Steering | 7 |
| Start moving with Steering | 2 |
| Stop moving | 1 |
| Set Movement Speed | 2 |
| Set Movement Motor | 3 |
| Set Motor Rotation | 3 |
| Light | |
| Start Animation | - |
| Play Animation until Done | - |
| Turn Light Matrix on for Duration | 3 |
| Turn Light Matrix on | 2 |
| Write on Matrix | 2 |
| Turn off Pixels | 1 |
| Set Pixel Brightness | 2 |
| Set Pixel | 4 |
| Rotate Orientation | - |
| Set Orientation | - |
| Set Center Button Light | 8 |
| Light up Distance Sensor | 3 |
| Sound | |
| Play Sound until done | 2 |
| Start Sound | 2 |
| Play Beep | 2 |
| Start Beep | 2 |
| Stop Beep | 1 |
| Change Pitch Effect | - |
| Set Pitch Effect | - |
| Clear Pitch Effect | - |
| Change Volume | 2 |
| Set Volume | 2 |
| Volume | 1 |
| Control | |
| Wait For Seconds | 2 |
| Wait Until | 1 |
| Repeat Loop | 2 |
| Forever | 1 |
| Repeat Until | 1 |
| If Then | 1 |
| If Then Else | 1 |
| Do This And This | - |
| Stop Other Stacks | - |
| Stop | - |
| Sensors | |
| Is Color | 9 |
| Color | 1 |
| Is reflected Light | 4 |
| Reflected Light | 1 |
| Is Distance | 5 |
| Distance | 3 |
| Gesture | 1 |
| Is Shaken | 3 |
| Is Hub Orientation | 9 |
| Hub Orientation | 1 |
| Set Yaw Angle | 1 |
| Is Button Pressed | 3 |
| Hub Angle | 3 |
| Timer | 1 |
| Reset Timer | 1 |
| Key Pressed | - |
| Operators | |
| Pick Random Number | 2 |
| Plus | 3 |
| Minus | 3 |
| Multiply | 3 |
| Divide | 3 |
| Less Than | 2 |
| Equal | 2 |
| Greater Than | 2 |
| And | 1 |
| Or | 1 |
| Not | 1 |
| Is Between | 2 |
| Join String | 2 |
| Letter Of String | 2 |
| Length Of String | 2 |
| String Contains | 2 |
| Mod | 2 |
| Round | 2 |
| Binary Math Function | 7 |
| Unary Math Function | 14 |
| Variables | |
| Variable | 2 |
| Set Variable To | 2 |
| Change Variable By | 2 |
| List | 1 |
| Add Item to List | 4 |
| Delete Item of List | 2 |
| Delete All of List | 1 |
| Insert Item in List at Index | 3 |
| Replace Item in List at Index | 3 |
| Item at Index | 2 |
| Index of Item | 2 |
| Length of List | 1 |
| List contains Item | 2 |
| Events | |
| When Program Starts | 1 |