{"id":7238,"date":"2024-07-28T15:22:37","date_gmt":"2024-07-28T15:22:37","guid":{"rendered":"http:\/\/172.30.70.55\/?p=7238"},"modified":"2024-08-09T01:25:40","modified_gmt":"2024-08-09T01:25:40","slug":"rtsp-camera-on-overlay-script","status":"publish","type":"post","link":"https:\/\/phixd.us\/?p=7238","title":{"rendered":"RTSP Camera on Overlay Script"},"content":{"rendered":"\n

<\/p>\n\n\n\n

This script is designed to integrate RTSP compatible cameras into a designed for Home Assistant via MQTT discovery messages and manage media playback through a Kodi media center. The script is structured in Python and utilizes several libraries to handle HTTP requests, subprocess management, MQTT communication, and JSON data handling.<\/p>\n\n\n\n

Features<\/strong><\/h3>\n\n\n\n
    \n
  1. RTSP Stream Management<\/strong>: Handles multiple RTSP streams, allowing you to start and stop video feeds based on commands received over MQTT.<\/li>\n\n\n\n
  2. MQTT Integration<\/strong>: Connects to an MQTT broker to receive commands and publish the state of camera streams.<\/li>\n\n\n\n
  3. Kodi Control<\/strong>: Sends commands to a Kodi media center to pause and play media automatically when switching between streams.<\/li>\n\n\n\n
  4. Home Assistant Compatibility<\/strong>: Publishes MQTT discovery messages to integrate seamlessly with Home Assistant, making each camera stream appear as a switchable entity.<\/li>\n\n\n\n
  5. Error Handling<\/strong>: Includes basic error handling to manage exceptions and ensure the system remains operational in case of minor errors.<\/li>\n<\/ol>\n\n\n\n

    Components of the Script<\/strong><\/h3>\n\n\n\n

    Global Variables and Dictionaries<\/strong><\/h4>\n\n\n\n
      \n
    • current_stream<\/code>: A dictionary that tracks the state of the current stream, including whether Kodi was playing when the stream started.<\/li>\n\n\n\n
    • streams<\/code>: Contains the URLs for the RTSP streams, indexed by a friendly name. Each URL should be customized with the correct credentials and IP addresses for your cameras.<\/li>\n\n\n\n
    • broker_address<\/code>, user<\/code>, password<\/code>, topic<\/code>, mqtt_port<\/code>: Configuration settings for connecting to the MQTT broker.<\/li>\n<\/ul>\n\n\n\n

      Functions<\/strong><\/h4>\n\n\n\n
        \n
      1. control_kodi(action)<\/strong>:\n
          \n
        • Purpose<\/strong>: Sends a play\/pause command to Kodi.<\/li>\n\n\n\n
        • Parameters<\/strong>: action<\/code> (string) – either “pause” or “play”.<\/li>\n\n\n\n
        • Process<\/strong>: Constructs an HTTP request to Kodi’s JSON-RPC API to control playback.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
        • check_kodi_play_state()<\/strong>:\n
            \n
          • Purpose<\/strong>: Checks whether Kodi is currently playing.<\/li>\n\n\n\n
          • Returns<\/strong>: Playback speed (0 for paused, 1 for playing).<\/li>\n<\/ul>\n<\/li>\n\n\n\n
          • display_rtsp(stream_key, action)<\/strong>:\n
              \n
            • Purpose<\/strong>: Manages the display of RTSP streams based on MQTT commands.<\/li>\n\n\n\n
            • Parameters<\/strong>: stream_key<\/code> (the camera identifier), action<\/code> (either “start” or “stop”).<\/li>\n\n\n\n
            • Process<\/strong>: Starts or stops the video feed and manages the state of Kodi playback accordingly.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
            • on_message(client, userdata, message)<\/strong>:\n
                \n
              • Purpose<\/strong>: Callback function that triggers when an MQTT message is received.<\/li>\n\n\n\n
              • Process<\/strong>: Parses the message and calls display_rtsp<\/code> to show or hide the specified stream.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
              • publish_discovery_messages(client)<\/strong>:\n
                  \n
                • Purpose<\/strong>: Publishes discovery messages to Home Assistant to automatically create entities for each camera.<\/li>\n\n\n\n
                • Process<\/strong>: Iterates through each stream and sends a configuration payload over MQTT.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                • publish_state(stream_key, state)<\/strong>:\n
                    \n
                  • Purpose<\/strong>: Publishes the current state of a stream to MQTT.<\/li>\n\n\n\n
                  • Parameters<\/strong>: stream_key<\/code> (the camera identifier), state<\/code> (either “on” or “off”).<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                  • initialize_camera_states()<\/strong>:\n
                      \n
                    • Purpose<\/strong>: Initializes the state of all camera streams to “off” upon script startup.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n

                      MQTT Client Setup and Loop<\/strong><\/h4>\n\n\n\n
                        \n
                      • Sets up an MQTT client, connects to the broker, subscribes to the relevant topic, and enters a loop to listen for messages indefinitely.<\/li>\n<\/ul>\n\n\n\n

                        Usage Instructions<\/strong><\/h3>\n\n\n\n
                          \n
                        1. Modify the Placeholder Values<\/strong>: Replace placeholders in the streams<\/code> dictionary and MQTT settings with actual data from your environment.<\/li>\n\n\n\n
                        2. Set Up Kodi and MQTT Broker<\/strong>: Ensure Kodi’s JSON-RPC API is accessible, and your MQTT broker is running.<\/li>\n\n\n\n
                        3. Run the Script<\/strong>: Execute the script on a system within the same network as your cameras and MQTT broker. The system should also be able to communicate with Kodi.<\/li>\n<\/ol>\n\n\n\n

                          Conclusion<\/strong><\/h3>\n\n\n\n

                          This script provides a robust solution for integrating RTSP camera streams into a smart home environment using MQTT, with added functionality for controlling media playback through Kodi. It’s particularly useful in scenarios where real-time video monitoring is needed without interrupting media playback.<\/p>\n\n\n\n

                          This guide can be adapted as necessary to fit the specific configuration and setup details of your home automation system.<\/p>\n\n\n\n

                          Home Assistant:<\/strong><\/p>\n\n\n\n

                          This script integrates seamlessly with Home Assistant, allowing you to leverage its powerful automation capabilities in conjunction with real-time video monitoring from your RTSP cameras. By utilizing MQTT for communication, the script automatically publishes camera streams as entities within Home Assistant, enabling you to trigger automations and control stream visibility directly from your Home Assistant dashboard. For instance I use in conjunction with Frigate, so when a specific object is detected, it can displayed on the screen.<\/p>\n\n\n\n

                          \"\"<\/figure>\n\n\n\n

                          Script:<\/strong><\/p>\n\n\n\n

                          <\/path><\/path><\/svg><\/span>
                          import<\/span> <\/span>os<\/span><\/span>\nimport<\/span> <\/span>subprocess<\/span><\/span>\nimport<\/span> <\/span>requests<\/span><\/span>\nimport<\/span> <\/span>json<\/span><\/span>\nimport<\/span> <\/span>time<\/span><\/span>\nimport<\/span> <\/span>threading<\/span><\/span>\nimport<\/span> <\/span>paho<\/span>.<\/span>mqtt<\/span>.<\/span>client<\/span> <\/span>as<\/span> <\/span>mqtt<\/span><\/span>\nimport<\/span> <\/span>paho<\/span>.<\/span>mqtt<\/span>.<\/span>publish<\/span> <\/span>as<\/span> <\/span>publish<\/span><\/span>\n<\/span>\n# <\/span>Dictionary<\/span> <\/span>to<\/span> <\/span>keep<\/span> <\/span>track<\/span> <\/span>of<\/span> <\/span>the<\/span> <\/span>current<\/span> <\/span>stream<\/span> <\/span>process<\/span> <\/span>and<\/span> <\/span>the<\/span> <\/span>original<\/span> <\/span>play<\/span> <\/span>state<\/span><\/span>\ncurrent_stream<\/span> = {<\/span><\/span>\n    '<\/span>process<\/span>': <\/span>None<\/span>,<\/span><\/span>\n    '<\/span>was_playing<\/span>': <\/span>False<\/span>,<\/span><\/span>\n    '<\/span>active_stream<\/span>': <\/span>None<\/span>,  # <\/span>Track<\/span> <\/span>the<\/span> <\/span>currently<\/span> <\/span>active<\/span> <\/span>stream<\/span><\/span>\n    '<\/span>state<\/span>': {}  # <\/span>Added<\/span> <\/span>state<\/span> <\/span>dictionary<\/span> <\/span>to<\/span> <\/span>keep<\/span> <\/span>track<\/span> <\/span>of<\/span> <\/span>each<\/span> <\/span>stream<\/span>'s stat<\/span>e<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n# <\/span>RTSP<\/span> <\/span>URLs<\/span> <\/span>dictionary<\/span> <\/span>with<\/span> <\/span>generic<\/span> <\/span>credentials<\/span><\/span>\nstreams<\/span> = {<\/span><\/span>\n    "<\/span>fdoorbell<\/span>": "<\/span>rtsp<\/span>:<\/span>\/\/user:password@camera-ip:554\/h264Preview_01_main",<\/span><\/span>\n    "<\/span>parking_area<\/span>": "<\/span>rtsp<\/span>:<\/span>\/\/user:password@camera-ip:554\/cam\/realmonitor?channel=1&subtype=0",<\/span><\/span>\n    # <\/span>Add<\/span> <\/span>additional<\/span> <\/span>streams<\/span> <\/span>as<\/span> <\/span>needed<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n# <\/span>MQTT<\/span> <\/span>setup<\/span> <\/span>with<\/span> <\/span>generic<\/span> <\/span>credentials<\/span><\/span>\nbroker_address<\/span> = <\/span>"mqtt-broker-ip"<\/span><\/span>\nuser<\/span> = <\/span>"mqtt-user"<\/span><\/span>\npassword<\/span> = <\/span>"mqtt-password"<\/span><\/span>\ntopic<\/span> = <\/span>"camera\/control\/#"<\/span><\/span>\nmqtt_port<\/span> = 1883<\/span><\/span>\n<\/span>\n# <\/span>Device<\/span> <\/span>Information<\/span><\/span>\ndevice_id<\/span> = <\/span>"device_id"<\/span><\/span>\ndevice_name<\/span> = <\/span>"Device Name"<\/span><\/span>\ndevice_serial<\/span> = <\/span>"serial_number"<\/span><\/span>\ndevice_manufacturer<\/span> = <\/span>"Manufacturer"<\/span><\/span>\ndevice_model<\/span> = <\/span>"Model"<\/span><\/span>\n<\/span>\ndef<\/span> <\/span>control_kodi<\/span>(<\/span>action<\/span>):<\/span><\/span>\n    # <\/span>Control<\/span> <\/span>Kodi<\/span> <\/span>functionality<\/span><\/span>\n    <\/span>kodi_url<\/span> = <\/span>'http:\/\/kodi-ip:port\/jsonrpc'<\/span><\/span>\n    <\/span>headers<\/span> = {'<\/span>Content<\/span>-<\/span>Type<\/span>': '<\/span>application<\/span>\/<\/span>json<\/span>'}<\/span><\/span>\n    <\/span>payload<\/span> = {<\/span><\/span>\n        "<\/span>jsonrpc<\/span>": "2.0",<\/span><\/span>\n        "<\/span>method<\/span>": "<\/span>Player<\/span>.<\/span>PlayPause<\/span>",<\/span><\/span>\n        "<\/span>params<\/span>": {<\/span><\/span>\n            "<\/span>playerid<\/span>": 1<\/span><\/span>\n        },<\/span><\/span>\n        <\/span>"id"<\/span>: 1<\/span><\/span>\n    }<\/span><\/span>\n    <\/span>try<\/span>:<\/span><\/span>\n        <\/span>response<\/span> = <\/span>requests<\/span>.<\/span>post<\/span>(<\/span>kodi_url<\/span>, <\/span>headers<\/span>=<\/span>headers<\/span>, <\/span>data<\/span>=<\/span>json<\/span>.<\/span>dumps<\/span>(<\/span>payload<\/span>))<\/span><\/span>\n        <\/span>print<\/span>(<\/span>f<\/span>"Response from Kodi: {response.text}"<\/span>)<\/span><\/span>\n    <\/span>except<\/span> <\/span>Exception<\/span> <\/span>as<\/span> <\/span>e<\/span>:<\/span><\/span>\n        <\/span>print<\/span>(<\/span>f<\/span>"Error controlling Kodi: {e}"<\/span>)<\/span><\/span>\n<\/span>\ndef<\/span> <\/span>check_kodi_play_state<\/span>():<\/span><\/span>\n    # <\/span>Check<\/span> <\/span>the<\/span> <\/span>current<\/span> <\/span>play<\/span> <\/span>state<\/span> <\/span>of<\/span> <\/span>Kodi<\/span><\/span>\n    <\/span>kodi_url<\/span> = <\/span>'http:\/\/kodi-ip:port\/jsonrpc'<\/span><\/span>\n    <\/span>headers<\/span> = {'<\/span>Content<\/span>-<\/span>Type<\/span>': '<\/span>application<\/span>\/<\/span>json<\/span>'}<\/span><\/span>\n    <\/span>payload<\/span> = {<\/span><\/span>\n        "<\/span>jsonrpc<\/span>": "2.0",<\/span><\/span>\n        "<\/span>method<\/span>": "<\/span>Player<\/span>.<\/span>GetProperties<\/span>",<\/span><\/span>\n        "<\/span>params<\/span>": {<\/span><\/span>\n            "<\/span>playerid<\/span>": 1,<\/span><\/span>\n            "<\/span>properties<\/span>": ["<\/span>speed<\/span>"]<\/span><\/span>\n        },<\/span><\/span>\n        <\/span>"id"<\/span>: 1<\/span><\/span>\n    }<\/span><\/span>\n    <\/span>try<\/span>:<\/span><\/span>\n        <\/span>response<\/span> = <\/span>requests<\/span>.<\/span>post<\/span>(<\/span>kodi_url<\/span>, <\/span>headers<\/span>=<\/span>headers<\/span>, <\/span>data<\/span>=<\/span>json<\/span>.<\/span>dumps<\/span>(<\/span>payload<\/span>))<\/span><\/span>\n        <\/span>response_data<\/span> = <\/span>response<\/span>.<\/span>json<\/span>()<\/span><\/span>\n        <\/span>return<\/span> <\/span>response_data<\/span>.<\/span>get<\/span>(<\/span>"result"<\/span>, {}).<\/span>get<\/span>(<\/span>"speed"<\/span>, 1)<\/span><\/span>\n    <\/span>except<\/span> <\/span>Exception<\/span> <\/span>as<\/span> <\/span>e<\/span>:<\/span><\/span>\n        <\/span>print<\/span>(<\/span>f<\/span>"Error checking Kodi play state: {e}"<\/span>)<\/span><\/span>\n        <\/span>return<\/span> 1<\/span><\/span>\n<\/span>\ndef<\/span> <\/span>display_rtsp<\/span>(<\/span>stream_key<\/span>, <\/span>action<\/span>):<\/span><\/span>\n    # <\/span>Manage<\/span> <\/span>the<\/span> <\/span>display<\/span> <\/span>of<\/span> <\/span>RTSP<\/span> <\/span>streams<\/span><\/span>\n    <\/span>global<\/span> <\/span>current_stream<\/span><\/span>\n    <\/span>try<\/span>:<\/span><\/span>\n        <\/span>if<\/span> <\/span>action<\/span> == <\/span>"start"<\/span>:<\/span><\/span>\n            # <\/span>Example<\/span> <\/span>logic<\/span> <\/span>to<\/span> <\/span>handle<\/span> <\/span>stream<\/span> <\/span>starting<\/span><\/span>\n            <\/span>pass<\/span><\/span>\n        <\/span>elif<\/span> <\/span>action<\/span> == <\/span>"stop"<\/span>:<\/span><\/span>\n            # <\/span>Example<\/span> <\/span>logic<\/span> <\/span>to<\/span> <\/span>handle<\/span> <\/span>stream<\/span> <\/span>stopping<\/span><\/span>\n            <\/span>pass<\/span><\/span>\n    <\/span>except<\/span> <\/span>Exception<\/span> <\/span>as<\/span> <\/span>e<\/span>:<\/span><\/span>\n        <\/span>print<\/span>(<\/span>f<\/span>"Error in display_rtsp: {e}"<\/span>)<\/span><\/span>\n<\/span>\ndef<\/span> <\/span>on_message<\/span>(<\/span>client<\/span>, <\/span>userdata<\/span>, <\/span>message<\/span>):<\/span><\/span>\n    # <\/span>Handle<\/span> <\/span>MQTT<\/span> <\/span>messages<\/span><\/span>\n    <\/span>msg<\/span> = <\/span>str<\/span>(<\/span>message<\/span>.<\/span>payload<\/span>.<\/span>decode<\/span>(<\/span>"utf-8"<\/span>))<\/span><\/span>\n    <\/span>stream_key<\/span> = <\/span>message<\/span>.<\/span>topic<\/span>.<\/span>split<\/span>(<\/span>'\/'<\/span>)[-1]<\/span><\/span>\n    <\/span>if<\/span> <\/span>msg<\/span> == <\/span>"on"<\/span>:<\/span><\/span>\n        <\/span>display_rtsp<\/span>(<\/span>stream_key<\/span>, <\/span>"start"<\/span>)<\/span><\/span>\n    <\/span>elif<\/span> <\/span>msg<\/span> == <\/span>"off"<\/span>:<\/span><\/span>\n        <\/span>display_rtsp<\/span>(<\/span>stream_key<\/span>, <\/span>"stop"<\/span>)<\/span><\/span>\n<\/span>\ndef<\/span> <\/span>publish_discovery_messages<\/span>(<\/span>client<\/span>):<\/span><\/span>\n    # <\/span>Publish<\/span> <\/span>MQTT<\/span> <\/span>discovery<\/span> <\/span>messages<\/span> <\/span>for<\/span> <\/span>Home<\/span> <\/span>Assistant<\/span> <\/span>integration<\/span><\/span>\n    <\/span>global<\/span> <\/span>streams<\/span><\/span>\n    <\/span>for<\/span> <\/span>stream_key<\/span>, <\/span>_<\/span> <\/span>in<\/span> <\/span>streams<\/span>.<\/span>items<\/span>():<\/span><\/span>\n        # <\/span>Example<\/span> <\/span>discovery<\/span> <\/span>message<\/span><\/span>\n        <\/span>pass<\/span><\/span>\n<\/span>\ndef<\/span> <\/span>publish_state<\/span>(<\/span>stream_key<\/span>, <\/span>state<\/span>):<\/span><\/span>\n    # <\/span>Publish<\/span> <\/span>state<\/span> <\/span>changes<\/span><\/span>\n    <\/span>state_topic<\/span> = <\/span>f<\/span>"homeassistant\/switch\/{device_id}\/camera_{stream_key}\/state"<\/span><\/span>\n    <\/span>try<\/span>:<\/span><\/span>\n        <\/span>publish<\/span>.<\/span>single<\/span>(<\/span><\/span>\n            <\/span>state_topic<\/span>,<\/span><\/span>\n            <\/span>payload<\/span>=<\/span>state<\/span>,<\/span><\/span>\n            <\/span>hostname<\/span>=<\/span>broker_address<\/span>,<\/span><\/span>\n            <\/span>port<\/span>=<\/span>mqtt_port<\/span>,<\/span><\/span>\n            <\/span>auth<\/span>={"<\/span>username<\/span>": <\/span>user<\/span>, "<\/span>password<\/span>": <\/span>password<\/span>},<\/span><\/span>\n            <\/span>retain<\/span>=<\/span>True<\/span><\/span>\n        )<\/span><\/span>\n    <\/span>except<\/span> <\/span>Exception<\/span> <\/span>as<\/span> <\/span>e<\/span>:<\/span><\/span>\n        <\/span>print<\/span>(<\/span>f<\/span>"Error publishing state for {stream_key}: {e}"<\/span>)<\/span><\/span>\n<\/span>\ndef<\/span> <\/span>initialize_camera_states<\/span>():<\/span><\/span>\n    # <\/span>Initialize<\/span> <\/span>camera<\/span> <\/span>states<\/span><\/span>\n    <\/span>for<\/span> <\/span>stream_key<\/span> <\/span>in<\/span> <\/span>streams<\/span>:<\/span><\/span>\n        <\/span>publish_state<\/span>(<\/span>stream_key<\/span>, <\/span>"off"<\/span>)<\/span><\/span>\n<\/span>\nclient<\/span> = <\/span>mqtt<\/span>.<\/span>Client<\/span>(<\/span>"CameraControl"<\/span>)<\/span><\/span>\nclient<\/span>.<\/span>username_pw_set<\/span>(<\/span>user<\/span>, <\/span>password<\/span>)<\/span><\/span>\nclient<\/span>.<\/span>on_message<\/span> = <\/span>on_message<\/span><\/span>\n<\/span>\ntry<\/span>:<\/span><\/span>\n    <\/span>client<\/span>.<\/span>connect<\/span>(<\/span>broker_address<\/span>)<\/span><\/span>\n    <\/span>client<\/span>.<\/span>subscribe<\/span>(<\/span>topic<\/span>)<\/span><\/span>\n    <\/span>initialize_camera_states<\/span>()<\/span><\/span>\n    <\/span>publish_discovery_messages<\/span>(<\/span>client<\/span>)<\/span><\/span>\n    <\/span>client<\/span>.<\/span>loop_forever<\/span>()<\/span><\/span>\nexcept<\/span> <\/span>Exception<\/span> <\/span>as<\/span> <\/span>e<\/span>:<\/span><\/span>\n    <\/span>print<\/span>(<\/span>f<\/span>"Error connecting to MQTT broker: {e}"<\/span>)<\/span><\/span>\n<\/span><\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"
                          This script is designed to integrate RTSP compatible cameras into a designed for Home Assistant via MQTT discovery messages and manage media playback through a Kodi media center. The script …<\/p>\n","protected":false},"author":1,"featured_media":7241,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[352,355,354,353],"tags":[],"class_list":["post-7238","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-coding","category-home-assistant","category-linux","category-python"],"_links":{"self":[{"href":"https:\/\/phixd.us\/index.php?rest_route=\/wp\/v2\/posts\/7238","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/phixd.us\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/phixd.us\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/phixd.us\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/phixd.us\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=7238"}],"version-history":[{"count":3,"href":"https:\/\/phixd.us\/index.php?rest_route=\/wp\/v2\/posts\/7238\/revisions"}],"predecessor-version":[{"id":7254,"href":"https:\/\/phixd.us\/index.php?rest_route=\/wp\/v2\/posts\/7238\/revisions\/7254"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/phixd.us\/index.php?rest_route=\/wp\/v2\/media\/7241"}],"wp:attachment":[{"href":"https:\/\/phixd.us\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=7238"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/phixd.us\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=7238"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/phixd.us\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=7238"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}