Show connection errors in Albert log

README.md

@@ -2,15 +2,15 @@
 
 An [Albert](https://albertlauncher.github.io/) extention to view and control devices in your [HomeAssistant](https://www.home-assistant.io/) instance.
 
-This extension is heavily inspired by the home assistant extesnsion for ulauncher from [qcasey](https://github.com/qcasey/ulauncher-homeassistant).
+This extension is heavily inspired by the home assistant extension for ulauncher from [qcasey](https://github.com/qcasey/ulauncher-homeassistant).
 
-![Demo](./ha_demo.gif)
+![Demo](./ha_demo.mp4)
 
 ## Requirements
 
 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
-`<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
 

__init__.py

@@ -18,11 +18,10 @@ __py_deps__ =["requests"]
 
 
 # global variables
+config = {}
 configurationFileName = "homeassistant_config.json"
 configuration_directory = os.path.join(configLocation())
 configuration_file = os.path.join(configuration_directory, configurationFileName)
-config = {}
-#config["sort_order"] = [["light", "switch"], ["scene", "group"], ["automation"]]
 config["sort_order"] = {"light": 1, "switch": 1, "scene": 2, "group": 2, "automation": 3}
 
 icon_files = {
@@ -35,7 +34,7 @@ icon_files = {
     "switch": "icons/switch.png",
 }
 
-toggle_types = ["light", "switch", "automation", "group", "input_boolean", "climate", "camera"]
+toggle_types = ["light", "switch", "automation", "group", "script", "input_boolean", "climate", "camera"]
 on_off_types = ["scene", "media_player"] # use turn_{on,off} instead of toggle
 
 
@@ -59,6 +58,15 @@ def initialize():
         except OSError:
             critical("There was an error making the directory: %s" % configuration_directory)
 
+    # Set up HASS state query
+    config["hass_url"] = config["hass_url"].strip("/")
+    config["state_query"] = config["hass_url"] + "/api/states"
+    config["headers"]= {
+        "Authorization": "Bearer " + config["hass_key"],
+        "content-type": "application/json",
+    }
+
+    # Set up sort_order
     config["sort_order"]["."] = 999 # Wildcard for sorting
     config["sort_order"] = RegexDict(config["sort_order"])
 
@@ -91,8 +99,6 @@ def handleQuery(query):
                     text="Invalid Home Assistant URL",
                      subtext=config["hass_url"])
 
-        # Trim hass URL
-        config["hass_url"] = config["hass_url"].strip("/")
 
         if "hass_key" not in config or not config["hass_key"]:
             return Item(id=__title__,
@@ -113,39 +119,31 @@ def showEntities(query):
         return Item(id=__title__,
                 icon=os.path.dirname(__file__) + "/" + icon_files["logo"],
                 text=__title__,
-                subtext="Enter a query to control your Home Assistant",
+                subtext="Enter the name of the entity which you want to control",
                 actions=[UrlAction("Open in Browser", config["hass_url"])])
 
-    action_word = query.string.split()[0].lower().strip()
-    #is_action_word = action_word in action_words
-    entity_query_list = query.string.split()#[1:] if is_action_word else query.string.split()
-
-    if not entity_query_list:
-        return Item(id=__title__,
-                icon=os.path.dirname(__file__) + "/" + icon_files["logo"],
-                text="Enter the name of the entity which you want to control",
-                subtext="Open Home Assistant in Browser",
-                actions=[UrlAction("Open in Browser", config["hass_url"])])
-
-
-    # Set up HASS state query
-    state_query = config["hass_url"] + "/api/states"
-    headers = {
-        "Authorization": "Bearer " + config["hass_key"],
-        "content-type": "application/json",
-    }
+    entity_query_list = query.string.split()
 
+    # Query entities from HASS
     try:
-        response = requests.get(state_query, headers=headers)
+        response = requests.get(config["state_query"], headers=config["headers"])
         response.raise_for_status()
     except requests.exceptions.RequestException as error:
+        critical(str(error))
         return Item(id=__title__,
                 icon=os.path.dirname(__file__) + "/" + icon_files["logo"],
                 text="Error while getting entity states from Home Assistant",
                 subtext=str(error))
 
-    # Sort entries
-    entities = sorted(response.json(), key=lambda e: config["sort_order"].get_matching(e["entity_id"].split(".")[0]))
+    # Sort entries by class
+    entities = sorted(response.json(), key=lambda e:
+            config["sort_order"].get_matching(e["entity_id"].split(".")[0]))
+
+    # Sort entries by query matching
+    entities = sorted(entities, key=lambda e:
+            RegexDict({query.string.lower() + ".": 0, ".": 1})
+            .get_matching(e["attributes"]["friendly_name"].lower()
+                if "friendly_name" in e["attributes"] else e["entity_id"]))
 
     # Parse all entities and states
     for entity in entities:
@@ -187,8 +185,6 @@ def showEntities(query):
         data = {
             "endpoint": "{}/api/services/".format(config["hass_url"]),
             "service_data": {"entity_id": entity["entity_id"]},
-            "hass_key": config["hass_key"],
-            "headers": headers,
         }
         state         = entity["state"]
         state_colored = "<font color=\"{}\">{}</font>".format(
@@ -196,6 +192,13 @@ def showEntities(query):
             "Red" if entity["state"] == "off" else "",
             entity["state"].capitalize()
         )
+
+        if state == "unavailable" and "unavailable" not in entity:
+            entity["unavailable"] = True
+            entities.append(entity)
+            continue
+
+        # Build item for list
         item = Item(id=__title__,
             icon=entity_icon,
             text=entity["attributes"]["friendly_name"],
@@ -203,6 +206,7 @@ def showEntities(query):
             subtext="%s&nbsp;&nbsp;|&nbsp;&nbsp;%s" % (state_colored, entity_class.capitalize())
         )
 
+        # Add actions depending on class
         if entity_class in toggle_types:
             item.addAction(FuncAction("Toggle", lambda d=data: sendCommand(d, "homeassistant/toggle")))
 
@@ -212,13 +216,16 @@ def showEntities(query):
 
         if entity_class == "cover":
             open_or_close = "open" if state != "open" else "close"
-            item.addAction(FuncAction("%s Cover" % (open_or_close.capitalize()), lambda d=data: sendCommand(d, "homeassistant/cover/%s_cover") % (open_or_close)))
+            item.addAction(FuncAction("%s Cover" % (open_or_close.capitalize()), lambda d=data: sendCommand(d, "cover/%s_cover") % (open_or_close)))
+
+        if entity_class == "automation":
+            item.addAction(FuncAction("Trigger", lambda d=data: sendCommand(d, "automation/trigger")))
 
         item.addAction(ClipAction("Copy ID", entity["entity_id"]))
 
         results.append(item)
 
-    # no entity found
+    # No entity found
     if len(results) == 0:
         results.append(
             Item(id=__title__,
@@ -235,19 +242,18 @@ def sendCommand(data, service):
     data["endpoint"] += service
     debug(__title__ + ": Sending command \"" + service + "\" to " + data["service_data"]["entity_id"])
 
-
     # Make POST request to HA service
     try:
         response = requests.post(
             data["endpoint"],
             data=json.dumps(data["service_data"]),
-            headers=data["headers"],
+            headers=config["headers"],
         )
         response.raise_for_status()
     except requests.exceptions.RequestException as error:
         warning("Error while sending command to Home Assistant:\n%s" % (str(error)))
 
-# New class to match dict keys with regex
+# New dictionary class to match keys with regex
 class RegexDict(dict):
     def get_matching(self, event):
         return next(self[key] for key in self if re.match(key, event))