Skip to main content

docs

Documentation Status

package

PyPI Package latest release PyPI Wheel Supported versions

Rewritten Python Library for Birdbrain Technologies Hummingbird Bit and Finch 2

Rewrite inspired by https://github.com/BirdBrainTechnologies/BirdBrain-Python-Library

  • Free software: GNU Lesser General Public License v3 (LGPLv3)

Installation

pip install robot-birdbrain

You can also install the in-development version with:

pip install https://github.com/fmorton/robot-birdbrain/archive/main.zip

Hummingbird Example

from robot.hummingbird import Hummingbird
from time import sleep

hummingbird = Hummingbird('A')

for i in range(0, 10):
  hummingbird.led(1, 100)
  sleep(0.1)

  hummingbird.led(1, 0)
  sleep(0.1)

  hummingbird.stop_all()

Finch Example

from robot.finch import Finch
from time import sleep

finch = Finch('A')

for i in range(0, 10):
  finch.beak(100, 100, 100)
  sleep(0.1)

  finch.beak(0, 0, 0)
  sleep(0.1)

finch.stop_all()

Tasks Example (requires the robot-tasks package)

from robot.hummingbird import Hummingbird
from robot.tasks import Tasks

async def task_1(bird):
  while True:
    print("task_1 running")

    await Tasks.yield_task(1.0)


async def task_2(bird):
  while True:
    print("task_2 running")

    await Tasks.yield_task(0.5)


bird = Hummingbird("A")

tasks = Tasks()

tasks.create_task(task_1(bird))
tasks.create_task(task_2(bird))

tasks.run()

Original Documentation

The original documentation from Birdbrain Technolgies can be found at:

Finch: https://learn.birdbraintechnologies.com/finch/python/library/

Hummingbird: https://learn.birdbraintechnologies.com/hummingbirdbit/python/library/

Testing

To run all the tests run (hummingbird (with micro:bit v2) on ‘A’ and finch on ‘B’):

pytest

Metadata

Release files for robot-birdbrain 0.14.2

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

Source distribution (sdist)

Source distribution for robot-birdbrain 0.14.2
File Size Uploaded Provenance Actions
robot_birdbrain-0.14.2.tar.gz 39.9 kB Without provenance Details for robot_birdbrain-0.14.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for robot-birdbrain 0.14.2
File Interpreter ABI Platform Actions
robot_birdbrain-0.14.2-py3-none-any.whl Python 3 none any Details for robot_birdbrain-0.14.2-py3-none-any.whl

Total release size: 71.8 kB

Release files / robot_birdbrain-0.14.2.tar.gz

Download URL robot_birdbrain-0.14.2.tar.gz
Size 39.9 kB
Tags Source
SHA-256 checksum
How to use checksums
0fce76817ae81b26fd8c129b7d1d88d10069907c0c8a7bbf2b65080c9fb3f701
BLAKE2b-256 checksum
How to use checksums
0529eb7e833ba1d241297c150e8a55faa15f7a242b8a939bb8bbf55501c594c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.2

Release files / robot_birdbrain-0.14.2-py3-none-any.whl

Download URL robot_birdbrain-0.14.2-py3-none-any.whl
Size 31.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
afe1fe31f6d955daf90b0cc49b08e8842661b20edc6ebce9d061ea2d6cb34a18
BLAKE2b-256 checksum
How to use checksums
746b32732a5c7127be5edcea2dc2ea700c587dbc1e3953b2c4d7c1bcb00af7dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.2

Security for robot-birdbrain 0.14.2

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page