search

b0mbays / continuously_casting_dashboards

HACS Integration for continuously casting a Home Assistant dashboard to your Google Chromecast Displays
MIT License
228 stars 11 forks source link

readme

HA - Continuously Casting Dashboards

This custom integration for Home Assistant continuously casts dashboards to Chromecast devices during a specified time window. It ensures that the dashboard is always displayed during the active time window, even if the Chromecast device is accidentally interrupted or disconnected. It will ignore any devices that are currently playing Spotify, Netflix, Recipes etc. Timers will be overtaken by the dashboard but will continue to operate in the background.

I'm using this myself for 5 chromecast devices: Lenovo Smart Display 8 & four 1st Gen Google Nest Hubs.



✨Features:



✅ Requirements:

  1. Home Assistant

  2. HTTPS External Access which HA requires for casting and the HACS Addon installed. Alternatively, if you have a Nabu Casa subscription then this is already set up for you.

  3. Trusted network setup for each Chromecast device to avoid logging in. See guide here and follow the 'Trusted Networks' section half way down. You can either do your entire home network, or individual devices. You can find the IP address for each device by going to Settings -> Device Information -> Technical Information on the device.

    Your trusted networks section should then look something like this:

    homeassistant:
  external_url: "<your-external-url-for-home-assistant"
  auth_providers:
    - type: trusted_networks
      trusted_networks:
        - 192.168.12.236/32 #These are my display IP addresses, replace them with your own (including the /32)
        - 192.168.12.22/32
        - 192.168.12.217/32
      trusted_users:
        192.168.12.236: <your-user-id>  #Ensure this user has admin rights too
        192.168.12.22: <your-user-id>
        192.168.12.217: <your-user-id>
      allow_bypass_login: true
    - type: homeassistant

  4. ha-catt-fix setup for your dashboard to keep the display 'awake' and not time out after 10 minutes. Install steps:

    • Go to the HACS panel in Home Assistant
    • Click on the three dots in the top right corner and choose "Custom repositories"
    • Enter swiergot/ha-catt-fix in the "Add custom repository" field, select "Lovelace" from the "Category" dropdown, and click on the "Add" button.
    • Go to the "Frontend" tab within HACS, and click on 'Explore and download repositories" and search for 'ha-catt-fix'.
    • Click "Download"
    • Restart Home Assistant
    • Ensure that 'ha-catt-fix' is listed inside your dashboards resources. (Your dashboard -> Three dots -> Edit -> Three dots -> Manage resources)

  5. Kiosk Mode for hiding the navigations bars for fullscreen dashboards on your displays.



🚀Installation

HACS

  1. Go to the HACS panel in Home Assistant.
  2. Click on the three dots in the top right corner and choose "Custom repositories".
  3. Enter b0mbays/continuously_casting_dashboards in the "Add custom repository" field, select "Integration" from the "Category" dropdown, and click on the "Add" button.
  4. Once the custom repository is added, you can install the integration through HACS. You should see "Continuously Cast Dashboards" in the "Integrations" tab. Click on "Download" to add it to your Home Assistant instance.
  5. Restart Home Assistant to load the custom integration.
  6. Setup your devices inside the configuration.yaml file, follow the steps from the configuration section below.
  7. Restart again to start the integration.



⚡️How does it work?

This integration runs in the background on your HA instance, so no external device is required. If you'd prefer to run it on a Raspberry Pi or similiar linux box then you can try out HA-Pi-Continuously-Cast. However, I have had no issues running this on my Home Assistant instance.

The integration uses CATT's functionality to 'call' each of your Google Chromecast devices checking the status every 45 seconds (you can change this in the config) for any 'state' changes. If there is no media playing on the device, then the dashboard will be cast. If the device already has the dashboard casting then it will be ignored. And if there is youtube/recipes/spotify playing on the device then it will also be ignored.

The casting functionality within Home Assistant requires your instance to be accesible via HTTPS with either paying for a Nabu Casa subscription or setting this up yourself. I opted to subscribe to Nabu Casa to help support HA development. Previously, I did set this up myself and the guide I used is here.



⚙️Configuration

To configure the integration, add the following to your configuration.yaml file:

continuously_casting_dashboards:
  logging_level: warning #Required: Set the logging level - debug/info/warning (default is 'warning' - try 'debug' for debugging)
  cast_delay: 45 #Required: Time (in seconds) for casting checks between each device.
  start_time: "07:00" #Optional: Global start time of the casting window (format: "HH:MM") - Default is set to "07:00" and can be individually overwritten per device below.
  end_time: "01:00" #Optional: Global end time of the casting window (format: "HH:MM") and must be after "00:00". Default is set to "01:00" and can be individually overwritten per device below.
  devices:
    "<Display_Name>": #Required: Display name of your device. Find this on the actual device's settings or inside the Google Home app.
      - dashboard_url: "<Dashboard_URL>" #Required: Dashboard URL to be casted (This must be the local IP address of your HA instance, not homeassistant.local)
        volume: 5 #Optional: Volume to set the display. (If you remove this, the device will remain the same volume)
        start_time: "07:00" #Optional: Set the start time for this device
        end_time: "01:00" #Optional: Set the end time for this device
    "<Display_Name>": 
      - dashboard_url: "<Dashboard_URL>" 
        volume: <Volume>
        start_time: "<Start_Time>" 
        end_time: "<End_Time>"
        speaker_groups: #Optional: Here you can set speaker groups that your device might be a member of to skip casting if they are active.
          - "<Speaker group name>" #Optional: Speaker group name
          - "<Speaker group name>" #Optional: Extra speaker group names

    #You can then add more devices repeating the above format:

    # Examples:
    # "Office display":
    #   - dashboard_url: "http://192.168.12.104:8123/nest-dashboard/default_view?kiosk"
    #     volume: 7
    #     start_time: "06:00" 
    #     end_time: "18:00"
    # "Kitchen display":
    #   - dashboard_url: "http://192.168.12.104:8123/kitchen-dashboard/default_view?kiosk"
    #     volume: 9
    #     start_time: "06:00" 
    #     end_time: "22:00"
    # "Basement display":
    #   - dashboard_url: "http://192.168.12.104:8123/nest-dashboard/default_view?kiosk"
    #     volume: 4
    #     start_time: "18:00" 
    #     end_time: "03:00"
    #     speaker_groups:
    #       - "Upstairs Speakers"
    #       - "Downstairs Speakers"



🔄 Entity changed dashboard casting

With this feature, you can configure specific dashboards to be cast when the state of a specified entity changes. To enable this feature, add a new section to your configuration.yaml file:

continuously_casting_dashboards:
  # ...
  state_triggers:
    "<Display_Name>":
        - entity_id: "<Entity_ID>"
          to_state: "<To_State>"
          dashboard_url: "<Dashboard_URL>"
          time_out: <Timeout_time> #Optional!
          force_cast: <true or false> #Optional!

Replace with the Chromecast device, with the desired entity ID, with the state that triggers the casting and with the URL of the dashboard you want to cast.

is an optional field to "time out" a specific dashboard after a certain amount of time(in seconds). There is an example use case below.

is another optional field to indicate if the dashboard should be casted even if media is playing on the device. This is set to 'false' by default.

You can add multiple entity-triggered casting configurations by adding more sections following the same format.

Example:

continuously_casting_dashboards:
  # ...
  state_triggers:
    "Living room display":
        - entity_id: "sensor.samsung_tv"
          to_state: "On"
          dashboard_url: "http://192.168.12.104:8123/tv_remote_dashboard/default_view?kiosk"
        - entity_id: "sensor.samsung_tv"
          to_state: "Off"
          dashboard_url: "http://192.168.12.104:8123/living_room_dashboard/default_view?kiosk"

The first example for the "Living room display" will cast my custom "tv_remote_dashboard" which has my TV remote controls to my Nest Hub when my TV entity reports the status of "On". When the TV turns off and now reports a status of "Off" then my normal "living_room_dashboard" will be casted.

continuously_casting_dashboards:
  # ...
  state_triggers:
    "Office display":
        - entity_id: "binary_sensor.front_door_ring"
          to_state: "Detected"
          dashboard_url: "http://192.168.12.104:8123/cctv_dashboard/default_view?kiosk"
          time_out: 60
          force_cast: true

The second example will cast my custom "cctv_dashboard" which has cameras of the front door when my Ring doorbell is "Detected". I am using the optional "time_out" feature which will stop casting the CCTV display after 60 seconds. Once the dashboard has then stopped casting, the default dashboard will start casting to this display. I also have the 'force_cast' set to 'true' to ensure that even if media is playing on this device, then the CCTV dashboard will be casted.





↕️ Multiple dashboard casting

With this feature, you can configure multiple dashboards to be cast at different times for the same device. To enable this feature, add multiple dashboards and time windows to each devices configuration, for example:

devices:
   ...
     "Office display":
       - dashboard_url: "http://192.168.12.104:8123/day-dashboard/default_view?kiosk"
         volume: 7
         start_time: "07:00" 
         end_time: "00:00"
       - dashboard_url: "http://192.168.12.104:8123/night-dashboard/default_view?kiosk"
         volume: 7
         start_time: "00:01" 
         end_time: "03:00"





🎮Casting control based on entity state

With this feature, you can control if the casting will start or stop based on a boolean HA entity. Firstly, you need to add a new boolean entity inside your configuration.yaml file - for example:

input_boolean:
  ccd_cast:
    name: "CCD cast"
    initial: on

For the above entity we have named it 'ccd_cast' and configured it to be initiallty set to 'on'. This means that if Home Assistant restarts, then casting will always be enabled. And then if we were to switch the entity to 'off' then casting will be stopped.

Now we need to add this entity to the CCD section inside your configuration.yaml file:

continuously_casting_dashboards:
  logging_level: debug
  cast_delay: 25
  start_time: "06:00"
  end_time: "02:00"
  switch_entity_id: "input_boolean.ccd_cast"
  devices:
    ...

We have added the 'switch_entity_id' field to our main section with the CCD configuration.

The naming of the entity if you have followed above will be 'input_boolean.ccd_cast' but change this if you have named yours differently.

That's it! You should be able to now control whether the casting will be stopped/started and you can now use this in automations etc. For example, stopping the casting for when a doorbell detects motion and you want to display something else.



⚠️Troubleshooting