https://github.com/jaycollett/gabbwireless_mqtt

Simple Docker Image to run a Python script which will fetch Gabb Wireless device details and publish to a MQTT broker.
https://github.com/jaycollett/gabbwireless_mqtt

gabb homeassistant mqtt python

Last synced: 5 days ago
JSON representation

Simple Docker Image to run a Python script which will fetch Gabb Wireless device details and publish to a MQTT broker.

• Host: GitHub
• URL: https://github.com/jaycollett/gabbwireless_mqtt
• Owner: jaycollett
• License: mit
• Created: 2025-01-02T23:42:05.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2025-01-06T15:55:30.000Z (about 1 month ago)
• Last Synced: 2025-02-06T21:08:23.272Z (6 days ago)
• Topics: gabb, homeassistant, mqtt, python
• Language: Python
• Homepage:
• Size: 152 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Gabb Wireless MQTT Publisher

[![s.io/github/v/GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/jaycollett/gabbwireless_mqtt?include_prereleases)](https://img.shields.io/github/v/release/jaycollett/gabbwireless_mqtt?include_prereleases)

[![GitHub last commit](https://img.shields.io/github/last-commit/jaycollett/gabbwireless_mqtt)](https://img.shields.io/github/last-commit/jaycollett/gabbwireless_mqtt)

[![GitHub issues](https://img.shields.io/github/issues-raw/jaycollett/gabbwireless_mqtt)](https://img.shields.io/github/issues-raw/jaycollett/gabbwireless_mqtt)

[![GitHub pull requests](https://img.shields.io/github/issues-pr/jaycollett/gabbwireless_mqtt)](https://img.shields.io/github/issues-pr/jaycollett/gabbwireless_mqtt)

[![GitHub](https://img.shields.io/github/license/jaycollett/gabbwireless_mqtt)](https://img.shields.io/github/license/jaycollett/gabbwireless_mqtt)

Simple docker image to run a Python script which will used an "undocumented" API for Gabb Wireless account holders. The script will pull down the device details and publish them to a MQTT broker as configured.

For home assistant users, the script publishes MQTT auto-discovery topics so that your Home Assistant instance will automatically pick up and include the devices and sensors. It also creates a device_tracker device for each device with the GPS coordinates and last GPS update.

None of this would be possible if it were not for this amazing repo and the incredible work done to figure out the basic API calls. [Go check it out!](https://github.com/woodsbw/gabb) Thank you @woodsbw!

**NOTE**: As @woodsbw stated on his repo, the API is not a public API, not documented, and you MUST USE AT YOUR OWN RISK. The API leveraged is owned by Smartcom and you may be running afoul of an EULA by using this, you have been warned.

**Docker cli**

    docker run \

    -dit \

    --name gabb-mqtt-publisher \

    --restart unless-stopped \

    -e GABB_USERNAME= \

    -e GABB_PASSWORD= \

    -e MQTT_BROKER= \

    -e MQTT_PORT=1883 \

    -e MQTT_USERNAME= \

    -e MQTT_PASSWORD= \

    -e REFRESH_RATE=3 \

    ghcr.io/jaycollett/gabbwireless_mqtt:latest

**Envioronment Variables ( -e )**

|Env          |Function                                                            |

|-------------|--------------------------------------------------------------------|

|GABB_USERNAME|The username you use to log into your Gabb Wireless web portal.     |

|GABB_PASSWORD|The password you use to log into your Gabb Wireless web portal.     |

|MQTT_BROKER  |Hostname or IP of your local MQTT broker.                           |

|MQTT_USERNAME|The username for the MQTT account on your broker.                   |

|MQTT_PASSWORD|The password for the MQTT account on your broker.                   |

|MQTT_PORT    |*(optional)* The port to use on your MQTT broker.                     |

|REFRESH_RATE |*(optional)* (1-4) 1: 5 min, 2: 10 min, 3: 30 min (default), 4: 1 hour|