From de20c2e4d635689bffbb985889ca7be713f0af9e Mon Sep 17 00:00:00 2001 From: hoellen Date: Fri, 8 Jan 2021 12:35:09 +0100 Subject: [PATCH] Add sorting order to README --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dc154d2..c9af1cc 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This extension is heavily inspired by the home assistant extesnsion for ulaunche To use this extension, you need the Python `requests` library: -``` +```bash pip install requests ``` @@ -19,8 +19,26 @@ pip install requests You need to specify the URL and [API Key](https://developers.home-assistant.io/docs/api/rest/¦) of your Home Assistant instance in the configuration file (e.g. location: `$HOME/.config/albert/homeassistant_config.json`). You can generate a new long lived API Key by clicking your name in the bottom left in the Home Assistant UI. +Example: +```json +{ + "hass_url": "http://192.168.1.2:8123", + "hass_key": "s1GeOobviEbZS3OjfkYVmOQDMbCRIH0kCtisGVi2EQoKbDeqq" +} +``` + + +The item order is based on the entity class. Lights and switches are shown first, then scenes and groups etc. You can change the order in the configuration file with `sort_order`. See the default sorting order below: +```json +{ ... + sort_order: {"light": 1, "switch": 1, "scene": 2, "group": 2, "automation": 3} +} +``` + ## Usage -` ` +``` + +``` You can see the actions by pressing the `alt` key. @@ -28,7 +46,6 @@ You can see the actions by pressing the `alt` key. - renew icons (.svg) - test more device classes and adjust which service to call - - sort items: name matching first ## Contributing