Git Product home page Git Product logo

mmm-userpresencetomqtt's Introduction

MMM-UserPresenceToMQTT

MagicMirror module that publishes the internal USER_PRESENCE broadcast notification to an MQTT topic, allowing to use the mirror as an occupancy/motion sensor in a home automation setup.

Data for the USER_PRESENCE notification can be supplied by a PIR sensor module, a camera-based motion detection module, or any other source.

Installation

  1. Make sure you already have a module that publishes the USER_PRESENCE notification to other modules.
  2. Clone the repository into modules folder of your install.
  3. Run cd MMM-UserPresenceToMQTT and npm install.
  4. Add the module to your config as described below.
  5. Restart your MagicMirror.

Configuration

Place the configuration block anywhere in your modules list in config.js. The module does not render anything to the mirror.

{
    module: 'MMM-UserPresenceToMQTT',
    config: {
        mqttServer: "mqtt://mqtt.server.com:1883",
        mqttTopic: "home/magicmirror/userpresent",
        // check below for other options
    }
}

Options

Option Description
mqttServer The MQTT server to publish to, including protocol (mqtt:// or mqtts://), host/path and port.
Default value: mqtt://localhost:1883
mqttUser Username to authenticate against the MQTT server.
Default value: undefined (no auth)
mqttPassword Password to authenticate against the MQTT server.
Default value: undefined (no auth)
mqttTopic MQTT topic to publish the notifications to.
Default value: home/magicmirror/userpresent
notificationType What type of broadcast notification is listened to and published to MQTT.
Default value: USER_PRESENCE

Dependencies

  • mqtt (via npm install)

mmm-userpresencetomqtt's People

Contributors

olexs avatar renovate-bot avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

mmm-userpresencetomqtt's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

npm
package.json
  • mqtt ^4.0.0

  • Check this box to trigger a request for Renovate to run again on this repository

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.