Skip to main content

picolan command-line tool

The picolan command finds, updates and monitors boards that run the picolan firmware library, over Ethernet. You do not need the source code, PlatformIO or a GitHub account.

Install

Requirement: Python 3.9 or later. The tool uses only the Python standard library.

pip install picolan

Update: pip install -U picolan. Check the version: picolan --version.

System Status
Linux Tested. All network interfaces are used.
Windows Supported. Not yet tested on hardware.
macOS Default network interface only. Not tested.

Connect the PC

  1. Connect the PC to the network of the boards.
  2. Give the PC an IP address in the subnet of the boards. Example: boards on 192.168.1.x/24, PC on 192.168.1.50/24.
  3. Run picolan nodes.

picolan nodes also finds boards in another subnet. An update needs an IP route to the board.

Update a system from a release bundle

A bundle is a zip file. It holds one firmware image per product and a manifest with the SHA-256 of each image.

  1. Copy the bundle to the PC, for example release-v6.4.0.zip.
  2. Run picolan nodes. Make sure that each product of the bundle appears once.
  3. Run picolan push release-v6.4.0.zip.

For each image, the tool:

  1. Finds the one board that runs the product of the image.
  2. Sends the image. The board restarts on the new firmware.
  3. Waits until the new firmware has run for 10 s, then confirms it.
  4. Checks that the board runs the new firmware.

The tool updates the boards one at a time. It stops at the first failure. At the end it prints one result line per board.

Situation Result
A product of the bundle has no board, or more than one board Nothing is installed.
An image was changed after the bundle was made Nothing is installed.
A board already runs the image Skipped. Use --reinstall to install again.
The new firmware fails The board restores its previous firmware by itself. The tool stops.

Commands

Command Use
picolan nodes List the boards: product, chip ID, IP, build, state.
picolan push <files> Update boards from .bin files or bundles.
picolan logs Show the log of a board. Ctrl+C to stop.
picolan wipe Erase the stored data of a board (LittleFS and EEPROM). The firmware stays.
picolan reboot Restart a board.
picolan blink [seconds] Blink the LED of a board, if the firmware has one configured.
picolan bundle -o <zip> <files> Make a bundle from .bin files.

Select a board

logs, wipe, reboot and blink act on one board. With one board on the network, no option is necessary. Otherwise add --node:

picolan --node motor-controller logs      # product name
picolan --node 192.168.1.4 reboot
picolan --node 5C82 wipe                  # chip ID or a unique prefix of it

The value must match exactly one board, or the tool stops.

Install log

The tool adds one line per board to an install log:

System File
Linux ~/.local/state/picolan/install.log
Windows %LOCALAPPDATA%\picolan\install.log

Example line:

2026-11-14T19:02:58+0200 result=OK chip=5C829BF5E4BF9E53 ip=192.168.1.33 product=sensor-hub from=a1b2c3d/2B393BC5 to=d4e5f6a/585622FA release=my-system/v6.4.0 source=release-v6.4.0.zip:sensor-hub.bin

result is OK, FAILED, SKIPPED or UNCONFIRMED. Use --log <file> or the environment variable PICOLAN_LOG for another file, and --no-log for none.

Network options

Option Use
--iface <name or IP> Use only this network interface. Linux: interface name, for example eth0. Any system: a local IPv4 address. Repeatable.
PICOLAN_IFACE=eth0,eth1 The same, as an environment variable.

Port: 8208, UDP (discovery, commands, log) and TCP (firmware transfer).

Metadata

Release files for picolan 1.0.0

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

Source distribution (sdist)

Source distribution for picolan 1.0.0
File Size Uploaded Provenance Actions
picolan-1.0.0.tar.gz 15.3 kB Without provenance Details for picolan-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for picolan 1.0.0
File Interpreter ABI Platform Actions
picolan-1.0.0-py3-none-any.whl Python 3 none any Details for picolan-1.0.0-py3-none-any.whl

Total release size: 30.2 kB

Release files / picolan-1.0.0.tar.gz

Download URL picolan-1.0.0.tar.gz
Size 15.3 kB
Tags Source
SHA-256 checksum
How to use checksums
dc2e7896710ced3bb25c2e45c061ce877a7b5f80a978b1b292dc53cf670ebecf
BLAKE2b-256 checksum
How to use checksums
c8165e9590d9e220883df2cb65f52ad9f00fecf522632a6678fb526531d8b9e0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Release files / picolan-1.0.0-py3-none-any.whl

Download URL picolan-1.0.0-py3-none-any.whl
Size 14.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a66b78848131f2c504d28073a458796fa527dc49a802fd7630b57c63a0c78a0d
BLAKE2b-256 checksum
How to use checksums
9175feb50b794ab07c8be827aad97562f720712a5cd6d06f3024b88fea94bf32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Security for picolan 1.0.0

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.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

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