Add support for overriding device name and add optional additional entities

[ci skip]: Bump docker/login-action from 1.10.0 to 1.12.0

.github/workflows/publish.yml

@@ -12,27 +12,33 @@ jobs:
         runs-on: ubuntu-20.04
         steps:
             - name: Checkout code
-              uses: actions/checkout@v2.3.4
+              uses: actions/checkout@v2.4.0
             - name: Bump version
               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.4.0
+              with:
+                  ref: main
             - name: Set up QEMU
               uses: docker/setup-qemu-action@v1.2.0
+              with:
+                  platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/ppc64le,linux/s390x
             - name: Set up Docker Buildx
-              uses: docker/setup-buildx-action@v1.3.0
+              uses: docker/setup-buildx-action@v1.6.0
             - name: Login to DockerHub
-              uses: docker/login-action@v1.9.0
+              uses: docker/login-action@v1.12.0
               with:
                   username: ${{ secrets.DOCKER_USERNAME }}
                   password: ${{ secrets.DOCKER_PASSWORD }}
             - name: Build and push
-              uses: docker/build-push-action@v2.5.0
+              uses: docker/build-push-action@v2.7.0
               with:
+                  context: .
                   push: true
                   platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/ppc64le,linux/s390x
                   tags: |

Dockerfile

@@ -5,11 +5,13 @@ RUN mkdir /install
 WORKDIR /install
 
 COPY requirements.txt /
-RUN pip install --prefix=/install -r /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
 WORKDIR /app
 
 CMD [ "python", "-u", "/app/amcrest2mqtt.py" ]

README.md

@@ -14,8 +14,14 @@ It supports the following environment variables:
 -   `MQTT_HOST` (optional, default = 'localhost')
 -   `MQTT_QOS` (optional, default = 0)
 -   `MQTT_PORT` (optional, default = 1883)
+-   `MQTT_TLS_ENABLED` (required if using TLS) - set to `true` to enable
+-   `MQTT_TLS_CA_CERT` (required if using TLS) - path to the ca certs
+-   `MQTT_TLS_CERT` (required if using TLS) - path to the private cert
+-   `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)
+-   `DEVICE_NAME` (optional) - override the default device name used in the Amcrest app
 
 It exposes events to the following topics:
 
@@ -23,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
 
@@ -57,7 +64,7 @@ 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
 

VERSION

@@ -1 +1 @@
-1.0.0
+1.0.13

requirements.txt

@@ -1,3 +1,3 @@
-amcrest==1.7.2
+amcrest==1.9.3
-paho-mqtt==1.5.1
+paho-mqtt==1.6.1
 python-slugify==5.0.2

src/amcrest2mqtt.py

@@ -7,8 +7,8 @@ import sys
 from json import dumps
 import signal
 from threading import Timer
+import ssl
 
-storage_sensors_interval = 60  # 1 hour
 is_exiting = False
 mqtt_client = None
 
@@ -18,15 +18,34 @@ 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)
 mqtt_port = int(os.getenv("MQTT_PORT") or 1883)
 mqtt_username = os.getenv("MQTT_USERNAME")
 mqtt_password = os.getenv("MQTT_PASSWORD")  # can be None
+mqtt_tls_enabled = os.getenv("MQTT_TLS_ENABLED") == "true"
+mqtt_tls_ca_cert = os.getenv("MQTT_TLS_CA_CERT")
+mqtt_tls_cert = os.getenv("MQTT_TLS_CERT")
+mqtt_tls_key = os.getenv("MQTT_TLS_KEY")
 
 home_assistant = os.getenv("HOME_ASSISTANT") == "true"
 home_assistant_prefix = os.getenv("HOME_ASSISTANT_PREFIX") or "homeassistant"
 
+def read_file(file_name):
+    with open(file_name, 'r') as file:
+        data = file.read().replace('\n', '')
+
+    return data
+
+def read_version():
+    if os.path.isfile("./VERSION"):
+        return read_file("./VERSION")
+
+    return read_file("../VERSION")
+
 # Helper functions and callbacks
 def log(msg, level="INFO"):
     ts = datetime.now(timezone.utc).strftime("%d/%m/%Y %H:%M:%S")
@@ -56,6 +75,8 @@ def on_mqtt_disconnect(client, userdata, rc):
 def exit_gracefully(rc, skip_mqtt=False):
     global topics, mqtt_client
 
+    log("Exiting app...")
+
     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)
@@ -66,19 +87,31 @@ def exit_gracefully(rc, skip_mqtt=False):
     os._exit(rc)
 
 def refresh_storage_sensors():
-    global camera, topics, storage_sensors_interval
+    global camera, topics, storage_poll_interval
 
-    Timer(storage_sensors_interval, refresh_storage_sensors).start()
+    Timer(storage_poll_interval, refresh_storage_sensors).start()
     log("Fetching 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_used"], to_gb(storage["used"]))
-        mqtt_publish(topics["storage_total"], str(storage["total"][0]))
+        mqtt_publish(topics["storage_total"], to_gb(storage["total"]))
     except AmcrestError as error:
         log(f"Error fetching storage information {error}", level="WARNING")
 
+def to_gb(total):
+    return str(round(float(total[0]) / 1024 / 1024 / 1024, 2))
+
+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 signal_handler(sig, frame):
     # exit immediately upon receiving a second SIGINT
     global is_exiting
@@ -102,6 +135,10 @@ if mqtt_username is None:
     log("Please set the MQTT_USERNAME environment variable", level="ERROR")
     sys.exit(1)
 
+version = read_version()
+
+log(f"App Version: {version}")
+
 # Handle interruptions
 signal.signal(signal.SIGINT, signal_handler)
 
@@ -113,14 +150,25 @@ camera = AmcrestCamera(
 # Fetch camera details
 log("Fetching camera details...")
 
-device_type = camera.device_type.replace("type=", "").strip()
+try:
-is_ad110 = device_type == "AD110"
+    device_type = camera.device_type.replace("type=", "").strip()
-is_ad410 = device_type == "AD410"
+    is_ad110 = device_type == "AD110"
-is_doorbell = is_ad110 or is_ad410
+    is_ad410 = device_type == "AD410"
-serial_number = camera.serial_number.strip()
+    is_doorbell = is_ad110 or is_ad410
-sw_version = camera.software_information[0].replace("version=", "").strip()
+    serial_number = camera.serial_number
-device_name = camera.machine_name.replace("name=", "").strip()
+
-device_slug = slugify(device_name, separator="_")
+    if not isinstance(serial_number, str):
+        log(f"Error fetching serial number", level="ERROR")
+        exit_gracefully(1)
+
+    sw_version = camera.software_information[0].replace("version=", "").strip()
+    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")
+    exit_gracefully(1)
 
 log(f"Device type: {device_type}")
 log(f"Serial number: {serial_number}")
@@ -129,6 +177,7 @@ log(f"Device name: {device_name}")
 
 # MQTT topics
 topics = {
+    "config": f"amcrest2mqtt/{serial_number}/config",
     "status": f"amcrest2mqtt/{serial_number}/status",
     "event": f"amcrest2mqtt/{serial_number}/event",
     "motion": f"amcrest2mqtt/{serial_number}/motion",
@@ -144,6 +193,9 @@ topics = {
         "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",
     },
 }
 
@@ -152,8 +204,27 @@ mqtt_client = mqtt.Client(
     client_id=f"amcrest2mqtt_{serial_number}", clean_session=False
 )
 mqtt_client.on_disconnect = on_mqtt_disconnect
-mqtt_client.username_pw_set(mqtt_username, password=mqtt_password)
 mqtt_client.will_set(topics["status"], payload="offline", qos=mqtt_qos, retain=True)
+if mqtt_tls_enabled:
+    log(f"Setting up MQTT for TLS")
+    if mqtt_tls_ca_cert is None:
+        log("Missing var: MQTT_TLS_CA_CERT", level="ERROR")
+        sys.exit(1)
+    if mqtt_tls_cert is None:
+        log("Missing var: MQTT_TLS_CERT", level="ERROR")
+        sys.exit(1)
+    if mqtt_tls_cert is None:
+        log("Missing var: MQTT_TLS_KEY", level="ERROR")
+        sys.exit(1)
+    mqtt_client.tls_set(
+        ca_certs=mqtt_tls_ca_cert,
+        certfile=mqtt_tls_cert,
+        keyfile=mqtt_tls_key,
+        cert_reqs=ssl.CERT_REQUIRED,
+        tls_version=ssl.PROTOCOL_TLS,
+    )
+else:
+    mqtt_client.username_pw_set(mqtt_username, password=mqtt_password)
 
 try:
     mqtt_client.connect(mqtt_host, port=mqtt_port)
@@ -187,6 +258,7 @@ if home_assistant:
                 "state_topic": topics["doorbell"],
                 "payload_on": "on",
                 "payload_off": "off",
+                "icon": "mdi:doorbell",
                 "name": f"{device_name} Doorbell",
                 "unique_id": f"{serial_number}.doorbell",
             },
@@ -223,52 +295,113 @@ if home_assistant:
     )
 
     mqtt_publish(
-        topics["home_assistant"]["storage_used_percent"],
+        topics["home_assistant"]["version"],
         base_config
         | {
-            "state_topic": topics["storage_used_percent"],
+            "state_topic": topics["config"],
-            "unit_of_measurement": "%",
+            "value_template": "{{ value_json.sw_version }}",
-            "icon": "mdi:micro-sd",
+            "icon": "mdi:package-up",
-            "name": f"{device_name} Storage Used %",
+            "name": f"{device_name} Version",
-            "unique_id": f"{serial_number}.storage_used_percent",
+            "unique_id": f"{serial_number}.version",
+            "entity_category": "diagnostic",
+            "enabled_by_default": False
         },
         json=True,
     )
 
     mqtt_publish(
-        topics["home_assistant"]["storage_used"],
+        topics["home_assistant"]["serial_number"],
         base_config
         | {
-            "state_topic": topics["storage_used"],
+            "state_topic": topics["config"],
-            "unit_of_measurement": "GB",
+            "value_template": "{{ value_json.serial_number }}",
-            "icon": "mdi:micro-sd",
+            "icon": "mdi:alphabetical-variant",
-            "name": f"{device_name} Storage Used",
+            "name": f"{device_name} Serial Number",
-            "unique_id": f"{serial_number}.storage_used",
+            "unique_id": f"{serial_number}.serial_number",
+            "entity_category": "diagnostic",
+            "enabled_by_default": False
         },
         json=True,
     )
 
     mqtt_publish(
-        topics["home_assistant"]["storage_total"],
+        topics["home_assistant"]["host"],
         base_config
         | {
-            "state_topic": topics["storage_total"],
+            "state_topic": topics["config"],
-            "unit_of_measurement": "GB",
+            "value_template": "{{ value_json.host }}",
-            "icon": "mdi:micro-sd",
+            "icon": "mdi:ip-network",
-            "name": f"{device_name} Storage Total",
+            "name": f"{device_name} Host",
-            "unique_id": f"{serial_number}.storage_total",
+            "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"]["storage_used_percent"],
+            base_config
+            | {
+                "state_topic": topics["storage_used_percent"],
+                "unit_of_measurement": "%",
+                "icon": "mdi:micro-sd",
+                "name": f"{device_name} Storage Used %",
+                "unique_id": f"{serial_number}.storage_used_percent",
+                "entity_category": "diagnostic",
+            },
+            json=True,
+        )
+
+        mqtt_publish(
+            topics["home_assistant"]["storage_used"],
+            base_config
+            | {
+                "state_topic": topics["storage_used"],
+                "unit_of_measurement": "GB",
+                "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"]["storage_total"],
+            base_config
+            | {
+                "state_topic": topics["storage_total"],
+                "unit_of_measurement": "GB",
+                "icon": "mdi:micro-sd",
+                "name": f"{device_name} Storage Total",
+                "unique_id": f"{serial_number}.storage_total",
+                "entity_category": "diagnostic",
+            },
+            json=True,
+        )
+
 # Main loop
 mqtt_publish(topics["status"], "online")
-refresh_storage_sensors()
+mqtt_publish(topics["config"], {
+    "version": version,
+    "device_type": device_type,
+    "device_name": device_name,
+    "sw_version": sw_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):
+    for code, payload in camera.event_actions("All", retries=5, timeout_cmd=(10.00, 3600)):
         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)