rtl-433-discoverandsubmit


Namertl-433-discoverandsubmit JSON
Version 0.1.9 PyPI version JSON
download
home_page
SummaryA small command line utility to connect to an MQTT server, listen to rtl_433 events and allow a user to generate auto-discovery config for home assistant for the devices they choose
upload_time2024-02-29 18:47:47
maintainer
docs_urlNone
authorTom George
requires_python
licenseMIT
keywords rtl_433 mqtt homeassistant
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # rtl_433_discoverandsubmit

A command-line utility to connect to an MQTT server, listen to `rtl_433` events, and allow users to generate auto-discovery configurations for Home Assistant for the devices they choose.

[Link to GitHub project](https://github.com/dewgenenny/rtl_433_discoverandsubmit)

## Features
- Connects to an MQTT server.
- Listens to `rtl_433` events in real-time.
- Provides an interactive CLI to let users choose devices.
- Generates Home Assistant auto-discovery configurations for chosen devices.

[![Upload Python Package](https://github.com/dewgenenny/rtl_433_discoverandsubmit/actions/workflows/python-publish.yml/badge.svg)](https://github.com/dewgenenny/rtl_433_discoverandsubmit/actions/workflows/python-publish.yml)

Screenshot of devices listed

![img_1.png](https://github.com/dewgenenny/rtl_433_discoverandsubmit/raw/main/Screenshots/img_3.png)

Detailed device view and opportunity to add to Home Assistant
![img.png](https://github.com/dewgenenny/rtl_433_discoverandsubmit/raw/main/Screenshots/img1.png)

Device added to Home Assistant
![img_2.png](https://github.com/dewgenenny/rtl_433_discoverandsubmit/raw/main/Screenshots/img_2.png)
## Installation

You can install `rtl_433_discoverandsubmit` directly from PyPI:

```bash
pip install rtl_433_discoverandsubmit
```


##Usage

After installation, you can run the tool using:

```rtl_433_discoverandsubmit```

##Command Line Arguments

You can specify the MQTT server, username, and password (if applicable) as well as the topic via command-line arguments. More details can be found in the help documentation:

```rtl_433_discoverandsubmit --help```

##Contributing

Feedback, bug reports, and pull requests are super welcome on this project. If you face any issues, please raise them in the issue tracker.

##License

This project is licensed under the MIT License. See the LICENSE file for more details.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "rtl-433-discoverandsubmit",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "rtl_433 mqtt homeassistant",
    "author": "Tom George",
    "author_email": "tom@penberth.com",
    "download_url": "https://files.pythonhosted.org/packages/a7/58/3d4f22b80b46a613990219678eb42d4e5f2abf2f144a9210389b6791e58e/rtl_433_discoverandsubmit-0.1.9.tar.gz",
    "platform": null,
    "description": "# rtl_433_discoverandsubmit\n\nA command-line utility to connect to an MQTT server, listen to `rtl_433` events, and allow users to generate auto-discovery configurations for Home Assistant for the devices they choose.\n\n[Link to GitHub project](https://github.com/dewgenenny/rtl_433_discoverandsubmit)\n\n## Features\n- Connects to an MQTT server.\n- Listens to `rtl_433` events in real-time.\n- Provides an interactive CLI to let users choose devices.\n- Generates Home Assistant auto-discovery configurations for chosen devices.\n\n[![Upload Python Package](https://github.com/dewgenenny/rtl_433_discoverandsubmit/actions/workflows/python-publish.yml/badge.svg)](https://github.com/dewgenenny/rtl_433_discoverandsubmit/actions/workflows/python-publish.yml)\n\nScreenshot of devices listed\n\n![img_1.png](https://github.com/dewgenenny/rtl_433_discoverandsubmit/raw/main/Screenshots/img_3.png)\n\nDetailed device view and opportunity to add to Home Assistant\n![img.png](https://github.com/dewgenenny/rtl_433_discoverandsubmit/raw/main/Screenshots/img1.png)\n\nDevice added to Home Assistant\n![img_2.png](https://github.com/dewgenenny/rtl_433_discoverandsubmit/raw/main/Screenshots/img_2.png)\n## Installation\n\nYou can install `rtl_433_discoverandsubmit` directly from PyPI:\n\n```bash\npip install rtl_433_discoverandsubmit\n```\n\n\n##Usage\n\nAfter installation, you can run the tool using:\n\n```rtl_433_discoverandsubmit```\n\n##Command Line Arguments\n\nYou can specify the MQTT server, username, and password (if applicable) as well as the topic via command-line arguments. More details can be found in the help documentation:\n\n```rtl_433_discoverandsubmit --help```\n\n##Contributing\n\nFeedback, bug reports, and pull requests are super welcome on this project. If you face any issues, please raise them in the issue tracker.\n\n##License\n\nThis project is licensed under the MIT License. See the LICENSE file for more details.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A small command line utility to connect to an MQTT server, listen to rtl_433 events and allow a user to generate auto-discovery config for home assistant for the devices they choose",
    "version": "0.1.9",
    "project_urls": null,
    "split_keywords": [
        "rtl_433",
        "mqtt",
        "homeassistant"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9dfaac5d282cfb700d894a1bdc984c0222ce16922fc7151edae6bebd2ffdbe85",
                "md5": "4ca4f8ee22c1e7a2f0000729f921e434",
                "sha256": "cb6ccd32d756d14be430e83b6a432c75492f85110509b974259d7f404bceb598"
            },
            "downloads": -1,
            "filename": "rtl_433_discoverandsubmit-0.1.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4ca4f8ee22c1e7a2f0000729f921e434",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12655,
            "upload_time": "2024-02-29T18:47:31",
            "upload_time_iso_8601": "2024-02-29T18:47:31.321283Z",
            "url": "https://files.pythonhosted.org/packages/9d/fa/ac5d282cfb700d894a1bdc984c0222ce16922fc7151edae6bebd2ffdbe85/rtl_433_discoverandsubmit-0.1.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a7583d4f22b80b46a613990219678eb42d4e5f2abf2f144a9210389b6791e58e",
                "md5": "1261212469e3fa8a32e0b25b03c9951f",
                "sha256": "8695779b95bb23ec22122b9477b4bede01acaa6a1341d24374ea78c2d4718214"
            },
            "downloads": -1,
            "filename": "rtl_433_discoverandsubmit-0.1.9.tar.gz",
            "has_sig": false,
            "md5_digest": "1261212469e3fa8a32e0b25b03c9951f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10532,
            "upload_time": "2024-02-29T18:47:47",
            "upload_time_iso_8601": "2024-02-29T18:47:47.657220Z",
            "url": "https://files.pythonhosted.org/packages/a7/58/3d4f22b80b46a613990219678eb42d4e5f2abf2f144a9210389b6791e58e/rtl_433_discoverandsubmit-0.1.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-29 18:47:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "rtl-433-discoverandsubmit"
}
        
Elapsed time: 0.20390s