Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikekap/wink-mqtt-rs
MQTT Relay for the Jailbroken Wink Hub v1, with Home Assistant MQTT autodiscovery support
https://github.com/mikekap/wink-mqtt-rs
mqtt wink
Last synced: 6 days ago
JSON representation
MQTT Relay for the Jailbroken Wink Hub v1, with Home Assistant MQTT autodiscovery support
- Host: GitHub
- URL: https://github.com/mikekap/wink-mqtt-rs
- Owner: mikekap
- License: other
- Created: 2020-08-03T07:22:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T22:44:07.000Z (almost 2 years ago)
- Last Synced: 2023-03-11T04:29:34.390Z (almost 2 years ago)
- Topics: mqtt, wink
- Language: Rust
- Homepage:
- Size: 200 KB
- Stars: 14
- Watchers: 5
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# wink-mqtt-rs
This is a rust implementation of an MQTT daemon to run on the wink hub (1, not 2). This turns your wink hub into a mqtt "radio" that can control attached devices.
This version also includes support for [home-assistant autodiscovery](https://www.home-assistant.io/docs/mqtt/discovery/) so you don't have to configure your devices by hand.
There is also a [guide for HomeSeer](https://forums.homeseer.com/forum/hs4-products/hs4-plugins/lighting-primary-technology-plug-ins-aa/mcsmqtt-michael-mcsharry-aa/1455752-hacking-the-wink-hub-v1-to-work-with-homeseer-via-mscmqtt) if you prefer that integration.
## Installation
First you need to have root on your wink hub. [This tutorial](https://www.mattcarrier.com/post/hacking-the-winkhub-part-1/) has instructions on how to root your hub. If you, like me, don't want to buy a UART->USB dongle, you can use the UART port on a Raspberry PI (since both UARTs are 3.3V). This worked for me, but I make no guarantees otherwise.
Once you have root on your hub, run the following command on your wink hub:
```bash
curl -L --cacert /etc/ssl/certs/ca-certificates.crt https://github.com/mikekap/wink-mqtt-rs/releases/latest/download/wink-mqtt-rs.tar.gz | tar -C / -zxvf - && /opt/wink-mqtt-rs/setup.sh
```
and follow the prompts!
You can configure more options by editing the `/opt/wink-mqtt-rs/config` file after installation (it's just the CLI args to the process).
## Options
```bash
wink-mqtt-rs 0.2.1
Mike Kaplinskiy
wink hub v1 mqtt bridge
USAGE:
wink-mqtt-rs [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
-v verbosity level
-V, --version Prints version information
OPTIONS:
--discovery-listen-topic
Topic to listen to in order to (re)broadcast discovery information. Only applies if
--discovery-prefix is set. [default: homeassistant/status]
-d
Prefix (applied independently of --topic-prefix) to broadcast mqtt discovery information
(see https://www.home-assistant.io/docs/mqtt/discovery/)
--http-port
If you'd like an http server, this is the port on which to start it [default: 3000]
-s
mqtt server to connect to. Should be of the form
mqtt[s]://[username:password@]host:port/[?connection_options]
-i
how frequently to check if the light changed state (e.g. via Wink or other external
means) [default: 10000]
-t
Prefix for the mqtt topic used for device status/control [default: home/wink/]
```
The default setup above will read these options from `/opt/wink-mqtt-rs/config` . You can also see this by running `cargo +nightly run`.
## Logs
If you're having issues, you can find logs at `/var/log/wink-mqtt-rs.log`. Adding `-vvv` to the config mentioned above will increase the verbosity of logs.
### MQTT Messages
If you have a topic prefix of `home/wink/`, and a device id with `1` named `Fan`:
- You can *receive* messages on `home/wink/1/status` with the contents, in json:
```json
{"On_Off": 0}
```
The keys/values match the attributes that `aprontest` reports.
- You can *send* messages on `home/wink/1/set` with the same style json blob as above to set values on the attribute.
- You can *send* messages on `home/wink/1/7/set` with a value to set for a particular attribute. Note that the attribute id here is a integer as reported by `aprontest`. Prefer the above version in code that does not listen to MQTT Discovery.
Messages on the discovery topic follow a format that works with home assistant MQTT discovery. For details, see [converter.rs](https://github.com/mikekap/wink-mqtt-rs/blob/master/src/converter.rs).
### HTTP Server
An HTTP server is started (by default on port 3000) to let you see a quick UI of what your wink sees. Visit `http://192.168.1.123:3000/` in your browser to see it (replacing `192.168.1.123` with however you reach your wink).
In addition, there's an (unstable) REST API to control the wink exposed via this server. The endpoints are:
```
# List of devices, as well as current attribute values
curl http://wink:3000/api/devices
# Set device id 2's attribute id 3 to 255.
curl http://wink:3000/api/devices/2/3 -d '{"value": 255}' -H "Content-Type: application/json"
```
## Known Issues
- Groups are not exposed.
- Does not send device details to Home Assistant, even though the data exists. PRs welcome!
- `mqtts` support is untested.
- Don't publish status if nothing changed. Easy fix, if necessary.
## Uninstalling
To uninstall, run:
```bash
/opt/wink-mqtt-rs/uninstall.sh
```
## Developing
This is a vanilla Rust project - just use cargo nightly.
### Running Locally
You can run wink-mqtt-rs locally, though obviously it won't control any lights. There's a fake implementation of aprontest for local use
that mostly just pretends whatever you do to it succeeded.
### Running on the Wink
Use `./release/build_release.sh` to build a ARM binary (requires docker). Then you can:
```bash
ssh root@wink /etc/rc.d/init.d/wink-mqtt-rs stop
scp target/armv5te-unknown-linux-musleabi/release/wink-mqtt-rs root@wink:/opt/wink-mqtt-rs/
ssh root@wink /etc/rc.d/init.d/wink-mqtt-rs start
```
## License
See LICENSE.md