mirror of
https://github.com/OMGeeky/flucto-heisskleber.git
synced 2026-01-06 19:49:43 +01:00
317a09972f
* Remove deprecated Makefile * Fix zmq test warning * Fix type hints in config class. * Update linting rules * Remove filter group * Update pre-commit hook * Update file test to stop creating files in current dir * Add yaml-types. * Update README
86 lines
3.6 KiB
Markdown
86 lines
3.6 KiB
Markdown
# Heisskleber
|
|
|
|
[][pypi status]
|
|
[][pypi status]
|
|
[][license]
|
|
|
|
[][read the docs]
|
|
[][tests]
|
|
[](https://codecov.io/gh/flucto-gmbh/heisskleber)
|
|
|
|
[][pre-commit]
|
|
[][ruff]
|
|
|
|
[pypi status]: https://pypi.org/project/heisskleber/
|
|
[read the docs]: https://heisskleber.readthedocs.io/
|
|
[tests]: https://github.com/flucto-gmbh/heisskleber/actions?workflow=Tests
|
|
[pre-commit]: https://github.com/pre-commit/pre-commit
|
|
[ruff]: https://astral.sh/ruff
|
|
|
|
🇩🇪Heißkleber _m_: "hot glue".
|
|
|
|
Heisskleber is a versatile library designed to seamlessly "glue" together various data producers and consumers across a multitude of protocols including zmq, mqtt, udp, serial, influxdb, and cmdline. With the ambition to extend into REST API interactions and file operations, Heisskleber offers both synchronous and asynchronous interfaces to cater to a wide range of IoT connectivity needs.
|
|
|
|
## Features
|
|
|
|
- Multiple Protocol Support: Easy integration with zmq, mqtt, udp, serial, and cmdline. Future plans include REST API and file operations.
|
|
- Custom Data Handling: Customizable "unpacker" and "packer" functions allow for the translation of any data format (e.g., ascii encoded, comma-separated messages from a serial bus) into dictionaries for easy manipulation and transmission.
|
|
- Extensible: Designed for easy extension with additional protocols and data handling functions.
|
|
|
|
## Installation
|
|
|
|
You can install _Heisskleber_ via [pip] from [PyPI]:
|
|
|
|
```console
|
|
$ pip install heisskleber
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
Here's a simple example to demonstrate how Heisskleber can be used to connect a serial input to an mqtt output:
|
|
|
|
```python
|
|
"""
|
|
A simple forwarder that takes messages from a serial device and publishes them via MQTT.
|
|
"""
|
|
import asyncio
|
|
|
|
from heisskleber.serial import SerialReceiver, SerialConf
|
|
from heisskleber.mqtt import MqttSender, MqttConf
|
|
|
|
|
|
async def main():
|
|
source = SerialSubscriber(config=SerialConf(port="/dev/ACM0", baudrate=9600))
|
|
sink = MqttPublisher(config=MqttConf(host="mqtt.example.com", port=1883, user="", password=""))
|
|
|
|
while True:
|
|
data, metadata = await source.receive()
|
|
await sink.send(data, topic="/hotglue/" + metadata.get("topic", "serial"))
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
All sources and sinks come with customizable "unpacker" and "packer" functions, making it simple to work with various data formats.
|
|
|
|
See the [documentation][read the docs] for detailed usage.
|
|
|
|
## License
|
|
|
|
Distributed under the terms of the [MIT license][license],
|
|
_Heisskleber_ is free and open source software.
|
|
|
|
## Issues
|
|
|
|
If you encounter any problems,
|
|
please [file an issue] along with a detailed description.
|
|
|
|
[pip]: https://pip.pypa.io/
|
|
[file an issue]: https://github.com/flucto-gmbh/heisskleber/issues
|
|
[pypi]: https://pypi.org/
|
|
|
|
<!-- github-only -->
|
|
|
|
[license]: https://github.com/flucto-gmbh/heisskleber/blob/main/LICENSE
|
|
[contributor guide]: https://github.com/flucto-gmbh/heisskleber/blob/main/CONTRIBUTING.md
|
|
[command-line reference]: https://heisskleber.readthedocs.io/en/latest/usage.html
|