Skip to main content

Companion CLI for https://wakemypc.com (WakeMyPC) -- flash, provision, and manage Pico W transmitters from your terminal. WakeMyPC is a website that lets you turn on you PC remotely from anywhere in the world using Wake-on-Lan.

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, if you want.

python -m venv .venv

Activate virtual environment.

source .venv/bin/activate #linux/MacOS
.venv\Scripts\Activate.bat #Command prompt
.\.venv\Scripts\Activate.ps1 #Powershell

Use pip to install:

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 using browser login
wakemypc register --oauth --name "My Pico"

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.2.3.tar.gz (47.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.2.3-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wakemypc-1.2.3.tar.gz
Algorithm Hash digest
SHA256 050f6a3254d189d43632e31caec9088f4713d50632d499bbb2158782f38fb967
MD5 699af0db10cc927d90a504c77f5007c1
BLAKE2b-256 0b8b86d4af9f64e89b21614bde77f059ada4ff0d2d4859b8e3a93b58567ab675

See more details on using hashes here.

Provenance

The following attestation bundles were made for wakemypc-1.2.3.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.2.3-py3-none-any.whl.

File metadata

  • Download URL: wakemypc-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 49.5 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.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1b443cc0ed273ea667a4019475a880529d45fa94e50eccb1cb76f95f905e5813
MD5 feef81ec2d8324bb45a3ae717fffd2d6
BLAKE2b-256 ccd45f100720c09e3573287ef9675460c02340f5d0122d8f3f73724d8f7a34c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for wakemypc-1.2.3-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