add json output to zha_devices

Author: stu247

README.md

@@ -1851,6 +1851,10 @@ data:
   # Optional, field the list is sorted by (example: sort by signal strength)
   csvlabel: rssi
   csvout: ../www/devices.csv
+  # Optional: JSON file to write devices data to - located in /config/json/...
+  json_out: zha_devices.json
+  # Optional: Add timestamp to Filename of JSON file. Defaults to False.
+  json_timestamp: True
   event_done: zha_devices
 ```
 

custom_components/zha_toolkit/params.py

@@ -38,6 +38,8 @@ class USER_PARAMS_consts:  # pylint: disable=too-few-public-methods
     DOWNLOAD = "download"
     PATH = "path"
     USE_CACHE = "use_cache"
+    JSON_OUT = "json_out"
+    JSON_TIMESTAMP = "json_timestamp"
 
 
 class SERVICE_consts:  # pylint: disable=too-few-public-methods
@@ -135,6 +137,8 @@ class INTERNAL_PARAMS_consts:  # pylint: disable=too-few-public-methods
     WRITE_IF_EQUAL = "write_if_equal"
     CSV_FILE = "csvfile"
     CSV_LABEL = "csvlabel"
+    JSON_OUT = "json_out"
+    JSON_TIMESTAMP = "json_timestamp"
     DOWNLOAD = "download"
     PATH = "path"
     USE_CACHE = "use_cache"

custom_components/zha_toolkit/services.yaml

@@ -2549,7 +2549,7 @@ znp_backup:
         boolean:
 zha_devices:
   name: Get/Export Device Information
-  description: Export device information (Response, CSV File, Event)
+  description: Export device information (Response, CSV File, JSON File, Event)
   fields:
     ieee:
       name: Device Reference
@@ -2599,6 +2599,22 @@ zha_devices:
             - user_given_name
             - device_reg_id
             - area_id
+    json_out:
+      name: JSON Filename
+      description: >-
+        Filename of JSON to write read data to.  Written to '/config/json' directory
+      required: false
+      example: zha_devices.json
+      selector:
+        text:
+    json_timestamp:
+      name: JSON Timestamp
+      description: >-
+        Add timestamp to Filename of JSON file. Defaults to False.
+      required: false
+      example: True
+      selector:
+        boolean:
     event_success:
       name: Success Event Name
       description: Event name in case of success

custom_components/zha_toolkit/translations/en.json

@@ -1474,7 +1474,7 @@
     },
     "zha_devices": {
       "name": "Get/Export Device Information",
-      "description": "Export device information (Response, CSV File, Event)",
+      "description": "Export device information (Response, CSV File, JSON File, Event)",
       "fields": {
         "ieee": {
           "name": "Device Reference",
@@ -1492,6 +1492,14 @@
           "name": "CSV Sort Column",
           "description": "Column to sort table by"
         },
+        "json_out": {
+          "name": "JSON Filename",
+          "description": "Filename of JSON to write read data to.  Written to '/config/json' directory"
+        },
+        "json_timestamp": {
+          "name": "JSON Timestamp",
+          "description": "Add timestamp to Filename of JSON file. Defaults to False."
+        },
         "event_success": {
           "name": "Success Event Name",
           "description": "Event name in case of success"

custom_components/zha_toolkit/utils.py

@@ -568,7 +568,7 @@ def dict_to_jsonable(src_dict):
 
 
 def write_json_to_file(
-    data, subdir, fname, desc, listener=None, normalize_name=False
+    data, subdir, fname, desc, listener=None, normalize_name=False, ts=None
 ):
     if listener is None or subdir == "local":
         base_dir = os.path.dirname(__file__)
@@ -579,6 +579,12 @@ def write_json_to_file(
     if not os.path.isdir(out_dir):
         os.mkdir(out_dir)
 
+    if ts is not None:
+        if '.' in fname:
+            base, ext = fname.rsplit('.', 1)
+            fname = base + '_' + ts + '.' + ext
+        else:
+            fname = fname + '_' + ts
     if normalize_name:
         file_name = os.path.join(out_dir, normalize_filename(fname))
     else:
@@ -903,6 +909,8 @@ def extractParams(  # noqa: C901
         p.DOWNLOAD: None,
         p.PATH: None,
         p.USE_CACHE: False,
+        p.JSON_OUT: None,
+        p.JSON_TIMESTAMP: False,
     }
 
     # Endpoint to send command to
@@ -1055,6 +1063,12 @@ def extractParams(  # noqa: C901
     if P.CSVLABEL in rawParams:
         params[p.CSV_LABEL] = rawParams[P.CSVLABEL]
 
+    if P.JSON_OUT in rawParams:
+        params[p.JSON_OUT] = rawParams[P.JSON_OUT]
+
+    if P.JSON_TIMESTAMP in rawParams:
+        params[p.JSON_TIMESTAMP] = rawParams[P.JSON_TIMESTAMP]
+
     return params
 
 

custom_components/zha_toolkit/zha.py

@@ -121,3 +121,18 @@ async def zha_devices(
                 )
         if selectDeviceFields:
             event_data["devices"] = slimmedDevices
+
+    if params[p.JSON_OUT] is not None:
+        timeStamp = None
+        if params[p.JSON_TIMESTAMP] is not None:
+            timeStamp = event_data['start_time'].split('.', 1)[0]
+        u.write_json_to_file(
+            event_data,
+            subdir="json",
+            fname=params[p.JSON_OUT],
+            desc="zha_devices",
+            listener=listener,
+            normalize_name=False,
+            ts=timeStamp
+        )
+