A useful Salt Event returner for publishing messages to MQTT or AWS IoT
Project description
mqtt_return
A useful Salt Event returner for publishing messages to MQTT or AWS IoT
Quickstart
To get started with your new project:
# Create a new venv
python3 -m venv env --prompt mqtt_return
source env/bin/activate
# On mac, you may need to upgrade pip
python -m pip install --upgrade pip
# On WSL or some flavors of linux you may need to install the `enchant`
# library in order to build the docs
sudo apt-get install -y enchant
# Install extension + test/dev/doc dependencies into your environment
python -m pip install -e .[tests,dev,docs]
# Run tests!
python -m nox -e tests-3
# skip requirements install for next time
export SKIP_REQUIREMENTS_INSTALL=1
# Build the docs, serve, and view in your web browser:
python -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)
# Run the example function
salt-call --local mqtt_return.example_function text="Happy Hacking!"
Configuration
For publishing to a standard MQTT broker
event_return: [mqtt_return]
returner.mqtt_return.output: mqtt
returner.mqtt_return.endpoint: mqtt
returner.mqtt_return.port: 1883
returner.mqtt_return.topic_prefix: "example/prefix"
For publishing to AWS IoT Core MQTT broker using boto3 and the iot-data client
event_return: [mqtt_return]
returner.mqtt_return.output: awsiot
returner.mqtt_return.endpoint: https://example.iot.amazonaws.com
returner.mqtt_return.topic_prefix: "example/prefix"
returner.mqtt_return.aws_access_key_id: "aaaaa"
returner.mqtt_return.aws_secret_access_key: "aaaaa"
Topic Re-writing
Allows you to re-write the topics with Regex and Python Substr
For example to remove the salt/
prefix from the topics:
returner.mqtt_return.topic_rewrite_regex: "salt/"
returner.mqtt_return.topic_rewrite_replace: ""
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
saltext.mqtt_return-0.1a5.tar.gz
(28.0 kB
view hashes)
Built Distribution
Close
Hashes for saltext.mqtt_return-0.1a5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54f08a20c37b82507991307962d8efe3d28e0f3db8881fcd0a9e331d8dd6473d |
|
MD5 | 2bd2d9ebf15cd971d0f9fdebfc1e680d |
|
BLAKE2b-256 | 3d8caa3686e52f3836910ad88e1b925b2f56163ef46fb680c8253f597b9945cd |
Close
Hashes for saltext.mqtt_return-0.1a5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e0b61db14a2bec436c04cef5bf094e5cfe9546b5398bb9cc47ae1a6e86b8116 |
|
MD5 | bb7c663f68ffcef1498864a56c506e3f |
|
BLAKE2b-256 | d7c0ec5a09df2d6280185cfde544c1015cae1d14fdc96b51f969091b5213b423 |