Skip to main content

Companion CLI for wakemypc.com -- flash, provision, and manage Pico W transmitters from your terminal

Project description

wakemypc

Companion CLI for wakemypc.com. Runs on your computer, talks to a Pi Pico W (or W 2) over USB, and your wakemypc.com account over HTTP.

Install

Direct from GitHub (recommended for now -- no PyPI release yet):

pip install git+https://github.com/wakemypc/wakemypc-cli.git

Verify:

wakemypc --help

On Linux you may need to add yourself to the dialout group so you can talk to the Pico's serial port without sudo:

sudo usermod -a -G dialout $USER
# log out and back in

What it does

wakemypc detect           # list connected Picos (flashed and BOOTSEL-mode)
wakemypc flash --uf2 …    # write MicroPython firmware to a BOOTSEL Pico
wakemypc upload …         # copy wakemypc-firmware .py files onto the Pico
wakemypc provision …      # write WiFi creds + server URL to secrets.json
wakemypc register …       # register with the server, get a device token
wakemypc restart          # soft-reboot the Pico (or reboot into BOOTSEL)
wakemypc identify         # blink the Pico's LED to find it physically
wakemypc status           # read WiFi state + secrets summary over USB

wakemypc --help and wakemypc <subcommand> --help have the full reference. The most common flow for a brand new Pico is:

# 1) Plug Pico in BOOTSEL mode (hold BOOTSEL while connecting USB).
wakemypc detect
wakemypc flash --uf2 RPI_PICO2_W-…uf2

# 2) Plug the now-flashed Pico in normally.
wakemypc upload --firmware-dir ./wakemypc-firmware/src/

# 3) Configure WiFi + server.
wakemypc provision --server-url https://wakemypc.com --add-new-wifi --wifi-ssid HomeWiFi --wifi-pass mypassword

# 4) Register on wakemypc.com.
wakemypc register --api-url https://wakemypc.com --username you@example.com
# (prompts for password; saves the resulting device token to the Pico)

Token rotation

Three modes:

wakemypc register --api-url https://wakemypc.com --username  --password             # fresh
wakemypc register --api-url https://wakemypc.com --username  --password  --rotate   # rotate existing
wakemypc register --token <T>                                                          # offline, no server call

--rotate calls the server's rotate-token endpoint and writes the new token to the Pico in one step. --token <T> skips the server -- handy when you've already rotated through the dashboard and just need to push the new token over USB.

What this CLI does NOT do

  • It does not need root / sudo (apart from the one-time dialout group add on Linux).
  • It does not phone home. The only network calls go to the --api-url you pass to register.
  • It does not store your password. Login uses the JWT the server returns; the password is forwarded once and then forgotten.

License

Source-available, non-commercial. PolyForm Noncommercial 1.0.0.

You can run it, audit it, modify it, and share patches. You can't sell it or run a paid service on top of it. Patches welcome.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wakemypc-1.0.0.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wakemypc-1.0.0-py3-none-any.whl (42.9 kB view details)

Uploaded Python 3

File details

Details for the file wakemypc-1.0.0.tar.gz.

File metadata

  • Download URL: wakemypc-1.0.0.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for wakemypc-1.0.0.tar.gz
Algorithm Hash digest
SHA256 08111f9f121149888eab06cb4e87c710f6788a980c7457982df350ff156db096
MD5 cc212ee2ab70ff9cd71eba9bf6ea8649
BLAKE2b-256 dc199637863706737f38160f2fa0dacf7ec05072f64cd387a290e5b6fa199dff

See more details on using hashes here.

File details

Details for the file wakemypc-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: wakemypc-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 42.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for wakemypc-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 218db20265bb75a82143473603d839117788eed0e7a75b0e9fcbad61f396bcfd
MD5 1fdfe4e66830707871aa067e327fddad
BLAKE2b-256 cab91b12bcff66d1868d4afbf3a42226deda1dbf42b46abb8256c85437e4bea0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page