Skip to content
MGross21Public

About

BLE interface for running MicroPython on LEGO® SPIKE™ devices.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

70 Commits

Folders and files

Repository files navigation

spikeble logo

(pronounced "spike-ble")
Lego Spike

Installation

From PyPI:

pip install spikeble

From GitHub:

pip install git+https://github.com/MGross21/spikeble.git

Note: spikeble ships type stubs (.pyi) for the SPIKE MicroPython modules (app, color, color_matrix, color_sensor, device, distance_sensor, force_sensor, hub, motor, motor_pair, orientation, runloop). Editors get auto-complete and type checking, but the modules are not importable on your computer; they only exist on the hub. Pyright/Pylance may warn that an import "could not be resolved from source"; silence it with reportMissingModuleSource = false.

Running Code on SPIKE

spikeble.run(main) uploads the body of main() to the hub without running it locally, so all MicroPython imports must go inside main(). Use the template below as a starting point for your SPIKE code:

import spikeble
import asyncio

def main():
    # from app import sound, bargraph, display, linegraph, music
    import color
    import color_matrix
    import color_sensor
    import device
    import distance_sensor
    import force_sensor
    from hub import port, button, light, light_matrix, motion_sensor, sound
    import motor
    import motor_pair
    import orientation
    import runloop

    ### Insert Your Code Here ###

if __name__ == "__main__":
    asyncio.run(spikeble.run(main))

Note:
As of SPIKE™ Firmware v1.8.149 and RPC v1.0.47, using import app or from app import ... will result in an import error. The app module is currently disabled until further notice.

Other Send Methods

You can also run code on the SPIKE using the following methods:

spikeble.run_file("path/to/your_script.py")
spikeble.run_str("print('Hello from SPIKE!')")

Documentation

Updating the Stubs

The stubs in stubs/ are generated from LEGO's official SPIKE App help content. To regenerate them, or to check whether they are out of date:

python scripts/gen_stubs.py
python scripts/gen_stubs.py --check

About

BLE interface for running MicroPython on LEGO® SPIKE™ devices.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages