Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@switchbot/homebridge-switchbot

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@switchbot/homebridge-switchbot

The SwitchBot plugin allows you to access your SwitchBot device(s) from HomeKit.

3.7.0
Source
npm

Version published: 4 months ago

Weekly downloads: 695; decreased by-74.46%

Maintainers: 0

Weekly downloads

Created: 3 years ago

Source

@switchbot/homebridge-switchbot

The Homebridge SwitchBot plugin allows you to access your SwitchBot Device(s) from HomeKit with Homebridge.

Installation

Search for "SwitchBot" on the plugin screen of Homebridge Config UI X
Find: @switchbot/homebridge-switchbot
- See noble prerequisites for your OS. (This is used for BLE connection.)
Click Install

Configuration

If using OpenAPI Connection
1. Download SwitchBot App on App Store or Google Play Store
2. Register a SwitchBot account and log in into your account
3. Generate an Token within the App
  - Click Bottom Profile Tab
  - Click Preference
  - Click App version 10 Times, this will enable Developer Options
  - Click Developer Options
  - Click Copy token to Clipboard
4. Input your token into the config parameter
5. Generate an Secret within the App
  - Click Bottom Profile Tab
  - Click Preference
  - Click App version 10 Times, this will enable Developer Options
  - Click Developer Options
  - Click Copy secret to Clipboard
6. Input your secret into the config parameter
If using BLE Connection
1. Download SwitchBot App on App Store or Google Play Store
2. Register a SwitchBot account and log in into your account
3. Click on Device wanting to connect too plugin
  - Click the Settings Gear
  - Click Device Info
  - Copy BLE Mac aka deviceId
4. Input your deviceId into the Device Config

Troubleshooting

If using Linux / Raspberry Pi OS
1. bluetoothctl must be installed on the device, otherwise it cannot communicate via Bluetooth. Enable it with sudo bluetoothctl power on.
2. If errors occur, while enabling it, restart the process:
  - rfkill block bluetooth
  - rfkill unblock bluetooth
3. Also make sure, that the computer can discover the SwitchBot device:
  - sudo bluetoothctl
  - scan on
  This lists all discovered Bluetooth devices. The BLE address of the SwitchBot device should be included in this list, otherwise your computer does not discover it.

Supported SwitchBot Devices

SwitchBot Humidifier
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
  - Can Push Updates over OpenAPI
  - Can Receive Updates over BLE and OpenAPI
SwitchBot Meter
SwitchBot Meter Plus (US)
SwitchBot Meter Plus (JP)
SwitchBot Indoor/Outdoor Thermo-Hygrometer
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
- If using Bluetooth Low Energy (BLE) only:
  - Must supply deviceId & deviceName to Device Config
  - Check Enable Bluetooth Low Energy (BLE) Connection on Device Config
SwitchBot Motion Sensor
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
- If using Bluetooth Low Energy (BLE) only:
  - Must supply deviceId & deviceName to Device Config
  - Check Enable Bluetooth Low Energy (BLE) Connection on Device Config
SwitchBot Contact Sensor
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
- If using Bluetooth Low Energy (BLE) only:
  - Must supply deviceId & deviceName to Device Config
  - Check Enable Bluetooth Low Energy (BLE) Connection on Device Config
SwitchBot Curtain
SwitchBot Curtain 3
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
- If using Bluetooth Low Energy (BLE) only:
  - Must supply deviceId & deviceName to Device Config
  - Check Enable Bluetooth Low Energy (BLE) Connection on Device Config
SwitchBot Blind Tilt
- Supports OpenAPI & partial Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
SwitchBot Bulb
SwitchBot Ceiling Light
SwitchBot Ceiling Light Pro
SwitchBot Light Strip
- Supports OpenAPI & partial Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
SwitchBot Lock
SwitchBot Lock Pro
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
US: SwitchBot Mini Robot Vacuum K10+
US: SwitchBot Floor Cleaning Robot S10
JP: SwitchBot Robot Vacuum Cleaner S1
JP: SwitchBot Robot Vacuum Cleaner S1 Plus
- Supports OpenAPI Connection Only
SwitchBot Plug
SwitchBot Plug Mini (US)
SwitchBot Plug Mini (JP)
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
SwitchBot Bot
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
- If using OpenAPI:
  - SwitchBot Hub Mini or SwitchBot Hub 2 Required
  - Enable Cloud Services for Device on SwitchBot App
  - You must set your Bot's Device ID for either Press Mode or Switch Mode in Plugin Config (SwitchBot Device Settings > Bot Settings)
    - Press Mode - Turns on then instantly turn it off
    - Switch Mode - Turns on and keep it on until it is turned off
      - This can get out of sync, since API doesn't give me a status
      - To Correct you must go into the SwitchBot App and correct the status of either On or Off
- If using Bluetooth Low Energy (BLE) only:
  - Must supply deviceId & deviceName to Device Config
  - Check Enable Bluetooth Low Energy (BLE) Connection on Device Config
SwitchBot Hub 2
- Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
  - Enables Humidity, Temperature, and Light Sensor
SwitchBot Battery Circulator Fan
- Supports OpenAPI Connection Only
SwitchBot Water Leak Detector
- Supports OpenAPI Connection Only

Supported IR Devices

(All IR Devices require SwitchBot Hub 2 or Hub Mini)

TV
- Allows for On/Off and Volume Controls
- Optional Disable Sending Power Command
Projector (Displayed as TV)
- Allows for On/Off and Volume Controls
Set Top Box (Displayed as Set Top Box)
- Allows for On/Off and Volume Controls
DVD (Displayed as Set Top Box)
- Allows for On/Off and Volume Controls
Streamer (Displayed as Streaming Stick)
- Allows for On/Off and Volume Controls
Speaker (Displayed as Speaker)
- Allows for On/Off and Volume Controls
Fans
- Allows for On/Off Controls
- Optional Rotation Speed
- Optional Swing Mode
Lights
- Allows for On/Off Controls
Air Purifiers
- Allows for On/Off Controls
Air Conditioners
- Allows for On/Off, Tempeture, and Mode Controls
- Optional Disable Auto Mode
Cameras
- Allows for On/Off Controls
Vacuum Cleaners
- Allows for On/Off Controls
Water Heaters
- Allows for On/Off Controls
Others
- Option to Display as differenet Device Type
  - Supports Fan Device Type
- Allows for On/Off Controls

SwitchBot APIs

Community

3.7.0 (2024-07-21)

What's Changed

Add Platform BLE Scanning
- Enable by setting Enable BLE Scanning setting under Advanced Settings.
- Will update devices as data is received.
Fix Bot and Other On issues.
Remove repetitive logging #1001, Thanks @dnicolson
Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.6.0...v3.7.0

Keywords

FAQs

What is @switchbot/homebridge-switchbot?

Is @switchbot/homebridge-switchbot popular?

Is @switchbot/homebridge-switchbot well maintained?

Package last updated on 21 Jul 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@switchbot/homebridge-switchbot

@switchbot/homebridge-switchbot

Installation

Configuration

If using OpenAPI Connection

If using BLE Connection

Troubleshooting

If using Linux / Raspberry Pi OS

Supported SwitchBot Devices

Supported IR Devices

(All IR Devices require SwitchBot Hub 2 or Hub Mini)

SwitchBot APIs

Community

3.7.0 (2024-07-21)

What's Changed

Keywords

Related posts

RubyGems.org Adds New Maintainer Role

Node.js Implements Stricter Policies for Semver-Major Pull Requests Ahead of Release Deadlines