Skip to content

Commit

Permalink
Add hint for where to find additional documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nielstron committed Dec 9, 2018
1 parent 0275f91 commit 993f8ba
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# PyBLNET - a very basic python BL-NET bridge
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.

### Usage

```python
ip = '192.168.178.10'

# Check if there is a blnet at given address
test_blnet(ip) # -> True/False

# Easy to use high level interface
# Convenient high level interface
blnet = BLNET(ip, timeout=5)

# Control a switch by its ID
Expand Down

0 comments on commit 993f8ba

Please sign in to comment.