Rearchitect of integration, fix of multiple issues and many improvements

[msp1974]

In this PR

• Restructure of code to more modulise and allow access to module functions from across code more easily - also fixes issues Remove requirement to restart HA after creation of master config instance #94

• Timers can be set in multi language (local and AI -> selectable in master config) -> google translate/deepl to come -> will need update to Alarms & Timers blueprint to set language - issue Support multi language in VA timers/alarms/reminders #118

• Allow custom URL option for background image - issue Allow user to enter a custom image URL for HTTP based images on clock view #147

• Entities tracked by entity listeners are checked for state on startup and icons set - issue Icons not set on VA satellite reloads #169

• Removal of BM and RAD browser id support - issue Deprecate support of BrowserMod for View Assist #170

• Improvements to browser connection handling - issue Setting up of new device does not navigate to the default dashboard view #171

• Simplified setup and internal type identification for vaca devices

• Update entities will now be created for Views & BPs that are not installed, allowing for notification and install of new ones

• Added optional revert timeout parameter to navigate service call to override default timeout

• New on screen overlay for non registered devices to provide better guidance during initial setup and highlight any missing core plugins that should have been installed as per Wiki instructions

• Added javascript helper function to validate required custom plugins/resources for a view and provide on screen notification if not. Has to be added to the view definition to work.

• Update to clock custom element to display date in local language and format

• Added js helper function to create cards for timers (to support new Timer card)

Further Info

On screen overlay for unregistered devices

For devices that do not have their display ID utilised in a VA instance (will not show on mimic device), the below overlay will show on any view in the View Assist dashboard. It will not show on other dashboards or views. If any of the core HACs resources (card-mod, layout-card and button-card) are not installed, this will be highlighted in red. If all ok, it will be noted in green.

ValidateRequirements helper function

This new helper function can be utilised in a view (using button-card). You can provide either a single string value or a list of string values to this function.

custom_fields:
  error: >-
    [[[ return
    viewassist.helpers.validateRequirements('test2') ]]]

If the resource is not found in the pages custom elements (meaning it is not installed) then a box will be displayed in the middle of the screen to highlight this missing resource.

NOTE: The dashboard needs updating to include the error custom field format as below.

error:
          - position: absolute
          - font-size: 3vw
          - width: 100%
          - text-align: center
          - background-color: var(--error-color)
          - z-index: 3
          - display: flex
          - justify-content: center

Clock Custom Element

A new mode parameter has been added to the clock custom element. Set this parameter to date or time and remove the format parameters to present the date/time in local language and format.

<viewassist-clock server_time=true mode='date'></viewassist-clock>

Navigate Service

A new optional parameter of revert_timeout has been added to the navigate service call. This will override the default timeout to revert the screen if used.

action: view_assist.navigate
data:
  revert_timeout: 10
  device: sensor.lenovo_tsv
  path: view-assist/intent

Timer cards helper function

This is a POC to utilise the JS helper to create dynamic cards for core functions, rather than place this within the card itself or in the dashboard file (as status icons/menu is currently). Whilst it removes the ability for user to tweak these elements, it is expected that they are not really parts that should be user configurable as they are core to making some functions useable.

It is expected that the menu/status icons and the intent objects would follow this method later (in a js file for each one). The generating javascript code is in the timers.js file located in the js_modules directory. Below is the planned timer card to give an overview of how this would be used.

type: custom:button-card
variables:
  timerscardversion: 1.0.0
  var_background: >-
    [[[ try {if (variables.var_assistsat_entity &&
    hass.states[variables.var_assistsat_entity].attributes.mode === "night")
    return ""; else return
    hass.states[variables.var_assistsat_entity].attributes.background} catch
    {return ""}]]]
template:
  - variable_template
  - body_template
styles:
  grid:
    - grid-template-areas: |
        "title status"
        "timers timers"
        "assist assist"
    - grid-template-rows: .5fr 3fr max-content
    - grid-template-columns: 1fr 1fr
  card:
    - background: |-
        [[[ 
          return `center / cover no-repeat url(${variables.var_background})`;
        ]]]
    - background-size: cover
    - background-color: "#24292c"
  custom_fields:
    title:
      - padding: 10px 0
    timers:
      - display: flex
      - justify-self: start
      - padding: 0 5vw
      - z-index: 1
      - font-size: 20vw
      - font-weight: bold
      - color: white
      - max-height: 70vh
      - width: 100%
      - overflow-y: scroll
    shader:
      - position: absolute
      - top: 0
      - height: 100%
      - width: 100%
      - background-color: rgba(0,0,0,0.15)
custom_fields:
  title: Timers & Alarms
  shader: ""
  timers:
    card:
      type: custom:layout-card
      layout_type: custom:vertical-layout
      layout:
        max_cols: 1
      cards: |-
        [[[ 
          return viewassist.helpers.timerCards();
        ]]]

[dinki]

Wow! What a ton of effort! You are absolutely awesome man