From 26cb7788edeff9e1395beddf8b264e63f2c712cb Mon Sep 17 00:00:00 2001 From: mrlt8 <67088095+mrlt8@users.noreply.github.com> Date: Sun, 28 Apr 2024 08:44:23 -0700 Subject: [PATCH] Update documentation for API Key/ID --- README.md | 20 +++++++++++++++----- docker-compose.sample.yml | 5 ++--- home_assistant/config.json | 22 ++++++---------------- home_assistant/dev/config.json | 2 ++ home_assistant/previous/config.json | 2 ++ 5 files changed, 27 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 62712e06..d9986bbf 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,8 @@ Please consider ⭐️ starring or [☕️ sponsoring](https://ko-fi.com/mrlt8) > [!IMPORTANT] -> As of July 2023, you will need to **update your bridge to v2.3.x or newer** for compatibility with the latest changes to the Wyze API. +> As of April 2024, you will need to **update your bridge to v2.3.x or newer** for compatibility with the latest changes to the Wyze API as well as supply your own API Key and API ID from: https://support.wyze.com/hc/en-us/articles/16129834216731. + ![Wyze Cam V1](https://img.shields.io/badge/wyze_v1-yes-success.svg) ![Wyze Cam V2](https://img.shields.io/badge/wyze_v2-yes-success.svg) @@ -48,7 +49,11 @@ See the [supported cameras](#supported-cameras) section for additional informati Install [docker](https://docs.docker.com/get-docker/) and run: ```bash -docker run -p 8554:8554 -p 8888:8888 -p 5000:5000 mrlt8/wyze-bridge +docker run \ + -e API_ID=My-Unique-KeyID-From-WYZE \ + -e API_KEY=MySecretApiKeyFromWyze \ + -p 8554:8554 -p 8888:8888 -p 5000:5000 \ + mrlt8/wyze-bridge ``` You can then use the web interface at `http://localhost:5000` where localhost is the hostname or ip of the machine running the bridge. @@ -78,7 +83,7 @@ Home Assistant: * Can this work offline/can I block all wyze services? * No. Streaming should continue to work without an active internet connection, but will probably stop working after some time as the cameras were not designed to be used without the cloud. Some camera commands also depend on the cloud and may not function without an active connection. See [wz_mini_hacks](https://github.com/gtxaspec/wz_mini_hacks/wiki/Configuration-File#self-hosted--isolated-mode) for firmware level modification to run the camera offline. * Why aren't all wyze cams supported yet (OG/Doorbell Pro)? - * These cameras are using a different SDK and will require a different method to connect and stream. + * These cameras are using a different SDK and will require a different method to connect and stream. See the awesome [cryze](https://github.com/carTloyal123/cryze) project by @carTloyal123. ## Compatibility @@ -237,6 +242,11 @@ All environment variables are optional. ## Other Wyze Projects -* [gtxaspec/wz_mini_hacks](https://github.com/gtxaspec/wz_mini_hacks) - firmware level modification with a [self-hosted mode](https://github.com/gtxaspec/wz_mini_hacks/wiki/Configuration-File#self-hosted--isolated-mode) to use the cameras without the wyze services. -* [jfarmer08/homebridge-wyze-smart-home](https://github.com/jfarmer08/homebridge-wyze-smart-home) - homebridge plugin to interact with other wyze devices over the cloud. +Video Streaming: + +* [gtxaspec/wz_mini_hacks](https://github.com/gtxaspec/wz_mini_hacks) - Firmware level modification for Ingenic based cameras with an RTSP server and [self-hosted mode](https://github.com/gtxaspec/wz_mini_hacks/wiki/Configuration-File#self-hosted--isolated-mode) to use the cameras without the wyze services. +* [carTloyal123/cryze](https://github.com/carTloyal123/cryze) - Stream video from wyze cameras (Gwell cameras) that use the Iotvideo SDK from Tencent Cloud. + +General Wyze: + * [shauntarves/wyze-sdk](https://github.com/shauntarves/wyze-sdk) - python library to interact with wyze devices over the cloud. \ No newline at end of file diff --git a/docker-compose.sample.yml b/docker-compose.sample.yml index 96dd432a..e6f57a91 100644 --- a/docker-compose.sample.yml +++ b/docker-compose.sample.yml @@ -15,8 +15,7 @@ services: # [OPTIONAL] (Can be set in the WebUI): - WYZE_EMAIL= - WYZE_PASSWORD= + - API_ID= + - API_KEY= # [OPTIONAL] IP Address of the host to enable WebRTC e.g.,: # - WB_IP=192.168.1.122 - # [OPTIONAL] Wyze API credentials: - # - API_ID= - # - API_KEY= diff --git a/home_assistant/config.json b/home_assistant/config.json index ac80bb0c..37727bcc 100644 --- a/home_assistant/config.json +++ b/home_assistant/config.json @@ -5,11 +5,7 @@ "url": "https://github.com/mrlt8/docker-wyze-bridge", "image": "mrlt8/wyze-bridge", "version": "2.8.1", - "arch": [ - "armv7", - "aarch64", - "amd64" - ], + "arch": ["armv7", "aarch64", "amd64"], "startup": "application", "boot": "auto", "apparmor": false, @@ -34,20 +30,16 @@ "IMG_DIR": "media/wyze/img/", "RECORD_PATH": "media/wyze/{CAM_NAME}" }, - "map": [ - "addon_config:rw", - "media:rw", - "ssl:ro" - ], - "services": [ - "mqtt:want" - ], + "map": ["addon_config:rw", "media:rw", "ssl:ro"], + "services": ["mqtt:want"], "ingress": true, "ingress_port": 5000, "panel_icon": "mdi:bridge", "options": { "WYZE_EMAIL": null, "WYZE_PASSWORD": null, + "API_ID": null, + "API_KEY": null, "NET_MODE": "ANY", "SNAPSHOT": "Disable", "MQTT_DTOPIC": "homeassistant", @@ -138,9 +130,7 @@ "MOTION_WEBHOOKS": "str?" } ], - "MEDIAMTX": [ - "match(^\\w+=.*)?" - ], + "MEDIAMTX": ["match(^\\w+=.*)?"], "WB_HLS_URL": "str?", "WB_RTMP_URL": "str?", "WB_RTSP_URL": "str?", diff --git a/home_assistant/dev/config.json b/home_assistant/dev/config.json index a4f6bba8..e5a84b31 100644 --- a/home_assistant/dev/config.json +++ b/home_assistant/dev/config.json @@ -37,6 +37,8 @@ "options": { "WYZE_EMAIL": null, "WYZE_PASSWORD": null, + "API_ID": null, + "API_KEY": null, "NET_MODE": "ANY", "SNAPSHOT": "Disable", "MQTT_DTOPIC": "homeassistant", diff --git a/home_assistant/previous/config.json b/home_assistant/previous/config.json index 89f18e27..1000b2cf 100644 --- a/home_assistant/previous/config.json +++ b/home_assistant/previous/config.json @@ -37,6 +37,8 @@ "options": { "WYZE_EMAIL": null, "WYZE_PASSWORD": null, + "API_ID": null, + "API_KEY": null, "NET_MODE": "ANY", "SNAPSHOT": "Disable", "MQTT_DTOPIC": "homeassistant",