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

Install

Create a virtual environment.

python -m venv .venv

Use pip:

pip install wakemypc

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 usefull when multiple pico(s) connected
wakemypc status           # read WiFi state + secrets summary over USB
wakemypc logs             # Read logs from Pico over USB serial connection 

wakemypc --help and wakemypc <subcommand> --help have the full reference.

First Setup

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 to upload latest firmware from GitHub.
wakemypc upload --github

# 3) Configure WiFi + server.
wakemypc provision --add-new-wifi --wifi-ssid HomeWiFi --wifi-pass mypassword

# 4) Register on wakemypc.com.
wakemypc register --username username --password mypassword 
# or 
# Use Token based registeration When using Goggle SignIn (Future versions will support login through browsers)
wakemypc register --token <Token> # Check

Auth Token registeration (Manual)

Register the token offline when

  • You obtained the auth token by manually registering Pico device on dashboard
wakemypc register --token <Token>

This doesn't require any username or password. The Pico will automatically communicate with the server if the Pico is registered on Transmitters on the dashboard.

Token rotation

In the event that you'd like to rotate the auth token used while authenticating with the server.

Two modes:

wakemypc register --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 support Pico Token registeration through dashboard yet. The only network calls go to the api url with username and passwordthat you pass to register.
  • It does not store your password. Login uses the JWT the api 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.1.1.tar.gz (43.5 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.1.1-py3-none-any.whl (46.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wakemypc-1.1.1.tar.gz
  • Upload date:
  • Size: 43.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wakemypc-1.1.1.tar.gz
Algorithm Hash digest
SHA256 e062a8b60114db74014c442683019646a12028d7623d5318a33335f0297516bb
MD5 d07adffcdb4e3c646b6667a3a6193308
BLAKE2b-256 2f6d6fa04a6bda3b9b8088943ccd72d1fa21ea93805ddb6381338a62dda56e06

See more details on using hashes here.

Provenance

The following attestation bundles were made for wakemypc-1.1.1.tar.gz:

Publisher: publish.yml on vipulksh/wakemypc-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: wakemypc-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 46.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wakemypc-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 600ac147c8373043efe05876c0a378896c4ee804261408ec1114a17e1315c352
MD5 45b704ff7e55d26eef4d8991c06d9166
BLAKE2b-256 9a87ea05de431b54ce78863bd4fa2207128ed7fb9dc355549fd93d2b1734cacc

See more details on using hashes here.

Provenance

The following attestation bundles were made for wakemypc-1.1.1-py3-none-any.whl:

Publisher: publish.yml on vipulksh/wakemypc-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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