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

Update README.md

Browse Source 
Formatting
This commit is contained in:
Evan Richardson
2018-09-03 00:13:20 -07:00
committed by GitHub
parent 9c2f7ebe90
commit 4497c3278a
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -4,21 +4,22 @@ 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
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
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
```
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_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)
Optionally, you can add the following:
"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_PASS=" Sets the MQTT pasword if using authentication. Defaults to "None". Don't specify if not using authentication.
**"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_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:
@@ -27,6 +28,17 @@ snippet from my MQTT Broker showing container connecting and dissconnecting when
{"pid":1,"hostname":"mqtt-867c776494-6rc57","name":"mosca","level":30,"time":1535955905640,"msg":"closed","client":"","v":1}
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
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
---
T-Home Automation Software
==========================