Metadata-Version: 2.5
Name: picopins
Version: 1.3.0
Summary: A command-line pinout for the Raspberry Pi Pico, Pico W, Pico 2 and Pico 2 W
Project-URL: GitHub, https://www.github.com/pinout-xyz/picopins
Project-URL: Homepage, https://pico.pinout.xyz
Author-email: Philip Howard <pinout@gadgetoid.com>
Maintainer-email: Philip Howard <pinout@gadgetoid.com>
License: MIT License
        
        Copyright (c) 2023 Gadgetoid (Phil Howard).
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: Pico,Raspberry
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Hardware
Requires-Python: >=3.10
Requires-Dist: rich>=13.3.5
Description-Content-Type: text/markdown

# Raspberry Pi Pico GPIO Pinout

A beautiful GPIO pinout and pin function guide for the Raspberry Pi Pico, Pico W, Pico 2 and Pico 2 W.

![Example image](https://raw.githubusercontent.com/pinout-xyz/picopins/main/example.png)

[![Build Status](https://img.shields.io/github/actions/workflow/status/pinout-xyz/picopins/build.yml?branch=main)](https://github.com/pinout-xyz/picopins/actions/workflows/build.yml)
[![PyPi Package](https://img.shields.io/pypi/v/picopins.svg)](https://pypi.python.org/pypi/picopins)
[![Python Versions](https://img.shields.io/pypi/pyversions/picopins.svg)](https://pypi.python.org/pypi/picopins)

# Usage

```
usage: picopins [--...] [--all] or {spi,i2c,uart,pwm,hstx} [--find <text>]
       --pico          - Pico, the default. Or --picow, --pico2, --pico2w
       --pins          - show physical pin numbers
       --all or {spi,i2c,uart,pwm,hstx} - pick list of interfaces to show
                         hstx is Pico 2 and Pico 2 W only
       --hide-gpio     - hide GPIO pins
       --internal      - list the pins wired to onboard hardware
       --testpads      - list the underside test pads
       --light         - melt your eyeballs
       --find "<text>" - highlight pins matching <text>
                         supports regex if you're feeling sassy!

eg:    picopins i2c                    - show GPIO and I2C labels
       picopins                        - basic GPIO pinout
       picopins --pico2w --all         - everything, for a Pico 2 W
       picopins --picow --internal     - what the Pico W wires up itself
       picopins --all --find "PWM3 A"  - highlight any "PWM3 A" labels
       picopins --all --find "PWM.* A" - highlight any PWM A channels
```

The 40-pin header is identical across all four boards, apart from HSTX on
GP12-GP19 of the RP2350 boards. What differs is the hardware wired up behind
the scenes - `--internal` and `--testpads` show it.

# Installing

* Just run `python3 -m pip install picopins`

# Acknowledgements

This project was inspired by GPIO Zero's command-line pinout - https://github.com/gpiozero/gpiozero

It somehow wasn't inspired by Raspberry Pi Spy's "picopins" which came first and solves this same problem in bash - https://www.raspberrypi-spy.co.uk/2022/12/pi-pico-pinout-display-on-the-command-line/

Like RPi Spy's picopins it started as a GitHub gist, you can find the history here - https://gist.github.com/Gadgetoid/192af85a3eb05d4a6ac1db076c4ef118/revisions

# Changelog

1.3.0
-----

* Add `--picow`, `--pico2` and `--pico2w` alongside the default `--pico`
* Add `hstx` interface for the RP2350 boards, numbered by bit
* Add `--internal` to list the pins wired to onboard hardware
* Add `--testpads` to list the underside test pads
* Draw the wireless module and relocated debug pads on the W boards

1.2.0
-----

* Add `--version`
* Make `--find GP25` and `--find LED` highlight the onboard LED
* Refactor options parsing into a class
* Pin a minimum `rich` version

1.1.0
-----

* Highlight GPIO label if `--find` matches a hidden label
* Add regex support to `--find`
* Rewrite render flow to make it less hacky
* Light mode is back! `--light`
* Move error text above usage message

1.0.1
-----

* Tidy up readme

1.0.0
-----

* Initial Release
* Ported from https://gist.github.com/Gadgetoid/192af85a3eb05d4a6ac1db076c4ef118
