erichardson/py-eagle-mqtt
1
0
Fork 0
Code Issues 1 Pull Requests 5 Actions Packages Projects Releases 11 Wiki Activity

Adding missing credit and cleaning up variables

Browse Source
This commit is contained in:
DK
2018-09-03 10:02:59 -07:00
committed by GitHub
parent 2dcd384457
commit 69a25a1f68
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,7 +1,7 @@
# py-eagle-mqtt # py-eagle-mqtt
Python based Docker for Eagle to MQTT reader Python based Docker for Eagle to MQTT reader
I have only ported this into a dockerfile, All Original code (with one minor modification for XML root tag) is credit to I have only ported this into a dockerfile, All Original code (with one minor modification for XML root tag) is credit to [Ted Drain - TD22057](https://github.com/TD22057/T-Home).
You can run this with the following: You can run this with the following:
@@ -9,17 +9,20 @@ You can run this with the following:
``` ```
docker run --name py-eagle-mqtt -d -e "MQTT_BROKER_IP=" -e "MQTT_BROKER_PORT=" evanrich/py-eagle-mqtt docker run --name py-eagle-mqtt -d -e "MQTT_BROKER_IP=" -e "MQTT_BROKER_PORT=" evanrich/py-eagle-mqtt
``` ```
## Environment variables (settings)
**MQTT_BROKER_IP** = your broker's IP address. Defaults to 192.168.1.20 (my local k8s node) **MQTT_BROKER_IP** = your broker's IP address. Defaults to 192.168.1.20 (my local k8s node)
**MQTT_BROKER_PORT** = your broker's port #. Defaults to 1883 (used in my k8s) **MQTT_BROKER_PORT** = your broker's port #. Defaults to 1883 (used in my k8s)
Optionally, you can add the following: Optionally, you can add the following:
**"KEEPALVE="** Sets the keepalive for MQTT, defaults to 60 seconds if not specificed **KEEPALVE** Sets the keepalive for MQTT, defaults to 60 seconds if not specificed
**"MQTT_USER="** Sets the MQTT user, if using authentication. Defaults to "None". Don't specify if not using authentication. **MQTT_USER** Sets the MQTT user, if using authentication. Defaults to "None". Don't specify if not using authentication.
**"MQTT_PASS="** Sets the MQTT pasword if using authentication. Defaults to "None". Don't specify if not using authentication. **MQTT_PASS** Sets the MQTT pasword if using authentication. Defaults to "None". Don't specify if not using authentication.
snippet from my MQTT Broker showing container connecting and dissconnecting when I start/stop it: snippet from my MQTT Broker showing container connecting and dissconnecting when I start/stop it:
@@ -36,6 +39,8 @@ snippet from my MQTT Broker showing container connecting and dissconnecting when
4. Push to the branch: `git push origin my-new-feature` 4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D 5. Submit a pull request :D
Original Readme as follows from creator, Ted Drain. You can view the original repo this is based on here: https://github.com/TD22057/T-Home Original Readme as follows from creator, Ted Drain. You can view the original repo this is based on here: https://github.com/TD22057/T-Home
--- ---