npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

homebridge-mqttsmokesensor

v1.2.3

Published

Fetches information from Smoke Sensors over MQTT

Downloads

10

Readme

MQTT Smoke Sensor Homebridge Plug-in

This Homebridge plug-in allows you to connect to smoke sensors that can communicate over MQTT. For example, your smoke sensor might communicate over Zigbee or Z-Wave via a USB Stick connected to your Home Asistant installation. You could then have Home Assistant send the status updates over MQTT using an automation.

verified-by-homebridge

Setup MQTT broker

This Homebridge plug-in reads the data from an MQTT broker.

You need to install an MQTT broker on your machine, this can be any machine in your network, including the machine running Homebridge. Here are some instructions for popular distributions:

Raspberry Pi / Ubuntu

In short, you just need to do the following:

sudo apt-get update
sudo apt-get install -y mosquitto mosquitto-clients
sudo systemctl enable mosquitto.service

macOS

Use Homebrew

brew install mosquitto

Windows

Go to the Mosquitto Download Page and choose the right installer for your system.

Enable authentication

A quick search online will provide you with information on how to secure your installation. To help you, I've found the following links for the Raspberry Pi and Ubuntu

Plug-in Installation

Follow the homebridge installation instructions if you haven't already.

Install this plugin globally:

npm install -g homebridge-MqttSmokeSensor

Add platform to config.json, for configuration see below.

Plug-in Configuration

The plug-in needs to know where to find the MQTT broker providing the JSON data (e.g. mqtt://127.0.0.1:1883) along with the serial number of the device to uniquely identify it (you can also use your Raspberry Pi identifier).

{
  "platforms": [
    {
      "platform": "MqttSmokeSensor",
      "name": "MqttSmokeSensor",
      "mqttbroker": "mqtt://127.0.0.1:1883",
      "username": "",
      "password": "",
      "devices": [
        {
          "displayName": "My Kitchen Smoke Sensor",
          "serial": "1234567890",
          "manufacturer": "Fibaro",
          "model": "smoke",
          "smokeDetectedTopic": "ha/smokedetector/smokedetected",
          "smokeDetectedPayload": "1",
          "smokeNotDetectedTopic": "ha/smokedetector/smokedetected",
          "smokeNotDetectedPayload": "0",
          "getSmokeDetectedTopic": "ha/smokedetector/getsmokedetected",
          "lowBatteryTopic": "ha/smokedetector/batterylow",
          "lowBatteryPayload": "1",
          "normalBatteryTopic": "ha/smokedetector/batterylow",
          "normalBatteryPayload": "0",
          "getLowBatteryTopic": "ha/smokedetector/getbatterylow",
          "tamperedTopic": "ha/smokedetector/tampered",
          "tamperedPayload": "1",
          "notTamperedTopic": "ha/smokedetector/tampered",
          "notTamperedPayload": "0",
          "getTamperedTopic": "ha/smokedetector/gettampered",
          "faultTopic": "ha/smokedetector/fault",
          "faultPayload": "1",
          "noFaultTopic": "ha/smokedetector/fault",
          "noFaultPayload": "0",
          "getFaultTopic": "ha/smokedetector/getfault"
        }
      ]
    }
  ]
}

The following settings are optional:

  • username: the MQTT broker username
  • password: the MQTT broker password
  • smokeDetectedPayload: the payload of the MQTT message received on the topic. If not specified, assumes smoke has been detected.
  • smokeNotDetectedPayload: the payload of the MQTT message received on the topic. If not specified, assumes smoke has been detected
  • lowBatteryPayload: the payload of the MQTT message received on the topic. If not specified, assumes battery is low
  • normalBatteryPayload: the payload of the MQTT message received on the topic. If not specified, assumes battery is low
  • tamperedPayload: the payload of the MQTT message received on the topic. If not specified, assumes device tampered with
  • notTamperedPayload: the payload of the MQTT message received on the topic. If not specified, assumes device tampered with
  • faultPayload: the payload of the MQTT message received on the topic. If not specified, assumes device is faulty
  • noFaultPayload: the payload of the MQTT message received on the topic. If not specified, assumes device is faulty

If you have multiple smoke sensors, then you can list them all in the config giving each one a unique name, MQTT topic and serial number.