Home

Jump to bottom

Donavan Becker edited this page Feb 5, 2024 · 4 revisions

@switchbot/homebridge-switchbot

The Homebridge SwitchBot OpenAPI 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
Click Install

Configuration

Download SwitchBot App on App Store or Google Play Store
Register a SwitchBot account and log in into your account
Generate an Open 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 to Clipboard
Input your Token into the config paramter

Supported SwitchBot Devices

SwitchBot Humidifier
SwitchBot Meter
- SwitchBot Hub Mini or SwitchBot Hub Plus Required
- Enable Cloud Services for Device on SwitchBot App
SwitchBot Motion Sensor
- SwitchBot Hub Mini or SwitchBot Hub Plus Required
- Enable Cloud Services for Device on SwitchBot App
SwitchBot Contact Sensor
- SwitchBot Hub Mini or SwitchBot Hub Plus Required
- Enable Cloud Services for Device on SwitchBot App
SwitchBot Curtain
- SwitchBot Hub Mini or SwitchBot Hub Plus Required
- Enable Cloud Services for Device on SwitchBot App
SwitchBot Bot
- SwitchBot Hub Mini or SwitchBot Hub Plus 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 > 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
SwitchBot Plug

Supported IR Devices

(All IR Devices require Hub Plus or Hub Mini)

TV
- Allows for On/Off and Volume Controls
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

SwitchBotAPI

Community