Metadata-Version: 2.4
Name: homeduino
Version: 0.0.24.dev1
Summary: Homeduino library
Project-URL: Homepage, https://github.com/rrooggiieerr/homeduino.py
Project-URL: Issues, https://github.com/rrooggiieerr/homeduino.py/issues
Author-email: Rogier van Staveren <rogier@batoid.com>
License: GPLv3
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Home Automation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: pyserial-asyncio-fast>=0.16
Requires-Dist: pyserial>=3.5
Requires-Dist: rfcontrolpy==0.0.12
Description-Content-Type: text/markdown

# Python library for interfacing with the RFControl Arduino library

![Python][python-shield]
[![GitHub Release][releases-shield]][releases]
[![Licence][license-shield]][license]
[![Maintainer][maintainer-shield]][maintainer]  
[![GitHub Sponsors][github-shield]][github]
[![PayPal][paypal-shield]][paypal]
[![BuyMeCoffee][buymecoffee-shield]][buymecoffee]
[![Patreon][patreon-shield]][patreon]

## Introduction

Python library for using various 433 Mhz devices and sensors with a connected Arduino with homeduino
sketch.

## Features

## Hardware

## Installation

You can install the Python Homeduino library using the Python package manager PIP:

`pip3 install homeduino`

## `homeduino` CLI

You can use the Python Homeduino library directly from the command line to listen to or send
messages.

`python3 -m homeduino <port> <receive_pin> <send_pin> listen`

`python3 -m homeduino <port> <receive_pin> <send_pin> send <protocol> <values>`

### Troubleshooting

You can add the `--debug` flag to the CLI command to get a more details on what's going on. Like so:

`python3 -m homeduino <port> <key> --debug`

## Support my work

Do you enjoy using this Python library? Then consider supporting my work using one of the following
platforms, your donation is greatly appreciated and keeps me motivated:

[![GitHub Sponsors][github-shield]][github]
[![PayPal][paypal-shield]][paypal]
[![BuyMeCoffee][buymecoffee-shield]][buymecoffee]
[![Patreon][patreon-shield]][patreon]

## Hire me

If you're in need for a freelance Python developer for your project please contact me, you can find
my email address on [my GitHub profile](https://github.com/rrooggiieerr).

[python-shield]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54
[releases]: https://github.com/rrooggiieerr/homeduino.py/releases
[releases-shield]: https://img.shields.io/github/v/release/rrooggiieerr/homeduino.py?style=for-the-badge
[license]: ./LICENSE
[license-shield]: https://img.shields.io/github/license/rrooggiieerr/homeduino.py?style=for-the-badge
[maintainer]: https://github.com/rrooggiieerr
[maintainer-shield]: https://img.shields.io/badge/MAINTAINER-%40rrooggiieerr-41BDF5?style=for-the-badge
[paypal]: https://paypal.me/seekingtheedge
[paypal-shield]: https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white
[buymecoffee]: https://www.buymeacoffee.com/rrooggiieerr
[buymecoffee-shield]: https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black
[github]: https://github.com/sponsors/rrooggiieerr
[github-shield]: https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=ea4aaa
[patreon]: https://www.patreon.com/seekingtheedge/creators
[patreon-shield]: https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white
