Version 1.0.16 [skip ci]

- Bump dependencies
- Remove ping functionality in favour of new python-amcrest functionality (closes #33 and #38)
- Fix issue with MQTT publish hanging indefinitely if the app cannot connect to broker
- Display build date in software version (closes #53)

.github/workflows/publish.yml

@@ -12,17 +12,16 @@ jobs:
         runs-on: ubuntu-20.04
         steps:
             - name: Checkout code
-              uses: actions/checkout@v2.3.5
+              uses: actions/checkout@v3
             - name: Bump version
-              uses: chamini2/bump-version@js
+              uses: remorses/bump-version@js
               id: version
               with:
                   version_file: ./VERSION
-                  github_token: ${{ secrets.GITHUB_TOKEN }}
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             - name: Checkout code
-              uses: actions/checkout@v2.3.5
+              uses: actions/checkout@v3
               with:
                   ref: main
             - name: Set up QEMU
@@ -32,12 +31,12 @@ jobs:
             - name: Set up Docker Buildx
               uses: docker/setup-buildx-action@v1.6.0
             - name: Login to DockerHub
-              uses: docker/login-action@v1.10.0
+              uses: docker/login-action@v1.14.1
               with:
                   username: ${{ secrets.DOCKER_USERNAME }}
                   password: ${{ secrets.DOCKER_PASSWORD }}
             - name: Build and push
-              uses: docker/build-push-action@v2.7.0
+              uses: docker/build-push-action@v2.10.0
               with:
                   context: .
                   push: true

Dockerfile

@@ -8,6 +8,7 @@ COPY requirements.txt /
 RUN pip install --no-warn-script-location --prefix=/install -r /requirements.txt
 
 FROM base
+STOPSIGNAL SIGINT
 COPY --from=builder /install /usr/local
 COPY src /app
 COPY VERSION /app

README.md

@@ -20,7 +20,8 @@ It supports the following environment variables:
 -   `MQTT_TLS_KEY` (required if using TLS) - path to the private key
 -   `HOME_ASSISTANT` (optional, default = false)
 -   `HOME_ASSISTANT_PREFIX` (optional, default = 'homeassistant')
--   `STORAGE_POLL_INTERVAL` (optional, default = 3600) - how often to fetch storage data (in seconds)
+-   `STORAGE_POLL_INTERVAL` (optional, default = 3600) - how often to fetch storage data (in seconds) (set to 0 to disable functionality)
+-   `DEVICE_NAME` (optional) - override the default device name used in the Amcrest app
 
 It exposes events to the following topics:
 
@@ -28,6 +29,7 @@ It exposes events to the following topics:
 -   `amcrest2mqtt/[SERIAL_NUMBER]/doorbell` - doorbell status (if AD110 or AD410)
 -   `amcrest2mqtt/[SERIAL_NUMBER]/human` - human detection (if AD410)
 -   `amcrest2mqtt/[SERIAL_NUMBER]/motion` - motion events (if supported)
+-   `amcrest2mqtt/[SERIAL_NUMBER]/config` - device configuration information
 
 ## Device Support
 
@@ -62,12 +64,22 @@ services:
 
 ### Multiple Devices
 
-The app will not support multiple devices. You can run multiple instances of the app if you need to expose events for multiple devies.
+The app will not support multiple devices. You can run multiple instances of the app if you need to expose events for multiple devices.
 
 ### Non-Docker Environments
 
 Docker is the only supported way of deploying the application. The app should run directly via Python but this is not supported.
 
+### Home Assistant Addons
+
+There are a couple of Home Assistant Addons that use my code to be able to port this software into Supervised versions of Home Assistant. I do not specifically support the add-ons themselves, only the base software in the original docker format. Please contact the authors of those add-ons for support if using that method.
+
+https://github.com/ikifar2012/amcrest2mqtt-addon/blob/master/README.md
+[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fikifar2012%2Fha-addons)
+
+https://github.com/robsonke/hassio-addons/blob/master/amcrest2mqtt/README.md
+[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Frobsonke%2Fhassio-addons)
+
 ## Buy Me A ~~Coffee~~ Beer 🍻
 
 A few people have kindly requested a way to donate a small amount of money. If you feel so inclined I've set up a "Buy Me A Coffee"

VERSION

@@ -1 +1 @@
-1.0.10
+1.0.16

requirements.txt

@@ -1,3 +1,3 @@
-amcrest==1.9.3
+amcrest==1.9.7
 paho-mqtt==1.6.1
-python-slugify==5.0.2
+python-slugify==6.1.1

src/amcrest2mqtt.py

@@ -8,6 +8,7 @@ from json import dumps
 import signal
 from threading import Timer
 import ssl
+import asyncio
 
 is_exiting = False
 mqtt_client = None
@@ -17,7 +18,9 @@ amcrest_host = os.getenv("AMCREST_HOST")
 amcrest_port = int(os.getenv("AMCREST_PORT") or 80)
 amcrest_username = os.getenv("AMCREST_USERNAME") or "admin"
 amcrest_password = os.getenv("AMCREST_PASSWORD")
+
 storage_poll_interval = int(os.getenv("STORAGE_POLL_INTERVAL") or 3600)
+device_name = os.getenv("DEVICE_NAME")
 
 mqtt_host = os.getenv("MQTT_HOST") or "localhost"
 mqtt_qos = int(os.getenv("MQTT_QOS") or 0)
@@ -57,8 +60,8 @@ def mqtt_publish(topic, payload, exit_on_error=True, json=False):
     )
 
     if msg.rc == mqtt.MQTT_ERR_SUCCESS:
-        msg.wait_for_publish()
-        return msg
+        msg.wait_for_publish(2)
+        return
 
     log(f"Error publishing MQTT message: {mqtt.error_string(msg.rc)}", level="ERROR")
 
@@ -77,7 +80,6 @@ def exit_gracefully(rc, skip_mqtt=False):
 
     if mqtt_client is not None and mqtt_client.is_connected() and skip_mqtt == False:
         mqtt_publish(topics["status"], "offline", exit_on_error=False)
-        mqtt_client.loop_stop(force=True)
         mqtt_client.disconnect()
 
     # Use os._exit instead of sys.exit to ensure an MQTT disconnect event causes the program to exit correctly as they
@@ -92,19 +94,15 @@ def refresh_storage_sensors():
 
     try:
         storage = camera.storage_all
+
         mqtt_publish(topics["storage_used_percent"], str(storage["used_percent"]))
-        mqtt_publish(topics["storage_used"], str(storage["used"][0]))
-        mqtt_publish(topics["storage_total"], str(storage["total"][0]))
+        mqtt_publish(topics["storage_used"], to_gb(storage["used"]))
+        mqtt_publish(topics["storage_total"], to_gb(storage["total"]))
     except AmcrestError as error:
         log(f"Error fetching storage information {error}", level="WARNING")
 
-def ping_camera():
-    Timer(30, ping_camera).start()
-    response = os.system(f"ping -c1 -W100 {amcrest_host} >/dev/null 2>&1")
-
-    if response != 0:
-        log("Ping unsuccessful", level="ERROR")
-        exit_gracefully(1)
+def to_gb(total):
+    return str(round(float(total[0]) / 1024 / 1024 / 1024, 2))
 
 def signal_handler(sig, frame):
     # exit immediately upon receiving a second SIGINT
@@ -156,7 +154,13 @@ try:
         exit_gracefully(1)
 
     sw_version = camera.software_information[0].replace("version=", "").strip()
+    build_version = camera.software_information[1].strip()
+
+    amcrest_version = f"{sw_version} ({build_version})"
+
+    if not device_name:
         device_name = camera.machine_name.replace("name=", "").strip()
+
     device_slug = slugify(device_name, separator="_")
 except AmcrestError as error:
     log(f"Error fetching camera details", level="ERROR")
@@ -164,7 +168,7 @@ except AmcrestError as error:
 
 log(f"Device type: {device_type}")
 log(f"Serial number: {serial_number}")
-log(f"Software version: {sw_version}")
+log(f"Software version: {amcrest_version}")
 log(f"Device name: {device_name}")
 
 # MQTT topics
@@ -178,13 +182,27 @@ topics = {
     "storage_used": f"amcrest2mqtt/{serial_number}/storage/used",
     "storage_used_percent": f"amcrest2mqtt/{serial_number}/storage/used_percent",
     "storage_total": f"amcrest2mqtt/{serial_number}/storage/total",
-    "home_assistant": {
+    "home_assistant_legacy": {
         "doorbell": f"{home_assistant_prefix}/binary_sensor/amcrest2mqtt-{serial_number}/{device_slug}_doorbell/config",
         "human": f"{home_assistant_prefix}/binary_sensor/amcrest2mqtt-{serial_number}/{device_slug}_human/config",
         "motion": f"{home_assistant_prefix}/binary_sensor/amcrest2mqtt-{serial_number}/{device_slug}_motion/config",
         "storage_used": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/{device_slug}_storage_used/config",
         "storage_used_percent": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/{device_slug}_storage_used_percent/config",
         "storage_total": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/{device_slug}_storage_total/config",
+        "version": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/{device_slug}_version/config",
+        "host": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/{device_slug}_host/config",
+        "serial_number": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/{device_slug}_serial_number/config",
+    },
+    "home_assistant": {
+        "doorbell": f"{home_assistant_prefix}/binary_sensor/amcrest2mqtt-{serial_number}/doorbell/config",
+        "human": f"{home_assistant_prefix}/binary_sensor/amcrest2mqtt-{serial_number}/human/config",
+        "motion": f"{home_assistant_prefix}/binary_sensor/amcrest2mqtt-{serial_number}/motion/config",
+        "storage_used": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/storage_used/config",
+        "storage_used_percent": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/storage_used_percent/config",
+        "storage_total": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/storage_total/config",
+        "version": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/version/config",
+        "host": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/host/config",
+        "serial_number": f"{home_assistant_prefix}/sensor/amcrest2mqtt-{serial_number}/serial_number/config",
     },
 }
 
@@ -234,12 +252,15 @@ if home_assistant:
             "manufacturer": "Amcrest",
             "model": device_type,
             "identifiers": serial_number,
-            "sw_version": sw_version,
+            "sw_version": amcrest_version,
             "via_device": "amcrest2mqtt",
         },
     }
 
     if is_doorbell:
+        doorbell_name = "Doorbell" if device_name == "Doorbell" else f"{device_name} Doorbell"
+
+        mqtt_publish(topics["home_assistant_legacy"]["doorbell"], "")
         mqtt_publish(
             topics["home_assistant"]["doorbell"],
             base_config
@@ -247,13 +268,15 @@ if home_assistant:
                 "state_topic": topics["doorbell"],
                 "payload_on": "on",
                 "payload_off": "off",
-                "name": f"{device_name} Doorbell",
+                "icon": "mdi:doorbell",
+                "name": doorbell_name,
                 "unique_id": f"{serial_number}.doorbell",
             },
             json=True,
         )
 
     if is_ad410:
+        mqtt_publish(topics["home_assistant_legacy"]["human"], "")
         mqtt_publish(
             topics["home_assistant"]["human"],
             base_config
@@ -268,6 +291,7 @@ if home_assistant:
             json=True,
         )
 
+    mqtt_publish(topics["home_assistant_legacy"]["motion"], "")
     mqtt_publish(
         topics["home_assistant"]["motion"],
         base_config
@@ -282,7 +306,56 @@ if home_assistant:
         json=True,
     )
 
+    mqtt_publish(topics["home_assistant_legacy"]["version"], "")
+    mqtt_publish(
+        topics["home_assistant"]["version"],
+        base_config
+        | {
+            "state_topic": topics["config"],
+            "value_template": "{{ value_json.sw_version }}",
+            "icon": "mdi:package-up",
+            "name": f"{device_name} Version",
+            "unique_id": f"{serial_number}.version",
+            "entity_category": "diagnostic",
+            "enabled_by_default": False
+        },
+        json=True,
+    )
+
+    mqtt_publish(topics["home_assistant_legacy"]["serial_number"], "")
+    mqtt_publish(
+        topics["home_assistant"]["serial_number"],
+        base_config
+        | {
+            "state_topic": topics["config"],
+            "value_template": "{{ value_json.serial_number }}",
+            "icon": "mdi:alphabetical-variant",
+            "name": f"{device_name} Serial Number",
+            "unique_id": f"{serial_number}.serial_number",
+            "entity_category": "diagnostic",
+            "enabled_by_default": False
+        },
+        json=True,
+    )
+
+    mqtt_publish(topics["home_assistant_legacy"]["host"], "")
+    mqtt_publish(
+        topics["home_assistant"]["host"],
+        base_config
+        | {
+            "state_topic": topics["config"],
+            "value_template": "{{ value_json.host }}",
+            "icon": "mdi:ip-network",
+            "name": f"{device_name} Host",
+            "unique_id": f"{serial_number}.host",
+            "entity_category": "diagnostic",
+            "enabled_by_default": False
+        },
+        json=True,
+    )
+
     if storage_poll_interval > 0:
+        mqtt_publish(topics["home_assistant_legacy"]["storage_used_percent"], "")
         mqtt_publish(
             topics["home_assistant"]["storage_used_percent"],
             base_config
@@ -291,11 +364,14 @@ if home_assistant:
                 "unit_of_measurement": "%",
                 "icon": "mdi:micro-sd",
                 "name": f"{device_name} Storage Used %",
+                "object_id": f"{device_slug}_storage_used_percent",
                 "unique_id": f"{serial_number}.storage_used_percent",
+                "entity_category": "diagnostic",
             },
             json=True,
         )
 
+        mqtt_publish(topics["home_assistant_legacy"]["storage_used"], "")
         mqtt_publish(
             topics["home_assistant"]["storage_used"],
             base_config
@@ -305,10 +381,12 @@ if home_assistant:
                 "icon": "mdi:micro-sd",
                 "name": f"{device_name} Storage Used",
                 "unique_id": f"{serial_number}.storage_used",
+                "entity_category": "diagnostic",
             },
             json=True,
         )
 
+        mqtt_publish(topics["home_assistant_legacy"]["storage_total"], "")
         mqtt_publish(
             topics["home_assistant"]["storage_total"],
             base_config
@@ -318,6 +396,7 @@ if home_assistant:
                 "icon": "mdi:micro-sd",
                 "name": f"{device_name} Storage Total",
                 "unique_id": f"{serial_number}.storage_total",
+                "entity_category": "diagnostic",
             },
             json=True,
         )
@@ -328,19 +407,19 @@ mqtt_publish(topics["config"], {
     "version": version,
     "device_type": device_type,
     "device_name": device_name,
-    "sw_version": sw_version,
+    "sw_version": amcrest_version,
     "serial_number": serial_number,
+    "host": amcrest_host,
 }, json=True)
 
 if storage_poll_interval > 0:
     refresh_storage_sensors()
 
-ping_camera()
-
 log("Listening for events...")
 
-try:
-    for code, payload in camera.event_actions("All", retries=5, timeout_cmd=(10.00, 3600)):
+async def main():
+    try:
+        async for code, payload in camera.async_event_actions("All"):
             if (is_ad110 and code == "ProfileAlarmTransmit") or (code == "VideoMotion" and not is_ad110):
                 motion_payload = "on" if payload["action"] == "Start" else "off"
                 mqtt_publish(topics["motion"], motion_payload)
@@ -354,6 +433,8 @@ try:
             mqtt_publish(topics["event"], payload, json=True)
             log(str(payload))
 
-except AmcrestError as error:
-    log(f"Amcrest error {error}", level="ERROR")
+    except AmcrestError as error:
+        log(f"Amcrest error: {error}", level="ERROR")
         exit_gracefully(1)
+
+asyncio.run(main())