Add sorting order to README
This commit is contained in:
parent
8c222d05b3
commit
779d5eb3da
23
README.md
23
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:
|
To use this extension, you need the Python `requests` library:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
pip install requests
|
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 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.
|
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
|
## Usage
|
||||||
`<trigger> <entity search>`
|
```
|
||||||
|
<trigger> <entity search>
|
||||||
|
```
|
||||||
|
|
||||||
You can see the actions by pressing the `alt` key.
|
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)
|
- renew icons (.svg)
|
||||||
- test more device classes and adjust which service to call
|
- test more device classes and adjust which service to call
|
||||||
- sort items: name matching first
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user