Merge 659c532 into 9f2c151

README.md

@@ -3,31 +3,56 @@
 [![Coverage Status](https://coveralls.io/repos/github/nielstron/pyblnet/badge.svg?branch=master)](https://coveralls.io/github/nielstron/pyblnet?branch=master)
 
 A package that connects to the BL-NET that is connected itself to a UVR1611 device by Technische Alternative. 
-It is able to read digital and analog values as well as to set switches to ON/OFF/AUTO
+It is able to read digital and analog values as well as to set switches to ON/OFF/AUTO.
+
+Documentation on the modules and their methods can be found with the methods and modules themselves.
+
+Two interfaces to BLNet exist and both are supported:
+- Webinterface  - Class BLnetWeb
+- BLNet-Direct protocol ([1]) - Class BLNETDirect
+
+The class BLNET is a wrapper around the two classes. When initializing the class, the two interfaces can be activated/deactivated. 
+BLNetDirect provides 'analog', 'digital',  'speed', 'energy', 'power', whereas BLnetWeb supports 'analog' and 'digital' only. If both are active, BLNetDirect has priority.
+
+### Usage
 
 ```python
 ip = '192.168.178.10'
 
 # Check if there is a blnet at given address
-print(test_blnet(ip))
+test_blnet(ip) # -> True/False
 
-# Easy to use high level interface
+# Convenient high level interface
 blnet = BLNET(ip, timeout=5)
-print(blnet.turn_on(10))
+
+# Control a switch by its ID
+blnet.turn_on(10)
+blnet.turn_auto(10)
+blnet.turn_off(10)
+
+# Fetch data (contains all available data using enabled interfaces)
 print(blnet.fetch())
 
+
+
+# The low level modules are also available
+# note that the direct use of these modules is discouraged though
+
 # Fetch the latest data via web interface
 blnet = BLNETWeb(ip, timeout=5)
 print(blnet.read_analog_values())
 print(blnet.read_digital_values())
 
 # For publishing values
-#print(blnet.set_digital_value("10", 'AUS'))
-#print(blnet.read_digital_values())
+blnet.set_digital_value('10', 'AUS')
 
+# Fetch data via the Protocol developed by TA
 blnet = BLNETDirect(ip)
-# Fetching the latest data from the backend
+# Fetching the latest data
 print(blnet.get_latest())
 # Still inofficial because unexplicably failing often
 print(blnet._get_data(1))
 ```
+
+
+[1] https://www.haus-terra.at/heizung/download/Schnittstelle/Schnittstelle_PC_Bootloader.pdf