Giter Site home page Giter Site logo

unifi2mqtt's Introduction

unifi2mqtt

mqtt-smarthome NPM version dependencies Status Build Status XO code style License

Connect Ubiquiti UniFi controller to MQTT ๐Ÿ“ก

Install

$ sudo npm install -g unifi2mqtt

I suggest to use pm2 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.

Topics published by unifi2mqtt

  • <name>/status/wifi/<ssid>/client/<hostname> - {"val":true} if client is connected to the wifi network, {"val":false} otherwise. Object also contains the properties mac and ts. Retained.
  • <name>/status/wifi/<ssid>/event/connected - Client connect event. Payload as above. Not retained.
  • <name>/status/wifi/<ssid>/event/disconnected - Client disconnect event. Payload as above. Not retained.
  • <name>/status/wifi/<ssid>/clientCount - number of clients in specific wifi network, e.g. {"val":5}. Retained.
  • <name>/status/wifi/<ssid>/enabled - wifi enabled status, e.g. {"val":true}. Retained.
  • <name>/status/clientCount - number of clients in all wifi networks, e.g. {"val":12}. Retained.
  • <name>/status/device/<device>/led - status of a device led, e.g. {"val":"on"} Retained.
  • <name>/connected - 1 if connected to mqtt broker, 2 if connected to UniFi Controller, 0 on last will. Retained.

Topics subscribed by unifi2mqtt

  • <name>/set/device/<device>/led - switch device led on or off. Payload on, off or default (default uses site-wide led setting).
  • <name>/set/wifi/<ssid>/enabled - enable/disable wireless network. Payload true or false.

License

MIT ยฉ Sebastian Raff

unifi2mqtt's People

Contributors

hobbyquaker avatar dersimn avatar mach327 avatar

Stargazers

Bennett Kanuka avatar

Watchers

James Cloos avatar

Forkers

chrislwade

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.