added functionality to receive Events from Openhab and added methods to create and delete openhab items

README.rst

@@ -21,12 +21,21 @@ python library for accessing the openHAB REST API
 This library allows for easily accessing the openHAB REST API.
 A number of features are implemented but not all, this is work in progress.
 
+currently you can
+ - retrieve current state of items
+ - send updates and commands to items
+ - receive commands, updates and changes triggered by openhab
+ - create new items and groups
+ - delete items and groups
+
+
 Requirements
 ------------
 
   - python >= 3.5
   - python :: dateutil
   - python :: requests
+  - python :: sseclient
   - openHAB version 2
 
 Installation
@@ -49,7 +58,7 @@ Example usage of the library:
     from openhab import OpenHAB
 
     base_url = 'http://localhost:8080/rest'
-    openhab = OpenHAB(base_url)
+    openhab = OpenHAB(base_url,autoUpdate=True)
 
     # fetch all items
     items = openhab.fetch_all_items()
@@ -87,6 +96,60 @@ Example usage of the library:
     for v in lights_group.members.values():
       v.update('OFF')
 
+    # receive updates from openhab:
+
+    # fetch a item and keep it
+    testroom1_LampOnOff = openhab.get_item('light_switch')
+
+    #define a callback function to receive events
+    def onLight_switchCommand(item: openhab.items.Item, event: openhab.events.ItemCommandEvent):
+        log.info("########################### COMMAND of {} to {} (itemsvalue:{}) from OPENHAB".format(event.itemname, event.newValueRaw, item.state))
+        if event.source == openhab.events.EventSourceOpenhab:
+            log.info("this change came from openhab")
+    # install listener for evetns
+    testroom1_LampOnOff.add_event_listener(listening_types=openhab.events.ItemCommandEventType, listener=onLight_switchCommand, only_if_eventsource_is_openhab=False)
+    # switch you will receive update also for your changes in the code. (see
+    testroom1_LampOnOff.off()
+
+    #Events stop to be delivered
+    testroom1_LampOnOff=None
+
+
+    #create or delete items:
+    # first instantiate a Factory:
+    itemFactory = openhab.items.ItemFactory(openhab)
+    #create the item
+    testDimmer = itemFactory.create_or_update_item(name="the_testDimmer", data_type=openhab.items.DimmerItem)
+    #use item
+    testDimmer.state=95
+
+
+
+    # you can set change many item attributes:
+    nameprefix="testcase_1_"
+    itemname = "{}CreateItemTest".format(nameprefix)
+    item_quantity_type = "Angle"  # "Length",Temperature,,Pressure,Speed,Intensity,Dimensionless,Angle
+    itemtype = "Number"
+
+    labeltext = "das ist eine testzahl:"
+    itemlabel = "[{labeltext}%.1f °]".format(labeltext=labeltext)
+    itemcategory = "{}TestCategory".format(nameprefix)
+    itemtags: List[str] = ["{}testtag1".format(nameprefix), "{}testtag2".format(nameprefix)]
+    itemgroup_names: List[str] = ["{}testgroup1".format(nameprefix), "{}testgroup2".format(nameprefix)]
+    grouptype = "{}testgrouptype".format(nameprefix)
+    functionname = "{}testfunctionname".format(nameprefix)
+    functionparams: List[str] = ["{}testfunctionnameParam1".format(nameprefix), "{}testfunctionnameParam2".format(nameprefix), "{}testfunctionnameParam3".format(nameprefix)]
+
+    x2 = item_factory.create_or_update_item(name=itemname,
+                                            data_type=itemtype,
+                                            quantity_type=item_quantity_type,
+                                            label=itemlabel,
+                                            category=itemcategory,
+                                            tags=itemtags,
+                                            group_names=itemgroup_names,
+                                            group_type=grouptype,
+                                            function_name=functionname,
+                                            function_params=functionparams)
 
 Note on NULL and UNDEF
 ----------------------