Git Product home page Git Product logo

homebridge-mqttthing's Introduction

npm npm Discord verified-by-homebridge

Homebridge MQTT-Thing

Homebridge MQTT-Thing is a plugin for Homebridge allowing the integration of many different accessory types using MQTT.

Compatibility with previous versions

From version 1.1.x, raw JavaScript values for Boolean properties are passed to MQTT apply functions. This may change published message formats, e.g. when apply functions are used to build JSON strings.

For full details of changes please see the Release notes.

Installation

Follow the instructions in homebridge for the homebridge server installation. This plugin is published through NPM and should be installed "globally" by typing:

npm install -g homebridge-mqttthing

Installation through Homebridge Config UI X is also supported (and recommended).

Configuration

Configure the plugin in your homebridge config.json file. Most configuration settings can now also be entered using Homebridge Config UI X.

MQTT topics used fall into two categories:

  • Control topics, of the form setXXX, are published by MQTT-Thing in order to control device state (e.g. to turn on a light).
  • Status/notification topics, of the form getXXX, are published by the device to notify MQTT-Thing that something has occurred (e.g. that a sensor has detected something or a control topic action has been performed).

For further details, see docs/Configuration.md and docs/Codecs.md.

Supported Accessories

The following Homekit accessory types are supported by MQTT-Thing:

Tested Configurations

Tested and working configurations for devices are available on the Wiki. Please add your working configurations for others.

homebridge-mqttthing's People

Contributors

arachnetech avatar brd avatar cbpowell avatar christiantreutler-avi avatar dependabot[bot] avatar donavanbecker avatar harkal avatar mattkirman avatar mkke avatar mlamby avatar nicoh88 avatar nitej avatar njh avatar northernman54 avatar perote2000 avatar rbswift avatar sieren avatar taligentx avatar tasict avatar tobekas avatar

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.