about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorAydaen Lynch <aydaen@gmail.com>2017-04-22T19·48-0400
committerMatthew Garrett <mjg59-github@srcf.ucam.org>2017-04-22T19·48-0700
commitd989c27d36aa2b3b2da93be6edb8171221a88096 (patch)
tree686642c8f5ca64f945a56e396d477561d710e714 /README.md
parent5195856200587cc087e7af52db55e1e559e083bf (diff)
Add in AP Mode device setup for new Broadlink devices. (#53)
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3d7598f5d88c..1305ea0f5a7b 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,20 @@ A simple Python API for controlling IR controllers from [Broadlink](http://www.i
 Example use
 -----------
 
+Setup a new device on your local wireless network:
+
+1. Put the device into AP Mode
+  1. Long press the reset button until the blue LED is blinking quickly.
+  2. Long press again until blue LED is blinking slowly.
+  3. Manually connect to the WiFi SSID named BroadlinkProv.
+2. Run setup() and provide your ssid, network password (if secured), and set the security mode
+  1. Security mode options are (0 = none, 1 = WEP, 2 = WPA1, 3 = WPA2, 4 = WPA1/2)
+```
+import broadlink
+
+broadlink.setup('myssid', 'mynetworkpass', 3)
+```
+
 Discover available devices on the local network:
 ```
 import broadlink