Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jfarmer08/homebridge-wyze-smart-home

Wyze Smart Home plugin for Homebridge.
https://github.com/jfarmer08/homebridge-wyze-smart-home

home-automation homebridge homebridge-plugin homekit wyze wyze-bulbs wyze-cam wyze-sensors

Last synced: 1 day ago
JSON representation

Wyze Smart Home plugin for Homebridge.

Host: GitHub
URL: https://github.com/jfarmer08/homebridge-wyze-smart-home
Owner: jfarmer08
License: mit
Created: 2022-05-18T04:32:48.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-09-12T13:31:17.000Z (5 months ago)
Last Synced: 2025-01-22T08:02:39.694Z (9 days ago)
Topics: home-automation, homebridge, homebridge-plugin, homekit, wyze, wyze-bulbs, wyze-cam, wyze-sensors
Language: JavaScript
Homepage:
Size: 631 KB
Stars: 113
Watchers: 7
Forks: 18
Open Issues: 23
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: license.txt

Awesome Lists containing this project

README

        # This plugin adds support for Wyze Smart Home devices to [Homebridge](https://github.com/homebridge/homebridge).

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

[![certified-hoobs-plugin](https://badgen.net/badge/HOOBS/certified/yellow)](https://plugins.hoobs.org/plugin/homebridge-wyze-smart-home)

[![npm](https://img.shields.io/npm/dt/homebridge-wyze-smart-home)](https://www.npmjs.com/package/homebridge-wyze-smart-home)

[![npm](https://img.shields.io/npm/v/homebridge-wyze-smart-home.svg?style=flat-square)](https://www.npmjs.com/package/homebridge-wyze-smart-home)

[![GitHub last commit](https://img.shields.io/github/last-commit/jfarmer08/homebridge-wyze-smart-home)](https://github.com/jfarmer08/homebridge-wyze-smart-home)

[![Chat](https://img.shields.io/discord/1134601590762913863)](https://discord.gg/Mjkpq2x9)

[![homebridge-wyze-smart-home: Wyze Connected Home plugin for Homebridge](https://github.com/jfarmer08/homebridge-wyze-smart-home/blob/main/logo.png?raw=true)](https://github.com/jfarmer08/homebridge-wyze-smart-home)

[Major Feature Backlog/Status](https://github.com/jfarmer08/homebridge-wyze-smart-home/discussions/224)

# Funding   [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square&maxAge=2592000)](https://www.paypal.com/paypalme/AllenFarmer) [![Donate](https://img.shields.io/badge/Donate-Venmo-blue.svg?style=flat-square&maxAge=2592000)](https://venmo.com/u/Allen-Farmer) [![Donate](https://img.shields.io/badge/Donate-Cash_App-blue.svg?style=flat-square&maxAge=2592000)](https://cash.app/$Jfamer08)

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](CHANGELOG.md).

## 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:

```js

{

  "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](https://developer-api-console.wyze.com/)

* **`keyId`** – Navigate to [this portal](https://developer-api-console.wyze.com/), 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](https://github.com/JoshuaMulliken/ha-wyzeapi), a Wyze integration for Home Assistant.

- [wyze-node](https://github.com/noelportugal/wyze-node), a Node library for the Wyze API.

Thanks to [misenhower](https://github.com/misenhower/homebridge-wyze-connected-home) for the original Wyze Homebridge plugin, and thanks to [contributors](https://github.com/misenhower/homebridge-wyze-connected-home/graphs/contributors) and [other developers who were not merged](https://github.com/misenhower/homebridge-wyze-connected-home/pulls) 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](https://github.com/misenhower/homebridge-wyze-connected-home) project.