Metadata-Version: 2.1
Name: esp-serial-find
Version: 0.2.0
Summary: Find the ESP32 serial port name with device serial number on macOS.
Home-page: https://github.com/ProfFan/esp-serial-find
License: MIT
Author: Fan Jiang
Author-email: pypi@fanjiang.me
Requires-Python: >=3.6.2,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: black (>=22.3.0,<23.0.0) ; extra == "test"
Requires-Dist: bump2version (>=1.0.1,<2.0.0) ; extra == "dev"
Requires-Dist: flake8 (>=3.9.2,<4.0.0) ; extra == "test"
Requires-Dist: flake8-docstrings (>=1.6.0,<2.0.0) ; extra == "test"
Requires-Dist: isort (>=5.8.0,<6.0.0) ; extra == "test"
Requires-Dist: mkdocs (>=1.1.2,<2.0.0) ; extra == "doc"
Requires-Dist: mkdocs-autorefs (>=0.2.1,<0.3.0) ; extra == "doc"
Requires-Dist: mkdocs-include-markdown-plugin (>=1.0.0,<2.0.0) ; extra == "doc"
Requires-Dist: mkdocs-material (>=6.1.7,<7.0.0) ; extra == "doc"
Requires-Dist: mkdocs-material-extensions (>=1.0.1,<2.0.0)
Requires-Dist: mkdocstrings (>=0.15.2,<0.16.0) ; extra == "doc"
Requires-Dist: mypy (>=0.900,<0.901) ; extra == "test"
Requires-Dist: pip (>=20.3.1,<21.0.0) ; extra == "dev"
Requires-Dist: pre-commit (>=2.12.0,<3.0.0) ; extra == "dev"
Requires-Dist: pytest (>=6.2.4,<7.0.0) ; extra == "test"
Requires-Dist: pytest-cov (>=2.12.0,<3.0.0) ; extra == "test"
Requires-Dist: toml (>=0.10.2,<0.11.0) ; extra == "dev"
Requires-Dist: tox (>=3.20.1,<4.0.0) ; extra == "dev"
Requires-Dist: twine (>=3.3.0,<4.0.0) ; extra == "dev"
Requires-Dist: virtualenv (>=20.2.2,<21.0.0) ; extra == "dev"
Description-Content-Type: text/markdown

# ESP Serial Find


[![pypi](https://img.shields.io/pypi/v/esp-serial-find.svg)](https://pypi.org/project/esp-serial-find/)
[![python](https://img.shields.io/pypi/pyversions/esp-serial-find.svg)](https://pypi.org/project/esp-serial-find/)
[![Build Status](https://github.com/ProfFan/esp-serial-find/actions/workflows/dev.yml/badge.svg)](https://github.com/ProfFan/esp-serial-find/actions/workflows/dev.yml)
[![codecov](https://codecov.io/gh/ProfFan/esp-serial-find/branch/main/graphs/badge.svg)](https://codecov.io/github/ProfFan/esp-serial-find)



Find the ESP32 serial port name with device serial number on macOS


* Documentation: <https://ProfFan.github.io/esp-serial-find>
* GitHub: <https://github.com/ProfFan/esp-serial-find>
* PyPI: <https://pypi.org/project/esp-serial-find/>
* Free software: MIT


## Features

* Find the ESP32 serial port name with device serial number on macOS
* `-s` option to print the path for the given serial number
* `-v` option to print verbose output
* Without any option: print all serial ports and their serial numbers

```bash
usage: esp-serial-find [-h] [--verbose] [--serial SERIAL]

options:
  -h, --help            show this help message and exit
  --verbose, -v         Print verbose output
  --serial SERIAL, -s SERIAL
                        Print the path for the given serial number
```

## Example

### Print all serial ports and their serial numbers

```bash
$ esp-serial-find
70:ee:50:1c:1b:0c /dev/cu.usbserial-0001
70:ee:50:1c:1b:0d /dev/cu.usbserial-0002
70:ee:50:1c:1b:0e /dev/cu.usbserial-0003
```

### Print the path for the given serial number

```bash
$ esp-serial-find -s 70:ee:50:1c:1b:0c
/dev/cu.usbserial-0001
```

## Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [waynerv/cookiecutter-pypackage](https://github.com/waynerv/cookiecutter-pypackage) project template.

