Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dewgenenny/rtl_433_discoverandsubmit

This is a simple python CLI tool to review detected devices by RTL_433 via MQTT, then give the user the option to submit chosen devices to Home Assistant via MQTT for auto discovery
https://github.com/dewgenenny/rtl_433_discoverandsubmit

Last synced: about 1 month ago
JSON representation

This is a simple python CLI tool to review detected devices by RTL_433 via MQTT, then give the user the option to submit chosen devices to Home Assistant via MQTT for auto discovery

Host: GitHub
URL: https://github.com/dewgenenny/rtl_433_discoverandsubmit
Owner: dewgenenny
License: mit
Created: 2023-11-03T19:34:56.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-06-19T22:22:44.000Z (5 months ago)
Last Synced: 2024-09-28T14:01:21.689Z (about 2 months ago)
Language: Python
Size: 213 KB
Stars: 16
Watchers: 4
Forks: 2
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 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.