From fe1a180e4fdd2c2a6705d2f6ef1eba6c9443f716 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Lov=C3=A9n?= Date: Tue, 9 Feb 2021 23:26:28 +0100 Subject: [PATCH] Add service descriptions --- custom_components/browser_mod/__init__.py | 2 - custom_components/browser_mod/services.yaml | 51 +++++++++++++++++++-- 2 files changed, 47 insertions(+), 6 deletions(-) diff --git a/custom_components/browser_mod/__init__.py b/custom_components/browser_mod/__init__.py index 1423fa2..cc1141c 100644 --- a/custom_components/browser_mod/__init__.py +++ b/custom_components/browser_mod/__init__.py @@ -28,8 +28,6 @@ _LOGGER = logging.getLogger(__name__) async def async_setup(hass, config): - _LOGGER.error(hass.config_entries) - if not hass.config_entries.async_entries(DOMAIN): hass.async_create_task( hass.config_entries.flow.async_init( diff --git a/custom_components/browser_mod/services.yaml b/custom_components/browser_mod/services.yaml index f9225fe..1de3ee6 100644 --- a/custom_components/browser_mod/services.yaml +++ b/custom_components/browser_mod/services.yaml @@ -5,16 +5,31 @@ command: description: 'Command to send' example: 'navigate' deviceID: - description: 'List of receiving browsers' + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' +commands: + description: 'Send several commands to a browser' + fields: + commands: + description: "List of commands to send" + deviceID: + description: '(optional) List of receiving browsers' example: '["99980b13-dabc9563", "office_computer"]' debug: description: 'On all browsers, show a popup, and a javascript alert with the current device ID.' + fields: + deviceID: + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' set_theme: description: 'On all browsers, change the theme.' fields: theme: description: 'Theme to change to' example: '{theme: "clear_light"}' + deviceID: + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' navigate: description: 'Navigate to a path on a browser.' fields: @@ -22,7 +37,7 @@ navigate: description: 'Path to navigate to' example: '/lovelace/1' deviceID: - description: 'List of receiving browsers' + description: '(optional) List of receiving browsers' example: '["99980b13-dabc9563", "office_computer"]' more_info: description: 'Open the more info dialog of an entity on a browser.' @@ -31,7 +46,7 @@ more_info: description: 'Entity to show more info for' example: 'camera.front_door' deviceID: - description: 'List of receiving browsers' + description: '(optional) List of receiving browsers' example: '["99980b13-dabc9563", "office_computer"]' large: description: '(optional) Set to true to make wider' @@ -42,6 +57,9 @@ toast: message: description: 'Message to show' example: 'Short message' + deviceID: + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' duration: description: '(optional) Time in milliseconds to show message for. Set to 0 for persistent display.' example: '10000' @@ -54,7 +72,7 @@ popup: card: description: 'YAML config for card to show' deviceID: - description: 'List of receiving browsers' + description: '(optional) List of receiving browsers' example: '["99980b13-dabc9563", "office_computer"]' large: description: '(optional) Set to true to make wider' @@ -70,16 +88,41 @@ popup: example: '20' close_popup: description: 'Close all popups on all browsers.' + fields: + deviceID: + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' blackout: description: 'Cover screen in black until the mouse is moved or a key is pressed.' fields: time: description: '(optional) The blackout will turn on automatically after the specified number of seconds. It works kind of like a screensaver and will keep turning on until blackout is called again with time: -1.' example: '20' + deviceID: + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' no_blackout: description: 'Remove a blackout from a browser.' fields: brightness: description: '(optional) On a Fully Kiosk Browser Plus set the screen brightness from 0 - 255.' + deviceID: + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' lovelace_reload: description: 'Refresh the lovelace configuration.' + fields: + deviceID: + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' +delay: + description: 'Do nothing for a while' + fields: + seconds: + description: 'Number of seconds to delay' + example: '5' + deviceID: + description: '(optional) List of receiving browsers' + example: '["99980b13-dabc9563", "office_computer"]' + call_service: + description: ""