Release 4.8.5

This commit is contained in:
tsightler
2021-10-17 09:49:05 -04:00
parent 1d9364c1a2
commit f3e3c10b78
4 changed files with 15 additions and 9 deletions

View File

@@ -16,6 +16,9 @@ Docker is the recommended installation method, however, standard, non-Docker ins
### Camera video stream configuration
Please read the detailed [camera documentation](docs/CAMERAS.md) for more information on video streaming configuration.
**Important Note**
The ring-mqtt project does not magically turn Ring cameras into 24x7/continuous streaming CCTV cameras. Ring cameras are designed to work with Ring cloud servers for on-demand streaming based on detected events (motion/ding) or active viewing. Even when using ring-mqtt all streaming still goes through Ring servers and is not local. Attempting to use ring-mqtt to stream Ring cameras 24x7 is not a supported use case for this project and attempts to do so will almost certainly end in disappointment.
### Use with MQTT Tools other than Home Assistant (Node-Red, OpenHAB, etc)
MQTT topics are built consistently during each startup. The easiest way to determine the device topics is to run the script with debug output. More details about the topic format for all devices is available in [docs/TOPICS.md](docs/TOPICS.md).

View File

@@ -3,6 +3,9 @@ While ring-mqtt is primarily designed to integrate Ring devices into home automa
This document provides detailed information about the video streaming support, including how to configure it with Home Assistant or use it with other medial players, as well as some troubleshooting information and known limitations. If you would like to use the videos streaming features, please read this section carefully.
**Important Note**
The ring-mqtt project does not magically turn Ring cameras into 24x7/continuous streaming CCTV cameras. Ring cameras are designed to work with Ring cloud servers for on-demand streaming based on detected events (motion/ding) or active viewing. Even when using ring-mqtt all streaming still goes through Ring servers and is not local. Attempting to use ring-mqtt to stream Ring cameras 24x7 is not a supported use case for this project and attempts to do so will almost certainly end in disappointment.
### Quick overview
Ring video streaming support is implemented by running a localhost instance of rtsp-simple-server. For each camera discovered two separate RTSP paths are registered with the server using the following format:

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 90 KiB

View File

@@ -39,14 +39,14 @@ ctrl_c() {
trap ctrl_c INT TERM QUIT
# This loop starts mosquitto_sub with a subscription on the camera stream topic that sends all received
# messages via file descriptor to the read process. On initial the startup the script publishes the
# stream 'ON-DEMAND' command to the command topic which lets ring-mqtt know that an RTSP client has
# requested the stream. Stream state is determined via the the detailed stream state messages received
# via the json_attributes_topic:
# messages via file descriptor to the read process. On initial startup the script publishes the message
# 'ON-DEMAND' to the stream command topic which lets ring-mqtt know that an RTSP client has requested
# the stream. Stream state is determined via the the detailed stream state messages received via the
# json_attributes_topic:
#
# "inactive" = There is no active live stream and none currently requested
# "activating" = A live stream has been requested and is in the process of starting
# "active" = The live stream started successfully and is currently in progress
# "inactive" = There is no active video stream and none currently requested
# "activating" = A video stream has been requested and is initializing but has not yet started
# "active" = The stream was requested successfully and an active stream is currently in progress
# "failed" = A live stream was requested but failed to start
while read -u 10 message
do