Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hobbyquaker/unifi2mqtt
Connect Ubiquiti UniFi controller to MQTT :satellite:
https://github.com/hobbyquaker/unifi2mqtt
client mqtt smarthome ubiquiti unifi wifi
Last synced: about 2 months ago
JSON representation
Connect Ubiquiti UniFi controller to MQTT :satellite:
- Host: GitHub
- URL: https://github.com/hobbyquaker/unifi2mqtt
- Owner: hobbyquaker
- License: mit
- Created: 2018-01-26T16:20:21.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-07T23:16:30.000Z (over 4 years ago)
- Last Synced: 2024-04-14T06:29:27.719Z (9 months ago)
- Topics: client, mqtt, smarthome, ubiquiti, unifi, wifi
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 72
- Watchers: 14
- Forks: 27
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# unifi2mqtt
[](https://github.com/mqtt-smarthome/mqtt-smarthome)
[](http://badge.fury.io/js/unifi2mqtt)
[](https://david-dm.org/hobbyquaker/unifi2mqtt)
[](https://travis-ci.org/hobbyquaker/unifi2mqtt)
[](https://github.com/sindresorhus/xo)
[![License][mit-badge]][mit-url]
> Connect Ubiquiti UniFi controller to MQTT 📡
### Install
`$ sudo npm install -g unifi2mqtt`
I suggest to use [pm2](http://pm2.keymetrics.io/) to manage the unifi2mqtt process (start on system boot, manage log
files, ...)
### Usage
```
Usage: unifi2mqtt [options]
Options:
-a, --unifi-host unifi hostname or address [default: "127.0.0.1"]
-p, --unifi-port unifi port [default: 8443]
-c, --unifi-user unifi user [default: "admin"]
-s, --unifi-password unifi password [required]
-w, --unifi-site unifi site [default: "default"]
-k, --insecure allow ssl connections without valid certificate
-v, --verbosity possible values: "error", "warn", "info", "debug"
[default: "info"]
-n, --name instance name. used as topic prefix [default: "unifi"]
-u, --url mqtt broker url [default: "mqtt://127.0.0.1"]
-h, --help Show help [boolean]
--version Show version number [boolean]
```
### Topics and Payloads
Topics and Payloads follow [mqtt-smarthome architectural proposal](https://github.com/mqtt-smarthome/mqtt-smarthome).
#### Topics published by unifi2mqtt
* `/status/wifi//client/` - `{"val":true}` if client is connected to the wifi network, `{"val":false}`
otherwise. Object also contains the properties `mac` and `ts`. Retained.
* `/status/wifi//event/connected` - Client connect event. Payload as above. Not retained.
* `/status/wifi//event/disconnected` - Client disconnect event. Payload as above. Not retained.
* `/status/wifi//clientCount` - number of clients in specific wifi network, e.g. `{"val":5}`. Retained.
* `/status/wifi//enabled` - wifi enabled status, e.g. `{"val":true}`. Retained.
* `/status/clientCount` - number of clients in all wifi networks, e.g. `{"val":12}`. Retained.
* `/status/device//led` - status of a device led, e.g. `{"val":"on"}` Retained.
* `/connected` - `1` if connected to mqtt broker, `2` if connected to UniFi Controller, `0` on last will.
Retained.
#### Topics subscribed by unifi2mqtt
* `/set/device//led` - switch device led on or off. Payload `on`, `off` or `default` (default uses
site-wide led setting).
* `/set/wifi//enabled` - enable/disable wireless network. Payload `true` or `false`.
## License
MIT © [Sebastian Raff](https://github.com/hobbyquaker)
[mit-badge]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat
[mit-url]: LICENSE