readme, example config

Author: radekjeruzal

README.md

@@ -1,4 +1,18 @@
 HAP-Python (https://github.com/ikalchev/HAP-python) accessories implementation for Satel Integra device controls based on framing and initial bytes array implementation by https://github.com/mkorz/IntegraPy. 
 
 
-Not intended for commercial use.
+Not intended for commercial use.
+
+##Usage
+
+Please make sure your integra ETHM-1 module has enabled Integration setting (port 7094) - that can be achieved through DLOADX.
+
+**Start with listing items** you can spin up as HomeKit accessories:
+
+`python main.py list_integra` 
+
+**Amend** `config.py` providing Integra details and mapping items to available accessory types. List of accessories implemented can be found in `accessories.py`
+
+To **run the server** and create a HomeKit bridge with all your accessories from config:
+
+`python main.py server_start`

accessories.py

@@ -70,7 +70,7 @@ async def run(self):
 
 
 class SmokeSensor(Accessory):
-    """Leak Sensor simplest configuration"""
+    """Smoke Sensor simplest configuration"""
 
     category = CATEGORY_SENSOR
 
@@ -89,7 +89,7 @@ async def run(self):
             self.sensor_char.set_value(0)
 
 class CarbonDioxideSensor(Accessory):
-    """Leak Sensor simplest configuration"""
+    """Carbon Dioxide Sensor simplest configuration"""
 
     category = CATEGORY_SENSOR
 

config.py

@@ -0,0 +1,17 @@
+from collections import namedtuple
+
+Accessory = namedtuple("Accessory", ("name", "number", "accesory_type"))
+
+class Config:
+    # Integra values
+    usercode = "7901"
+    host = "192.168.177.177"
+    port = 7094
+    encoding = "cp1250"
+
+    accessories = [
+        Accessory("Ruch Korytarz", 1, "MotionSensor"),
+        Accessory("Stłuczenia Gabinet", 2, "ContactSensor"), #possibly wrong type
+        Accessory("Dym Strych", 3, "SmokeSensor"),
+    ]
+

main.py

@@ -1,8 +1,10 @@
+import baker
 import logging
 import signal
 from pyhap.accessory import Bridge
 from pyhap.accessory_driver import AccessoryDriver
-
+from integrapy.integra import Integra
+from integrapy.constants import ZONE
 import accessories
 from config import Config
 
@@ -21,14 +23,33 @@ def get_bridge(accesories_list, driver):
     return bridge
 
 
-# Start the accessory on port 51826
-driver = AccessoryDriver(port=51826)
+@baker.command
+def server_start():
+    # Start the accessory on port 51826
+    driver = AccessoryDriver(port=51826)
+
+    # Add whole bridge
+    driver.add_accessory(accessory=get_bridge(Config.accessories, driver))
+
+    # We want SIGTERM (terminate) to be handled by the driver itself,
+    # so that it can gracefully stop the accessory, server and advertising.
+    signal.signal(signal.SIGTERM, driver.signal_handler)
+
+    # Start it!
+    driver.start()
+
 
-driver.add_accessory(accessory=get_bridge(Config.accessories, driver))
+@baker.command
+def list_integra(no=128):
+    # helper method to list mapping between integra based port (for simplicity numbers) and their names
+    integra = Integra(user_code=Config.usercode, host=Config.host, port=Config.port, encoding=Config.encoding)
+    last = int(no)
+    for i in range(1, last + 1):
+        try:
+            print("ZONE " + str(i) + " " + integra.get_name(ZONE, i).name)
+        except Exception: # no more things mapped
+            break
 
-# We want SIGTERM (terminate) to be handled by the driver itself,
-# so that it can gracefully stop the accessory, server and advertising.
-signal.signal(signal.SIGTERM, driver.signal_handler)
 
-# Start it!
-driver.start()
+if __name__ == "__main__":
+    baker.run()

requirements.txt

@@ -1,2 +1,3 @@
 HAP-python==4.6.0
-bitarray==2.3.7
+bitarray==2.3.7
+baker==1.3