README.md

@switchbot/homebridge-switchbot

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

Installation

1. Search for "SwitchBot" on the plugin screen of Homebridge Config UI X
2. Find: @switchbot/homebridge-switchbot
   • See noble prerequisites for your OS. (This is used for BLE connection.)
3. 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

Supported SwitchBot Devices

• SwitchBot Humidifier
  • Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
    • Can Push Updates over OpenAPI
    • Can Receive Udpates 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
  • 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 Connection Only
  • 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 Connection Only
  • If using OpenAPI:
    • SwitchBot Hub Mini or SwitchBot Hub 2 Required
    • Enable Cloud Services for Device on SwitchBot App
• SwitchBot Lock
  • Supports OpenAPI Connection Only
  • If using OpenAPI:
    • SwitchBot Hub Mini or SwitchBot Hub 2 Required
    • Enable Cloud Services for Device on SwitchBot App
• SwitchBot Robot Vacuum Cleaner S1
• SwitchBot Robot Vacuum Cleaner S1 Plus
  • Supports OpenAPI Connection Only
• SwitchBot Plug
• SwitchBot Plug Mini (US)
• SwitchBot Plug Mini (JP)
  • Supports OpenAPI Connection Only
  • 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 in the Press Mode or Switch Mode Bot Settings (Advanced Settings > 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 Connection Only
    • Enables Humidity and Temperature Sensor

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 Dispaly as differenet Device Type
    • Supports Fan Device Type
  • Allows for On/Off Controls

SwitchBot APIs

• OpenWonderLabs/SwitchBotAPI
• OpenWonderLabs/SwitchBotAPI-BLE
  • OpenWonderLabs/node-switchbot

Community

• SwitchBot (Official website)
• Facebook @SwitchBotRobot
• Twitter @SwitchBot