Version 2.3.6

2.3.6

Author: dcapslock

custom_components/browser_mod/browser_mod.js

@@ -416,7 +416,17 @@ function e(e,t,i,o){var s,n=arguments.length,r=n<3?t:null===o?o=Object.getOwnPro
               .settingSelector=${{boolean:{},label:"Hide interaction icon"}}
             ></browser-mod-settings-table>
           </ha-expansion-panel>
-        </div>
+          <ha-expansion-panel
+            .header=${"Save screen state"}
+            .secondary=${"Save screen state when browser is disconnected"}
+            leftChevron
+          >
+            <browser-mod-settings-table
+              .hass=${this.hass}
+              .settingKey=${"saveScreenState"}
+              .settingSelector=${{boolean:{},label:"Save screen state"}}
+            ></browser-mod-settings-table>
+          </ha-expansion-panel>        </div>
       </ha-card>
     `}static get styles(){return r`
       .box {
@@ -436,7 +446,7 @@ function e(e,t,i,o){var s,n=arguments.length,r=n<3?t:null===o?o=Object.getOwnPro
         display: flex;
         align-items: center;
       }
-    `}}e([le()],_e.prototype,"hass",void 0),e([de()],_e.prototype,"_dashboards",void 0),e([de()],_e.prototype,"_editSidebar",void 0),customElements.define("browser-mod-frontend-settings-card",_e);var fe="2.3.5";(async()=>{var e,t,i,o,s,n,r,a,l,d,h,c,u,p,g;await customElements.whenDefined("partial-panel-resolver");const w=document.createElement("partial-panel-resolver")._getRoutes([{component_name:"config",url_path:"a"}]);await(null===(i=null===(t=null===(e=null==w?void 0:w.routes)||void 0===e?void 0:e.a)||void 0===t?void 0:t.load)||void 0===i?void 0:i.call(t)),await customElements.whenDefined("ha-panel-config");const v=document.createElement("ha-panel-config");await(null===(r=null===(n=null===(s=null===(o=null==v?void 0:v.routerOptions)||void 0===o?void 0:o.routes)||void 0===s?void 0:s.dashboard)||void 0===n?void 0:n.load)||void 0===r?void 0:r.call(n)),await(null===(h=null===(d=null===(l=null===(a=null==v?void 0:v.routerOptions)||void 0===a?void 0:a.routes)||void 0===l?void 0:l.general)||void 0===d?void 0:d.load)||void 0===h?void 0:h.call(d)),await(null===(g=null===(p=null===(u=null===(c=null==v?void 0:v.routerOptions)||void 0===c?void 0:c.routes)||void 0===u?void 0:u.entities)||void 0===p?void 0:p.load)||void 0===g?void 0:g.call(p)),await customElements.whenDefined("ha-config-dashboard")})().then((()=>{class t extends se{firstUpdated(){window.addEventListener("browser-mod-config-update",(()=>this.requestUpdate()))}render(){var e;return window.browser_mod?M`
+    `}}e([le()],_e.prototype,"hass",void 0),e([de()],_e.prototype,"_dashboards",void 0),e([de()],_e.prototype,"_editSidebar",void 0),customElements.define("browser-mod-frontend-settings-card",_e);var fe="2.3.6";(async()=>{var e,t,i,o,s,n,r,a,l,d,h,c,u,p,g;await customElements.whenDefined("partial-panel-resolver");const w=document.createElement("partial-panel-resolver")._getRoutes([{component_name:"config",url_path:"a"}]);await(null===(i=null===(t=null===(e=null==w?void 0:w.routes)||void 0===e?void 0:e.a)||void 0===t?void 0:t.load)||void 0===i?void 0:i.call(t)),await customElements.whenDefined("ha-panel-config");const v=document.createElement("ha-panel-config");await(null===(r=null===(n=null===(s=null===(o=null==v?void 0:v.routerOptions)||void 0===o?void 0:o.routes)||void 0===s?void 0:s.dashboard)||void 0===n?void 0:n.load)||void 0===r?void 0:r.call(n)),await(null===(h=null===(d=null===(l=null===(a=null==v?void 0:v.routerOptions)||void 0===a?void 0:a.routes)||void 0===l?void 0:l.general)||void 0===d?void 0:d.load)||void 0===h?void 0:h.call(d)),await(null===(g=null===(p=null===(u=null===(c=null==v?void 0:v.routerOptions)||void 0===c?void 0:c.routes)||void 0===u?void 0:u.entities)||void 0===p?void 0:p.load)||void 0===g?void 0:g.call(p)),await customElements.whenDefined("ha-config-dashboard")})().then((()=>{class t extends se{firstUpdated(){window.addEventListener("browser-mod-config-update",(()=>this.requestUpdate()))}render(){var e;return window.browser_mod?M`
         <ha-top-app-bar-fixed>
           <ha-menu-button
             slot="navigationIcon"

custom_components/browser_mod/browser_mod_panel.js

@@ -13,5 +13,5 @@
   "documentation": "https://github.com/dcapslock/hass-browser_mod/blob/master/README.md",
   "iot_class": "local_push",
   "requirements": [],
-  "version": "2.3.5"
+  "version": "2.3.6"
 }

custom_components/browser_mod/manifest.json

@@ -146,6 +146,11 @@ popup:
       description: Hide timeout progress bar
       selector:
         boolean:
+    allow_nested_more_info:
+      name: Allow nested more-info dialogs
+      description: Allow nested more-info dialogs to be opened from this popup
+      selector:
+        boolean:
     style:
       name: Styles
       description: CSS code to apply to the popup window

custom_components/browser_mod/services.yaml

@@ -23,6 +23,7 @@ class SettingsStoreData:
     hideInteractIcon = attr.ib(type=bool, default=None)
     autoRegister = attr.ib(type=bool, default=None)
     lockRegister = attr.ib(type=bool, default=None)
+    saveScreenState = attr.ib(type=bool, default=None)
 
     @classmethod
     def from_dict(cls, data):

custom_components/browser_mod/store.py

@@ -13,7 +13,7 @@ LocalStorage works basically like cookies in that the information is stored loca
 Registering a _Browser_ as a device will create a Home Assistant Device associated with that browser. The device has the following entities:
 
 - A `media_player` entitiy which will play sound and video through the browser.
-- A `light` entity will turn the screen on or off and controll the brightness if you are using [Fully Kiosk Browser](https://www.fully-kiosk.com/) (FKB). If you are not using FKB the function will be simulated by covering the screen with a black (or semitransparent) box.
+- A `light` entity will turn the screen on or off and controll the brightness if you are using [Fully Kiosk Browser](https://www.fully-kiosk.com/) (FKB). If you are not using FKB the function will be simulated by covering the screen with a black (or semitransparent) box. There is a [Frontend Setting](#frontend-settings-admin-only) to optionally save the browser screen state for a browser.
 - A motion `binary_sensor` which reacts to mouse and/or keyboard activity in the Browser. In FKB this can also react to motion in front of the devices camera.
 - A number of `sensor` and `binary_sensor` entities providing different bits of information about the Browser which you may or may not find useful.
 
@@ -110,7 +110,10 @@ Set the order and hidden items of the sidebar. To change this setting:
 This changes the "Home Assistant" text that is displayed at the top of the sidebar.
 Accepts Jinja [templates](https://www.home-assistant.io/docs/configuration/templating/).
 
-
 ### Hide interaction icon
 
-This hides the icon in the bottom right corner which indicates that you need to interact with the browser window before Browser Mod will function completely.
+This hides the icon in the bottom right corner which indicates that you need to interact with the browser window before Browser Mod will function completely.
+
+### Save screen state
+
+This saves the screen state on browser disconnect and restores on browser reconnect. The screen state (on/off) and brightness are both saved. The state will be saved and restored for all browsers that have this setting applied, including those running Fully Kiosk.

documentation/configuration-panel.md

@@ -202,3 +202,9 @@ data:
         }
 ```
 Or through `card-mod-more-info` or `card-mod-more-info-yaml` in a card-mod theme.
+
+## Nested popups
+
+Except for the option to style nested standard Home Assistant more-info dialogs, nested popups are not supported. To allow for nested Home Assistant more-info dialogs, use the `allow_nested_more_info` paramater of `browser_mod.popup` or custom popup card. 
+
+__NOTE__: If a custom popup card is is in use on the dashboard, the custom popup card is never nested. If you wish to have a nested more-info dialog in this case, use `browser_mod.more_info` with `ignore_popup_card` set to `true` to nest a standard more-info dialog. 

documentation/popups.md

@@ -98,7 +98,88 @@ tap_action:
 
 Services called via `fire-dom-event` or called as a part of a different service call will (by default) _only_ target the current Browser (even if it's not registered).
 
+# Actions
 
+Wherever an action is used (`*_action:` in `browser_mod.popup` and `action:` in `browser_mod.notification`), both old style `service:` and new style `action:` can be used. Also actions can be a list allowing for several actions to be called. This can be useful if you only have server actions to run. Otherwise, if you have browser calls you are best to use `broswer_mod.sequence`.
+
+All styles below are valid since Version 2.3.6.
+
+#### New Style
+```yaml
+action: browser_mod.popup
+data:
+  content: Popup Content
+  right_button: Toggle Light
+  right_button_action:
+    action: light.toggle
+    target:
+      entity_id: light.bed_light
+```
+
+#### New style with action list
+```yaml
+action: browser_mod.popup
+data:
+  content: Popup Content
+  right_button: Wakeup
+  right_button_action:
+    - action: light.turn_off
+      target:
+        entity_id: light.bed_light
+    - action: cover.open_cover
+      target:
+        entity_id: cover.kitchen_cover
+```
+
+#### Old Style
+```yaml
+action: browser_mod.popup
+data:
+  content: Popup Content
+  right_button: Toggle Light
+  right_button_action:
+    service: light.toggle
+    data:
+      entity_id: light.bed_light
+```
+
+It is possible to allow for fields in scripts/blueprints to use the `action:` selector and then pass directly to any action parameter. __NOTE__: Only `action:` actions are supported by Browser Mod at this time, whereas the `action:` selector may return other automation building blocks. Use at your own risk checking for any action call errors in the local browser console while testing your installation. See below for a simple example.
+
+#### Script
+```yaml
+alias: Example Browser Mod using Action field
+description: ""
+fields:
+  action:
+    selector:
+      action: {}
+    name: Action
+    required: true
+sequence:
+  - action: browser_mod.popup
+    data:
+      content: Popup Content
+      right_button: Call Action
+      right_button_action: "{{ action }}"
+```
+
+Yaml after testing up script in developer tools, using the action selector. You will note the actions are returned as a list which is supported.
+
+```yaml
+action: script.example_browser_mod_using_action_field
+data:
+  action:
+    - action: light.turn_off
+      metadata: {}
+      data: {}
+      target:
+        entity_id: light.bed_light
+    - action: cover.open_cover
+      metadata: {}
+      data: {}
+      target:
+        entity_id: cover.kitchen_cover
+```
 
 # Browser Mod Services
 
@@ -171,6 +252,7 @@ data:
   [timeout: <number>]
   [timeout_action: <service call>]
   [timeout_hide_progress: <true/FALSE>]
+  [allow_nested_more_info: <true/FALSE>]
   [style: <string>]
   [browser_id: <Browser IDs>]
   [user_id: <User IDs]
@@ -191,9 +273,10 @@ data:
 | `timeout` | If set will close the dialog after `timeout` milliseconds. |
 | `timeout_action` | An action to perform if the dialog is closed by timeout. |
 | `timeout_hide_progress` | If true the timeout progress bar will be hidden. |
+| `allow_nested_more_info` | If true nested Home Assistant more-info popups are allowed without closing the popup. |
 | `style` | CSS styles to apply to the dialog. |
 
-Note that any Browser Mod services performed as `_action`s here will be performed only on the same Browser as initiated the action unless `browser_id` is given.
+Note that any Browser Mod services performed as `_action`s here will be performed only on the same Browser as initiated the action unless `browser_id` or `user_id` is given.
 
 If a ha-form schema is used for `content` the resulting data will be inserted into the `data` for any `_action`.
 

documentation/services.md

@@ -243,7 +243,20 @@ class BrowserModFrontendSettingsCard extends LitElement {
               }}
             ></browser-mod-settings-table>
           </ha-expansion-panel>
-        </div>
+          <ha-expansion-panel
+            .header=${"Save screen state"}
+            .secondary=${"Save screen state when browser is disconnected"}
+            leftChevron
+          >
+            <browser-mod-settings-table
+              .hass=${this.hass}
+              .settingKey=${"saveScreenState"}
+              .settingSelector=${{
+                boolean: {},
+                label: "Save screen state",
+              }}
+            ></browser-mod-settings-table>
+          </ha-expansion-panel>        </div>
       </ha-card>
     `;
   }

js/config_panel/frontend-settings-card.ts

@@ -71,18 +71,46 @@ export async function getLovelaceRoot(document) {
   }
 }
 
-export async function getMoreInfoDialogHADialog() {
-  const base: any = await hass_base_el();
-  let haDialog = undefined;
-  if (base) {
-    const dialog: any = base.shadowRoot.querySelector(
-      "ha-more-info-dialog"
-    );
-    if (dialog) {
-      haDialog = dialog.shadowRoot.querySelector("ha-dialog");
+export async function getMoreInfoDialog(wait = false) {
+  let _moreInfoDialog = await _getMoreInfoDialog();
+  while (wait && !_moreInfoDialog) {
+    await new Promise((resolve) => setTimeout(resolve, 100));
+    _moreInfoDialog = await _getMoreInfoDialog();
+  }
+  return _moreInfoDialog;
+  
+  async function _getMoreInfoDialog()
+  {  
+    const base: any = await hass_base_el();
+    let moreInfoDialog;
+    if (base) {
+      moreInfoDialog = base.shadowRoot.querySelector(
+        "ha-more-info-dialog"
+      );
+    }
+    return moreInfoDialog;
+  }
+}
+
+export async function getMoreInfoDialogHADialog(wait = false) {
+  let _haDialog: any = await _getMoreInfoDialogHADialog(wait);
+  while (wait && !_haDialog) {
+    await new Promise((resolve) => setTimeout(resolve, 100));
+    _haDialog = await _getMoreInfoDialogHADialog(wait);
+  }
+  return _haDialog;
+
+  async function _getMoreInfoDialogHADialog(wait = false)
+  {  
+    const moreInfoDialog: any = await getMoreInfoDialog(wait);
+    let haDialog;
+    if (moreInfoDialog) {
+      haDialog = moreInfoDialog.shadowRoot.querySelector(
+        "ha-dialog"
+      );
     }
+    return haDialog;
   }
-  return haDialog;
 }
 
 export async function hass_base_el() {