Add sorting order to README

This commit is contained in:
hoellen 2021-01-08 12:35:09 +01:00
parent 8c222d05b3
commit f13d3d2d9b

View File

@ -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:
```
{
"hass_url": "http://192.168.1.2:8123",
"hass_key": "s1GeOobviEbg019H32dTs973GU2sJ3zBIMETxKSLCzoJulgljXB31m1aqq2GFWe2TsaLRxYo0J08FHxEdXxzSzNJMNZS3OjfkYVmOQDMbCRIH0kCtisGVi2EQoKbDeqq"
}
```
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
`<trigger> <entity search>`
```
<trigger> <entity search>
```
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