Micro:bit TinyBit BLE Python Library

A Python package to control a custom Robot V2 via Bluetooth Low Energy (BLE) communication. The package provides an API for controlling the robot's movements and LED colors.

Installation

This project uses Poetry for package management. Install Poetry if you haven't already.

To install the package and its dependencies, run:

poetry install

Usage

The example.py script demonstrates how to use the package to control the robot.

from weallcode_robot import Robot

robot = Robot("WAC")

robot.led(255, 0, 0)        # Set the LED color to red
robot.move(100, 100)        # Move forward
robot.wait(2)               # Wait for 2 seconds
robot.move(0, 0)            # Stop the robot
robot.move(-100, 100)       # Turn the robot
robot.wait(0.25)            # Wait for 0.25 seconds
robot.move(100, 100)        # Move forward
robot.wait(1)               # Wait for 1 second
robot.move(0, 0)            # Stop the robot
robot.move(-100, -100)      # Move backward
robot.wait(1)               # Wait for 1 second
robot.move(0, 0)            # Stop the robot

robot.led(0, 0, 0)          # Turn off the LED

a = robot.setKeyBinding('a').led(0, 0, 255, 1) # set LED color one button A
w = robot.setKeyBinding('w').move(100, 100)    # bind move forward to key W

API

Robot

The Robot class is the main class to control the robot. Instantiate the class with the name of the robot.

robot = Robot("WAC")

Methods

led(red: int, green: int, blue: int, duration: int): Sets the LED color. Values should be integers between 0 and 255.
move(left: int, right: int, duration: int): Sets the motor speeds. Values should be integers between -100 and 100.
wait(duration: float): Adds a wait command with a given duration in seconds.
run(): Executes the commands in the order they were added.

Development

The package includes development dependencies:

black: Code formatter
pre-commit: Pre-commit hooks for code formatting and linting
isort: Import sorter
ruff: Linter

To install the development dependencies, run:

poetry install --extras dev

To run the pre-commit hooks, first install them:

pre-commit install

Then run:

pre-commit run --all-files

Authors

Blaine Rothrock
Ali Karbassi

Metadata

Release files for weallcode-robot 3.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for weallcode-robot 3.1.4
File	Size	Uploaded
weallcode_robot-3.1.4.tar.gz	7.1 kB	Dec 21, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for weallcode-robot 3.1.4
File	Interpreter	ABI	Platform	Reset
weallcode_robot-3.1.4-py3-none-any.whl 8.0 kB Dec 21, 2024	Python 3	none	any	Details

Total release size: 15.1 kB

Release files / weallcode_robot-3.1.4.tar.gz

Download URL	weallcode_robot-3.1.4.tar.gz
Size	7.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`7fe091ede442d798194487fe80f3ec0b76c30966d4ef931689f9e7a1186bffc9`
BLAKE2b-256 checksum How to use checksums	`07040501f775af062bd6108286033c4f351a7c5586efd685ffa132cb248b0b09`
Upload date	Dec 21, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.0.1 CPython/3.12.8`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/WeAllCode/tinybit-python
Publishing commit: github.com/WeAllCode/tinybit-python/tree/808edee8f75b294c1941e7d34a622b39fc6ebd27

Workflow

Publishing configuration: github.com/WeAllCode/tinybit-python/blob/808edee8f75b294c1941e7d34a622b39fc6ebd27/.github/workflows/publish.yml
Publishing logs: github.com/WeAllCode/tinybit-python/actions/runs/12446492441/attempts/1

Artifact

Subject: weallcode_robot-3.1.4.tar.gz
SHA-256 checksum: 7fe091ede442d798194487fe80f3ec0b76c30966d4ef931689f9e7a1186bffc9 Verifying attestations

Release files / weallcode_robot-3.1.4-py3-none-any.whl

Download URL	weallcode_robot-3.1.4-py3-none-any.whl
Size	8.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6c9c8baf53ba05bd60e826c9f7c314bc3e7331b2dde5124b98c0734f77d3a5c1`
BLAKE2b-256 checksum How to use checksums	`fa5e2d125e5c74eeb3fa892c2c804b8f9ebb71288b116602b6e2dfcbb3f71376`
Upload date	Dec 21, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.0.1 CPython/3.12.8`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/WeAllCode/tinybit-python
Publishing commit: github.com/WeAllCode/tinybit-python/tree/808edee8f75b294c1941e7d34a622b39fc6ebd27

Workflow

Publishing configuration: github.com/WeAllCode/tinybit-python/blob/808edee8f75b294c1941e7d34a622b39fc6ebd27/.github/workflows/publish.yml
Publishing logs: github.com/WeAllCode/tinybit-python/actions/runs/12446492441/attempts/1

Artifact

Subject: weallcode_robot-3.1.4-py3-none-any.whl
SHA-256 checksum: 6c9c8baf53ba05bd60e826c9f7c314bc3e7331b2dde5124b98c0734f77d3a5c1 Verifying attestations