Skip to content

OpenWonderLabs/matterbridge-switchbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Matterbridge Logo   Matterbridge SwitchBot Plugin

npm version npm downloads Node.js CI styled with prettier linted with eslint TypeScript

powered by powered by

A Matterbridge plugin that connects SwitchBot Cloud and BLE devices to the Matter smart home ecosystem using the node-switchbot module.

Features

  • SwitchBot Cloud integration via the SwitchBot OpenAPI (token + secret required).
  • SwitchBot BLE integration for local Bluetooth Low Energy device discovery.
  • Supports a wide range of SwitchBot device types mapped to Matter device types:
SwitchBot Device Matter Device Type
Bot On/Off Switch
Plug / Plug Mini On/Off Outlet
Color Bulb / Strip Light Extended Color Light
Ceiling Light / Ceiling Light Pro On/Off Light
Meter / Meter Plus / Hub 2 Temperature + Humidity Sensor
Curtain / Curtain3 / Blind Tilt Window Covering (Cover)
Contact Sensor Contact Sensor
Motion Sensor / Presence Sensor Occupancy Sensor
Lock / Smart Lock Pro / Smart Lock Ultra Door Lock
Robot Vacuum Cleaner S1 / S1 Plus / S10 / K10+ / K10+ Pro / WoSweeper Robotic Vacuum Cleaner

Installation

npm install -g matterbridge-switchbot
matterbridge -add matterbridge-switchbot

Configuration

Edit the plugin configuration in the Matterbridge frontend or directly in matterbridge-switchbot.config.json:

{
  "name": "matterbridge-switchbot",
  "type": "DynamicPlatform",
  "token": "YOUR_SWITCHBOT_API_TOKEN",
  "secret": "YOUR_SWITCHBOT_API_SECRET",
  "enableBLE": false,
  "whiteList": [],
  "blackList": [],
  "debug": false,
  "unregisterOnShutdown": false
}

Obtaining Your API Token and Secret

  1. Open the SwitchBot app on your phone.
  2. Go to ProfilePreferences.
  3. Tap the app version number 10 times to reveal the developer options.
  4. Copy your Token and Client Secret.

BLE Support

Set enableBLE: true to enable Bluetooth Low Energy discovery. This requires:

  • Bluetooth hardware available on the host system.
  • Appropriate Bluetooth permissions (may require running as root or adding capabilities on Linux).

Getting Started (Development)

  1. Clone the repository.
  2. Install dependencies: npm install
  3. Link Matterbridge: npm run dev:link
  4. Build: npm run build
  5. Add to Matterbridge: npm run matterbridge:add

Requirements

License

Apache-2.0

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors