Added installation instructions for Home Assistant

Author: puddly

README.md

@@ -9,6 +9,22 @@ Together with zigpy and compatible home automation software (namely Home Assista
 
 This zigpy-znp library allows Zigpy to interact with Texas Instruments ZNP (Zigbee Network Processor) coordinator firmware via TI Z-Stack Monitor and Test(MT) APIs using an UART/serial interface. Radio module hardware compatible include but is possibly not limited to Texas Instruments CC13x2 and CC26x2R based chips flashed with Z-Stack 3.x coordinator firmware.
 
+# Installation
+Install the Python module within your virtual environment:
+
+```shell
+(venv) $ pip install zigpy-znp
+```
+
+If you are using Home Assistant, copy `custom_components/custom_zha_radios.py` into your `custom_components` folder and create a new entry in your `configuration.yaml` file:
+
+```yaml
+custom_zha_radios:
+ znp:
+   module: zigpy_znp.zigbee.application
+   description: TI CC13x2, CC26x2, and ZZH
+```
+
 # Hardware requirements
 USB-adapters, GPIO-modules, and development-boards running recent TI Z-Stack releases (i.e. CC13x2 and CC26x2) are supported. Reference hardware for this project includes:
 

custom_components/custom_zha_radios.py

@@ -0,0 +1,55 @@
+import importlib
+
+from homeassistant.components.zha.core.const import RadioType
+
+
+DOMAIN = "custom_zha_radios"
+
+
+def patch_enum_member(target_enum, name, value):
+    """
+    Don't tell anybody you called this function. Every line is a hack.
+    """
+
+    member = target_enum._member_type_.__new__(target_enum)
+    member._name_ = name
+    member._value_ = value
+
+    if not isinstance(value, tuple):
+        args = (value,)
+    else:
+        args = value
+
+    target_enum.__init__(member, *args)
+
+    target_enum._member_names_.append(name)
+    target_enum._member_map_[name] = member
+    target_enum._value2member_map_[value] = member
+    type.__setattr__(target_enum, name, member)
+
+
+def setup(hass, config):
+    """
+    Injects modules from `custom_zha_radios` into `zha`. For example:
+
+        custom_zha_radios:
+          znp:
+            module: zigpy_znp.zigbee.application
+            description: TI CC13x2, CC26x2, and ZZH
+
+    """
+
+    custom_names = list(config[DOMAIN].keys())
+    original_names = list(RadioType._member_names_)
+
+    for name, obj in config[DOMAIN].items():
+        module = importlib.import_module(obj["module"])
+        app = module.ControllerApplication
+        description = obj["description"]
+
+        patch_enum_member(RadioType, name, (description, app))
+
+    # New keys are moved up top
+    RadioType._member_names_ = custom_names + original_names
+
+    return True