Skip to content

About

Python libraries for interacting with your Flipper One (MCU and Linux)

Resources

Code of conduct

Security policy

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

flipperone

Work with a Flipper One from Python: the MCU's command-line interface, Linux on the main board over SSH, the Debug Probe, and the MCU's and the CPU's USB bootloaders.

pip install flipperone            # serial: the MCU and the Debug Probe
pip install 'flipperone[ssh]'     # and Linux over SSH

Python 3.12+, Linux and macOS.

from flipperone import connect

with connect.mcu_over_probe() as mcu:                       # or mcu_over_usb() while Linux is off
    print(mcu.device_info()["rp2350_firmware_version"], mcu.power_info().battery_level)

with connect.linux_over_ssh("10.0.0.1", password="...") as linux:
    print(linux.run("uname -r").out)

The subsystem classes take any transport: Mcu(stream) runs over a serial port, an SSH channel or your own stream; Linux(shell) over SSH or your own shell. flipperone.connect only pairs them the usual way.

Documentation

Development

uv venv && uv pip install -e '.[ssh]' --group dev
uvx nox                      # tests on 3.12-3.14, ruff, mypy --strict
pytest -m hardware           # on a device: tests/hardware/README.md

Rules for contributors and coding agents: AGENTS.md.

License

GPL-3.0-or-later: LICENSE.

About

Python libraries for interacting with your Flipper One (MCU and Linux)

Resources

Code of conduct

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages