Metadata-Version: 2.4
Name: wakemypc
Version: 1.0.4
Summary: Companion CLI for wakemypc.com -- flash, provision, and manage Pico W transmitters from your terminal
Author: wakemypc.com contributors
License: PolyForm Noncommercial License 1.0.0
        
        <https://polyformproject.org/licenses/noncommercial/1.0.0>
        
        ## Acceptance
        
        In order to get any license under these terms, you must agree
        to them as both strict obligations and conditions to all
        your licenses.
        
        ## Copyright License
        
        The licensor grants you a copyright license for the
        software to do everything you might do with the software
        that would otherwise infringe the licensor's copyright
        in it for any permitted purpose.  However, you may
        only distribute the software according to [Distribution
        License](#distribution-license) and make changes or new works
        based on the software according to [Changes and New Works
        License](#changes-and-new-works-license).
        
        ## Distribution License
        
        The licensor grants you an additional copyright license
        to distribute copies of the software.  Your license
        to distribute covers distributing the software with
        changes and new works permitted by [Changes and New Works
        License](#changes-and-new-works-license).
        
        ## Notices
        
        You must ensure that anyone who gets a copy of any part of
        the software from you also gets a copy of these terms or the
        URL for them above, as well as copies of any plain-text lines
        beginning with `Required Notice:` that the licensor provided
        with the software.  For example:
        
        > Required Notice: Copyright 2026 wakemypc.com contributors
        
        ## Changes and New Works License
        
        The licensor grants you an additional copyright license to
        make changes and new works based on the software for any
        permitted purpose.
        
        ## Patent License
        
        The licensor grants you a patent license for the software that
        covers patent claims the licensor can license, or becomes able
        to license, that you would infringe by using the software.
        
        ## Noncommercial Purposes
        
        Any noncommercial purpose is a permitted purpose.
        
        ## Personal Uses
        
        Personal use for research, experiment, and testing for
        the benefit of public knowledge, personal study, private
        entertainment, hobby projects, amateur pursuits, or religious
        observance, without any anticipated commercial application,
        is use for a permitted purpose.
        
        ## Noncommercial Organizations
        
        Use by any charitable organization, educational institution,
        public research organization, public safety or health
        organization, environmental protection organization,
        or government institution is use for a permitted purpose
        regardless of the source of funding or obligations resulting
        from the funding.
        
        ## Fair Use
        
        You may have "fair use" rights for the software under the
        law. These terms do not limit them.
        
        ## No Other Rights
        
        These terms do not allow you to sublicense or transfer any of
        your licenses to anyone else, or prevent the licensor from
        granting licenses to anyone else.  These terms do not imply
        any other licenses.
        
        ## Patent Defense
        
        If you make any written claim that the software infringes or
        contributes to infringement of any patent, your patent license
        for the software granted under these terms ends immediately. If
        your company makes such a claim, your patent license ends
        immediately for work on behalf of your company.
        
        ## Violations
        
        The first time you are notified in writing that you have
        violated any of these terms, or done anything with the software
        not covered by your licenses, your licenses can nonetheless
        continue if you come into full compliance with these terms,
        and take practical steps to correct past violations, within
        32 days of receiving notice.  Otherwise, all your licenses
        end immediately.
        
        ## No Liability
        
        ***As far as the law allows, the software comes as is, without
        any warranty or condition, and the licensor will not be liable
        to you for any damages arising out of these terms or the use
        or nature of the software, under any kind of legal claim.***
        
        ## Definitions
        
        The **licensor** is the individual or entity offering these
        terms, and the **software** is the software the licensor makes
        available under these terms.
        
        **You** refers to the individual or entity agreeing to these
        terms.
        
        **Your company** is any legal entity, sole proprietorship,
        or other kind of organization that you work for, plus all
        organizations that have control over, are under the control of,
        or are under common control with that organization.  **Control**
        means ownership of substantially all the assets of an entity,
        or the power to direct its management and policies by vote,
        contract, or otherwise.  Control can be direct or indirect.
        
        **Your licenses** are all the licenses granted to you for the
        software under these terms.
        
        **Use** means anything you do with the software requiring one
        of your licenses.
        
Project-URL: Homepage, https://wakemypc.com
Project-URL: Repository, https://github.com/vipulksh/wakemypc-cli
Project-URL: Issues, https://github.com/vipulksh/wakemypc-cli/issues
Keywords: wake-on-lan,wakemypc,raspberry-pi-pico,iot,homelab
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Hardware
Classifier: Topic :: System :: Networking
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0
Requires-Dist: pyserial>=3.5
Requires-Dist: requests>=2.28
Requires-Dist: mpremote>=1.22
Dynamic: license-file

# wakemypc

Companion CLI for [wakemypc.com](https://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):

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

Verify:

```bash
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`:

```bash
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:

```bash
# 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:

```bash
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](LICENSE).

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.
