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

@joseantmazon/homebridge-switchbot

v1.0.0

Published

Link your switchbot devices to homebridge!

Downloads

15

Readme

Homebridge Switchbot Reloaded

npm version npm downloads

SwitchBot meets Homekit! This plugins uses SwitchBot's Open API to connect your devices to Homekit through Homebridge.

Installation

  1. Go to Plugins from the Homebridge web UI
  2. Find @joseantmazon/homebridge-switchbot
  3. Hit Install

Setup

You only need to set your SwitchBot keys to get started. To do so, you'll have to:

  1. Download SwitchBot App on App Store or Google Play Store and log in
  2. Generate your keys within the App
    • Click Profile on the bottom navigation menu
    • Click Preferences
    • Click App version 10 times to enable Developer Options
    • Click Developer Options
    • Input your token and secret into the configuration parameters.

Your homebridge config file would look similar to this afterwards:

{
  "platforms": [
    {
      "platform": "Homebridge Switchbot Reloaded",
      "name": "@joseantmazon/homebridge-switchbot",
      "settings": {
        "api": {
          "token": "<your-switchbot-token>",
          "secret": "<your-switchbot-secret-key>",
          "url": "https://api.switch-bot.com/v1.1"
        }
      }
    }
  ]
}

Supported devices

Supported IR devices

Bear in mind that Switchbot's API does not allow to query the status of IR devices and therefore I may only provide a best effort approach by storing the result of the most recent operation. Hence, operating infrared devices by means other than this plugin may result in an inaccurate display of information through Homebridge.

TV/DIY TV

Capabilities

  • On/Off
  • Volume controls

Air conditioner

Capabilities

  • On/Off
  • Temperature
  • Operation mode (auto, heat or cool)
  • Fan speed (auto, low, medium or high)

Overrides

  • auto operation mode can be overriden through the configuration so it behaves as heat or cool.
    • For all devices:
      {
        "platforms": [{
          "platform": "Homebridge Switchbot Reloaded",
          "name": "@joseantmazon/homebridge-switchbot",
          "settings": {
            "overrides": {
              "thermostats": {
                "all": {
                  "autoOperationMode": "heat"
                }
              }
            }
          }
        }]
      }
    • For a single device:
      {
        "platforms": [{
          "platform": "Homebridge Switchbot Reloaded",
          "name": "@joseantmazon/homebridge-switchbot",
          "settings": {
            "overrides": {
              "thermostats": {
                "<deviceId>": {
                  "autoOperationMode": "heat"
                }
              }
            }
          }
        }]
      }
    Note: single device settings override global directives

Contributing

Do you want to take part in the development? Please, head to CONTRIBUTING to get started.

Disclaimer

The motivation for this plugin was to improve @switchbot/homebridge-switchbot for my personal use case. Therefore, support for other devices is not guaranteed and it will highly depend on contributions, which are more than welcome.