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. With --node all, see the next section.

Situation Result
A product of the bundle has no board, or more than one board (without --node all) 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.

Update all boards of a product

picolan push --node all firmware.bin
picolan push --node all release-v6.4.0.zip
pio run -t push --upload-port all
  • Each image goes to every board that runs its product.
  • The boards of one product update at the same time. Each board has its own thread and its own UDP sockets.
  • The products of a bundle update one after another, in bundle order. After a product with a failure, the tool stops. The next products are not started.
  • A failure on one board does not stop the other boards of the same product.
  • Each output line of a parallel update starts with the first 8 characters of the chip ID.
  • A product with no board, or any board with an IP conflict: nothing is installed.
  • --force-product does not work with --node all.
  • logs, reboot and blink refuse --node all.

All boards of the product get the new image at the same time. A defective image restarts all of them. Each board restores its previous firmware by itself.

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 push --wipe <files> Update, then erase all flash after the firmware (application data, LittleFS, EEPROM). Same result as pio run -t erase and a USB upload. Not with --no-confirm.
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, reboot and blink act on one board. push also accepts --node all, see above. 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 blink                 # 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.1

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.1
File Size Uploaded Provenance Actions
picolan-1.0.1.tar.gz 17.0 kB Without provenance Details for picolan-1.0.1.tar.gz

Built distribution (wheel)

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

Total release size: 33.7 kB

Release files / picolan-1.0.1.tar.gz

Download URL picolan-1.0.1.tar.gz
Size 17.0 kB
Tags Source
SHA-256 checksum
How to use checksums
f93f2b3f44fa7e4f762dff642ec2be36063a6355bff378bf526fe5b93def89bf
BLAKE2b-256 checksum
How to use checksums
9427cf2f1782736767bab75141753b873c9146b61bae2a6f691b44bbece93287
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

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

Download URL picolan-1.0.1-py3-none-any.whl
Size 16.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
27e3136c6f33f47950270d300308f1d980869be35dad5d6e5bd6ebe7cc042e61
BLAKE2b-256 checksum
How to use checksums
5984ebf097403b7f4337054df3406646b6deea8336af49a61b894b63a75687a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Security for picolan 1.0.1

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.1 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