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/vipulksh/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
dialoutgroup add on Linux). - It does not phone home. The only network calls go to the
--api-urlyou pass toregister. - 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wakemypc-1.0.4.tar.gz.
File metadata
- Download URL: wakemypc-1.0.4.tar.gz
- Upload date:
- Size: 41.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d822b88a6cf05759fc1a1422bbcf84d0395fa0f551e1b5df78cfcc9c6943e7b6
|
|
| MD5 |
1e15db9aebf35d624843d0c66d422817
|
|
| BLAKE2b-256 |
56565c0d5cbb7d324f2d17ff9b22f89233f8a356ff02a156a3ac7566de63d942
|
Provenance
The following attestation bundles were made for wakemypc-1.0.4.tar.gz:
Publisher:
publish.yml on vipulksh/wakemypc-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
wakemypc-1.0.4.tar.gz -
Subject digest:
d822b88a6cf05759fc1a1422bbcf84d0395fa0f551e1b5df78cfcc9c6943e7b6 - Sigstore transparency entry: 1396197847
- Sigstore integration time:
-
Permalink:
vipulksh/wakemypc-cli@28b8ecde2e4729aadc98ba2698f73f68e47f502d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/vipulksh
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@28b8ecde2e4729aadc98ba2698f73f68e47f502d -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file wakemypc-1.0.4-py3-none-any.whl.
File metadata
- Download URL: wakemypc-1.0.4-py3-none-any.whl
- Upload date:
- Size: 44.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
90a2902063672b4ed4adb55ed237571674b8278315f7d81b7697b08dfca97581
|
|
| MD5 |
c3f787be4a923703dd89d80c6ffcb2ee
|
|
| BLAKE2b-256 |
c079ef438204c7ff7d5b55345e66256a1f1ad32e7ed5a4469ff73daaad945e6b
|
Provenance
The following attestation bundles were made for wakemypc-1.0.4-py3-none-any.whl:
Publisher:
publish.yml on vipulksh/wakemypc-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
wakemypc-1.0.4-py3-none-any.whl -
Subject digest:
90a2902063672b4ed4adb55ed237571674b8278315f7d81b7697b08dfca97581 - Sigstore transparency entry: 1396197855
- Sigstore integration time:
-
Permalink:
vipulksh/wakemypc-cli@28b8ecde2e4729aadc98ba2698f73f68e47f502d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/vipulksh
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@28b8ecde2e4729aadc98ba2698f73f68e47f502d -
Trigger Event:
workflow_dispatch
-
Statement type: