Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stjohnjohnson/smartthings-mqtt-bridge
Bridge between SmartThings and MQTT
https://github.com/stjohnjohnson/smartthings-mqtt-bridge
Last synced: about 19 hours ago
JSON representation
Bridge between SmartThings and MQTT
- Host: GitHub
- URL: https://github.com/stjohnjohnson/smartthings-mqtt-bridge
- Owner: stjohnjohnson
- License: mit
- Created: 2016-01-26T15:36:25.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-06-20T06:34:24.000Z (over 3 years ago)
- Last Synced: 2024-11-14T09:43:33.769Z (2 days ago)
- Language: Groovy
- Homepage: https://hub.docker.com/r/stjohnjohnson/smartthings-mqtt-bridge/
- Size: 99.6 KB
- Stars: 366
- Watchers: 49
- Forks: 243
- Open Issues: 108
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SmartThings MQTT Bridge
***System to share and control SmartThings device states in MQTT.***
[](https://github.com/stjohnjohnson/smartthings-mqtt-bridge/releases)
[](https://hub.docker.com/r/stjohnjohnson/smartthings-mqtt-bridge/)
[](https://hub.docker.com/r/stjohnjohnson/smartthings-mqtt-bridge/)
[](https://app.wercker.com/project/bykey/f2df197ea40f89b7eda771e67b4a4e1e)
[](https://gitter.im/stjohnjohnson/smartthings-mqtt-bridge?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](#donate)
This project was spawned by the desire to [control SmartThings from within Home Assistant][ha-issue]. Since Home Assistant already supports MQTT, we chose to go and build a bridge between SmartThings and MQTT.
# Architecture
# MQTT Events
Events about a device (power, level, switch) are sent to MQTT using the following format:
```
{PREFACE}/{DEVICE_NAME}/${ATTRIBUTE}
```
__PREFACE is defined as "smartthings" by default in your configuration__
For example, my Dimmer Z-Wave Lamp is called "Fireplace Lights" in SmartThings. The following topics are published:
```
# Brightness (0-99)
smartthings/Fireplace Lights/level
# Switch State (on|off)
smartthings/Fireplace Lights/switch
```
The Bridge also subscribes to changes in these topics, so that you can update the device via MQTT.
```
$ mqtt pub -t 'smartthings/Fireplace Lights/switch' -m 'off'
# Light goes off in SmartThings
```
# Configuration
The bridge has one yaml file for configuration:
```
---
mqtt:
# Specify your MQTT Broker URL here
host: mqtt://localhost
# Example from CloudMQTT
# host: mqtt:///m10.cloudmqtt.com:19427
# Preface for the topics $PREFACE/$DEVICE_NAME/$PROPERTY
preface: smartthings
# The write and read suffixes need to be different to be able to differentiate when state comes from SmartThings or when its coming from the physical device/application
# Suffix for the topics that receive state from SmartThings $PREFACE/$DEVICE_NAME/$PROPERTY/$STATE_READ_SUFFIX
# Your physical device or application should subscribe to this topic to get updated status from SmartThings
# state_read_suffix: state
# Suffix for the topics to send state back to SmartThings $PREFACE/$DEVICE_NAME/$PROPERTY/$STATE_WRITE_SUFFIX
# your physical device or application should write to this topic to update the state of SmartThings devices that support setStatus
# state_write_suffix: set_state
# Suffix for the command topics $PREFACE/$DEVICE_NAME/$PROPERTY/$COMMAND_SUFFIX
# command_suffix: cmd
# Other optional settings from https://www.npmjs.com/package/mqtt#mqttclientstreambuilder-options
# username: AzureDiamond
# password: hunter2
# MQTT retains state changes be default, retain mode can be disabled:
# retain: false
# Port number to listen on
port: 8080
```
# Installation
There are two ways to use this, Docker (self-contained) or NPM (can run on Raspberry Pi).
## Docker
Docker will automatically download the image, but you can "install" it or "update" it via `docker pull`:
```
$ docker pull stjohnjohnson/smartthings-mqtt-bridge
```
To run it (using `/opt/mqtt-bridge` as your config directory and `8080` as the port):
```
$ docker run \
-d \
--name="mqtt-bridge" \
-v /opt/mqtt-bridge:/config \
-p 8080:8080 \
stjohnjohnson/smartthings-mqtt-bridge
```
To restart it:
```
$ docker restart mqtt-bridge
```
## NPM
To install the module, just use `npm`:
```
$ npm install -g smartthings-mqtt-bridge
```
If you want to run it, you can simply call the binary:
```
$ smartthings-mqtt-bridge
Starting SmartThings MQTT Bridge - v1.1.3
Loading configuration
No previous configuration found, creating one
```
Although we recommend using a process manager like [PM2][pm2]:
```
$ pm2 start smartthings-mqtt-bridge
[PM2] Starting smartthings-mqtt-bridge in fork_mode (1 instance)
[PM2] Done.
┌─────────────────────────┬────┬──────┬───────┬────────┬─────────┬────────┬────────────┬──────────┐
│ App name │ id │ mode │ pid │ status │ restart │ uptime │ memory │ watching │
├─────────────────────────┼────┼──────┼───────┼────────┼─────────┼────────┼────────────┼──────────┤
│ smartthings-mqtt-bridge │ 1 │ fork │ 20715 │ online │ 0 │ 0s │ 7.523 MB │ disabled │
└─────────────────────────┴────┴──────┴───────┴────────┴─────────┴────────┴────────────┴──────────┘
$ pm2 logs smartthings-mqtt-bridge
smartthings-mqtt-bridge-1 (out): info: Starting SmartThings MQTT Bridge - v1.1.3
smartthings-mqtt-bridge-1 (out): info: Loading configuration
smartthings-mqtt-bridge-1 (out): info: No previous configuration found, creating one
$ pm2 restart smartthings-mqtt-bridge
```
## Usage
1. Customize the MQTT host
```
$ vi config.yml
# Restart the service to get the latest changes
```
2. Install the [Device Handler][dt] in the [Device Handler IDE][ide-dt] using "Create via code"
3. Add the "MQTT Device" device in the [My Devices IDE][ide-mydev]. Enter MQTT Device (or whatever) for the name. Select "MQTT Bridge" for the type. The other values are up to you.
4. Configure the "MQTT Device" in the [My Devices IDE][ide-mydev] with the IP Address, Port, and MAC Address of the machine running the Docker container
4. Install the [Smart App][app] on the [Smart App IDE][ide-app] using "Create via code"
5. Configure the Smart App (via the Native App; on Android, this must be the Classic version) with the devices you want to share and the Device Handler you just installed as the bridge
6. Via the Native App, select your MQTT device and watch as MQTT is populated with events from your devices
## Advanced
### Docker Compose
If you want to bundle everything together, you can use [Docker Compose][docker-compose].
Just create a file called `docker-compose.yml` with this contents:
```yaml
mqtt:
image: matteocollina/mosca
ports:
- 1883:1883
mqttbridge:
image: stjohnjohnson/smartthings-mqtt-bridge
volumes:
- ./mqtt-bridge:/config
ports:
- 8080:8080
links:
- mqtt
homeassistant:
image: balloob/home-assistant
ports:
- 80:80
volumes:
- ./home-assistant:/config
- /etc/localtime:/etc/localtime:ro
links:
- mqtt
```
This creates a directory called `./mqtt-bridge/` to store configuration for the bridge. It also creates a directory `./home-assistant` to store configuration for HA.
## Donate
If you use and love our bridge tool, please consider buying us a coffee by sending some Satoshi to `1sBPcBai7gZco6LipPthuyZ5rH4RKx1Bg`.
[](https://coinbase.com/stjohn)
[dt]: https://github.com/stjohnjohnson/smartthings-mqtt-bridge/blob/master/devicetypes/stj/mqtt-bridge.src/mqtt-bridge.groovy
[app]: https://github.com/stjohnjohnson/smartthings-mqtt-bridge/blob/master/smartapps/stj/mqtt-bridge.src/mqtt-bridge.groovy
[ide-dt]: https://graph.api.smartthings.com/ide/devices
[ide-mydev]: https://graph.api.smartthings.com/device/list
[ide-app]: https://graph.api.smartthings.com/ide/apps
[ha-issue]: https://github.com/balloob/home-assistant/issues/604
[docker-compose]: https://docs.docker.com/compose/
[pm2]: http://pm2.keymetrics.io/