Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

homebridge-wyze-smart-home

jfarmer08633MIT0.5.47

Wyze Smart Home plugin for Homebridge

homebridge-plugin, Wyze, Hoobs

readme

This plugin adds support for Wyze Smart Home devices to Homebridge.

verified-by-homebridge certified-hoobs-plugin npm npm GitHub last commit Chat

homebridge-wyze-smart-home: Wyze Connected Home plugin for Homebridge

Major Feature Backlog/Status

Funding Donate Donate Donate

If you like what I have done here and want to help I would recommend that you firstly look into supporting Homebridge. None of this could happen without them.

After you have done that if you feel like my work has been valuable to you I welcome your support through Paypal, Venmo or Cash App.

Supported Devices

  • Light Bulb
  • Light Strips
  • Color Bulb (Mesh Light)
  • Plug
  • Outdoor Plug
  • V1 & V2 Contact Sensor (Status / Battery)
  • V1 & V2 Motion Sensor (Status / Battery)
  • Tempeature Sensor (Status / Battery)
  • Leak Sensor (Status / Battery)
  • Lock (Battery / Door Status / Control)
  • Camera v2, v3, Outdoor Cam, PamCam (on/off, Siren, Floodlight, Garage Door)
  • Wall Switch
  • HMS
  • Thermostat

For more information about our version updates, please check our change log.

Configuration

Use the settings UI in Homebridge Config UI X to configure your Wyze account, or manually add the following to the platforms section of your config file:

{
  "platforms": [
    {
      "platform": "WyzeSmartHome",
      "name": "Wyze",
      "username": "YOUR_EMAIL",
      "password": "YOUR_PASSWORD",
      "keyId": "",
      "apiKey": "",
      "lowBatteryPercentage": 30,
      "filterDeviceTypeList": ["OutdoorPlug","Plug"],
      "filterByMacAddressList": ["MAC_ADDRESS_1","MAC_ADDRESS_2"],
      "garageDoorAccessory": ["MAC_ADDRESS_1","MAC_ADDRESS_2"],
      "spotLightAccessory": ["MAC_ADDRESS_1","MAC_ADDRESS_2"],
      "alarmAccessory": ["MAC_ADDRESS_1","MAC_ADDRESS_2"],
      "notificationAccessory": ["MAC_ADDRESS_1","MAC_ADDRESS_2"]}
  ]
}

Supported devices will be discovered and added to Homebridge automatically.

Required Fields

  • username – App email address
  • password – App password
  • apiKey – Navigate to this portal
  • keyId – Navigate to this portal, and click Login to sign in to your Wyze account. Note: Ensure that the login info you are using matches the info you use when logLevel into the Wyze app. Once you’ve signed in, you’ll be automatically redirected back to the developer page. Click Create an API key for your API key to be created. Once created, you can click view to see the entire key. You should receive an email that a new API key has been generated. Once you have the API key, you can use it in your script to get the access token and refresh token.

Optional Fields

  • refreshInterval – Defines how often the status of the devices will be polled in milliseconds (e.g., "refreshInterval": 60000 will check the status of your devices' status every 60 seconds). Defaults to 60 seconds.
  • phoneId – The phone id used by the Wyze App. This value is just found by intercepting your phone's traffic. If no phoneId is specified, a default value will be used.
  • logLevel – If no logLevel is specified, a default value will be used.
  • apiLogEnabled – If no apiLogEnabled is specified, a default value will be used.
  • authApiKey – If no authApiKey is specified, a default value will be used.
  • appName – If no appName is specified, a default value will be used.
  • appVer – If no appVer is specified, a default value will be used.
  • appVersion – If no appVersion is specified, a default value will be used.
  • userAgent – If no userAgent is specified, a default value will be used.
  • sc – If no sc is specified, a default value will be used.
  • sv – If no sv is specified, a default value will be used.
  • persistPath – If no persistPath is specified, a default value will be used.
  • refreshTokenTimerEnabled – If no refreshTokenTimerEnabled is specified, a default value will be used.
  • lowBatteryPercentage – Defines when to show devices with low battery (e.g., "lowBatteryPercentage": 30). Defaults to 30%.

Other Info

Special thanks to the following projects for reference and inspiration:

  • ha-wyzeapi, a Wyze integration for Home Assistant.
  • wyze-node, a Node library for the Wyze API.

Thanks to misenhower for the original Wyze Homebridge plugin, and thanks to contributors and other developers who were not merged for volunteering their time to help fix bugs and add support for more devices and features.

This plugin is an actively maintained fork of misenhower's original Wyze Homebridge Plugin project.

changelog

homebridge-wyze-smart-home

Funding Donate Donate Donate

If you like what I have done here and want to help I would recommend that you firstly look into supporting Homebridge. None of this could happen without them.

After you have done that if you feel like my work has been valuable to you I welcome your support through Paypal or other means.

Releases

v0.5.46

v0.5.45

  • Increase Wyze-api Verison 1.0.7
  • Update Logging

v0.5.44

  • Increase Wyze-api Version 1.0.5

v0.5.43

  • Increase Wyze-api Version 1.0.6

v0.5.42

v0.5.41

  • Increase version of wyze-api 1.0.3

v0.5.40

  • Correct Outdoor Cam 2 model number

v0.5.39

  • Support for WyzeCamOutdoor2

v0.5.38

  • Resolve issues with API changes from Wyze (2024-02-01) by @hgoscenski in #3
  • Format Code

v0.5.37-alpha.7

  • Remove Delay from MeshLight
  • Format Code

v0.5.37-alpha.6

  • Correct Mesh Brightness
  • Correct camera offline

v0.5.37-alpha.5

  • Code Clean up
  • Add Switch to turn on/off Notifications
  • Correct Wall Switch Status
  • Adjust Logging

v0.5.37-alpha.4

  • Add HL_A19C2
  • Code clean up

v0.5.37-alpha.3

  • Fix issue with Light

v0.5.37-alpha.2

  • Add check box for HMS Subscription
  • Removed MFA Support
  • Correct Door State for Garage Door
  • Code clean up

v0.5.37-alpha.1

  • Support for Siren
  • Support for Garage Door
  • Support for Spotlight
  • Support for Floodlight

v0.5.36

  • Add HL_Cam3p to Approved List
  • Require API Key and KeyID
  • Add Info Logging

v0.5.35

  • Add loging to sub models

v0.5.34

  • Allow all sub models.

v0.5.33

v0.5.32

v0.5.31

v0.5.30

  • HMS Code Clean up
  • Update ReadME
  • Update WyzeLeakSensor

v0.5.29

  • Support for API Key and Key ID
  • Support for WYZECP1_JEF

v0.5.28

  • Correction for No-Response

v0.5.26

  • Release of Beta

v0.5.25-beta.5

  • Support for Thermostat
  • Support for Wall Switch
  • Support for HMS

v0.5.25-dev.0

  • Support for Thermostat
  • Support for Wall Switch
  • Support for HMS

    v0.5.25-beta.3

  • Wall Switch Status update
  • HMS
  • Lock support is broken

    v0.5.25-beta.2

  • Wall Switch was not status being followed
  • Unable to turn Wall Switch On or Off.
  • LOCK support is broken for this release

    v0.5.25-beta.1

  • Wall Switch Support
  • Lock changes - Reduce calls to wyze platform
  • Major Changes to SDK
  • Initial support for Thermostat in SDK
  • Initial support for HMS in SDK.

v0.5.24

  • Release

v0.5.24-beta.1

  • Filter Devices by Mac Address (Thanks https://github.com/kliu99)
  • Filter Devices by Device Type
  • Refresh refreshToken every 48 Hours
  • Add Logging

v0.5.24-beta.0

  • Feature Support for ignoring devices
  • Upate default refresh interval to 30 secounds
  • Update grammer error

v0.5.23

  • Bug OutDoor Camera was not working with on/off
  • Bug Wyze Doorbell does not support on/off

v0.5.22

  • Update NPM Version

v0.5.21

  • Battery Support for Locks
  • Door Sensor from lock now being reported
  • Update NPM Version
  • Change Log Update

v0.5.20

  • Broke Offline Support

v0.5.19

  • Issue with Locks after adding Camera Support

v0.5.18

  • Initial Support for Camera on/off switch
  • Code Clean up

v0.5.17

  • Initial Support for noResponse when device is offline. ContactSensor v2 LeakSensor v2 Light Bulb Mesh Light Bulb Motion Sensor Plug
  • Initial Support for Battery Level on Leak Sensor

v0.5.15

  • Bug Sensor can send a value greater then 100 for Battery Level
  • v0.5.14 Initial Support for Battery level on Temperature Sensor
  • v0.5.14 Initial Support for Battery level on v2 Contact Sensor
  • v0.5.14 Initial Support for Battery level on v2 Motion Sensor
  • v0.5.13 Fix issue with Temperature Sensor
  • v0.5.12 Fix issue with Leak Sensor
  • v0.5.11 Fix issue with Motion Sensor
  • v0.5.10 Initial support for Wyze Temperature Sensor
  • v0.5.10 Initial support for Wyze Leak Sensor
  • v0.5.9 Initial support for Wyze Light Strips
  • v0.5.9 Initial support for Wyze V2 Contact & Motion sensors
  • v0.5.8 Fixed Bulbs not properly changing values when in a Scene with other Bulbs
  • v0.5.8 Improved & streamlined logging (moved all status changes to Debug logs)
  • v0.5.7 Initial support for the Wyze Lock
  • v0.5.6 Initial support for new Wyze Color Bulbs
  • v0.5.3 Improve logfile output for Bulb and Outdoor Plug
  • v0.5.2 Added support for Wyze Outdoor Plug
  • v0.5.1 Improve debug logging for Contact and Motion sensors.
  • v0.5.0 Added support to Contact and Motion sensors
  • v0.5.0 Added support to two factor authentication (2FA) via Authenticator app
  • v0.4.1 Fix an issue that prevented the auto re-login from working
  • v0.4.0 Add experimental support for the Wyze Bulb accessory
  • v0.4.0 Set the homepage property
  • v0.4.0 Improve logging to help diagnose occasional login issues
  • v0.3.0 Add config schema for Homebridge Config UI X
  • v0.2.0 Fix an issue caused by the Wyze API lagging behind updates
  • v0.2.0 Fix description
  • v0.2.0 Fix project link
  • v0.1.0 Initial commit