Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robmosca/robotinventor-vscode

A Microsoft Visual Studio Code extension to program LEGO® MINDSTORMS® Robot Inventor in MicroPython
https://github.com/robmosca/robotinventor-vscode

hub lego lego-mindstorms-robot micropython mindstorms robot-inventor

Last synced: 3 days ago
JSON representation

A Microsoft Visual Studio Code extension to program LEGO® MINDSTORMS® Robot Inventor in MicroPython

Host: GitHub
URL: https://github.com/robmosca/robotinventor-vscode
Owner: robmosca
License: mit
Created: 2020-11-01T17:59:01.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-12-16T15:45:24.000Z (11 months ago)
Last Synced: 2023-12-17T15:55:50.002Z (11 months ago)
Topics: hub, lego, lego-mindstorms-robot, micropython, mindstorms, robot-inventor
Language: TypeScript
Homepage:
Size: 277 KB
Stars: 20
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# VScode extension for the Robot inventor set

[![codecov](https://codecov.io/gh/robmosca/robotinventor-vscode/graph/badge.svg?token=CPJNM9ZTKA)](https://codecov.io/gh/robmosca/robotinventor-vscode)
[![CI](https://github.com/robmosca/robotinventor-vscode/actions/workflows/main.yml/badge.svg)](https://github.com/robmosca/robotinventor-vscode/actions/workflows/main.yml)

This is a Microsoft Visual Studio Code extension to
program the LEGO® MINDSTORMS® Robot Inventor set in MicroPython.

- It only works on macOS and Linux, at the moment. **Windows is not supported.**
- It only works with Hubs connected via USB.

## How to install

**Before installing the extension, please read the disclaimer at the end of this
page.**

**Prerequisites**

In order to compile and install the extension you need npm v12.x. If you use
`nvm` simply `nvm use` inside the repository (make sure the npm version
specified in `.nvmrc` is installed).
Also, you need the command line `code` command installed.

**Install the extension**

1. Clone the repository
2. Install the dependencies

```
npm ci
```

3. Package and install the extension

```
npm run package
code --install-extension robotinventor-1.0.0.vsix
```

## How to use the extension

After installing the extension open the RI5DEV device browser:

![Connect Hub](./imgs/connect_hub.png)

and click on "Add LEGO Hub". The Hub must be connected via USB. Select the
device:

![Select device](./imgs/select_device.png)

The extension will retrieve the storage status of the Hub and will show all
available programs.

![Storage status](./imgs/storage_status.png)

You can then right click on any slot and perform any of the
following operations:

1. Execute a program
2. Remove a program
3. Move a program from one slot to another
4. Upload a program. You need to have the corresponding micropython file open.

Also, by right-clicking on the Hub you can select the command to stop the
execution of a program.

![Commands](./imgs/commands.png)

## Useful links and external references

Since there is no official documentation for the API, the implementation is based
on what I could discover empirically.
I also obtained information from the following repositories, based on the LEGO®
Education SPIKE™️ Prime Set:

- [gpdaniels/spike-prime](https://github.com/gpdaniels/spike-prime/blob/master/specifications/stm32f413.pdf)
- [nutki/spike-tools](https://github.com/nutki/spike-tools)
- [sanjayseshan/spikeprime-tools](https://github.com/sanjayseshan/spikeprime-tools)

I based the implementation on the work of David Lechner (for EV3):

[ev3dev/vscode-ev3dev-browser](https://github.com/ev3dev/vscode-ev3dev-browser)

_LEGO and Mindstorms are trademarks of the LEGO Group._

## Disclaimer

_The material embodied in this software is provided to you "as-is" and without_
_warranty of any kind, express, implied or otherwise, including without_
_limitation, any warranty of fitness for a particular purpose. In no event shall_
_the author of this software be liable for any direct, special, incidental,_
_indirect or consequential damages of any kind arising out of or in connection_
_with the possession, use or performance of this software._