about summary refs log tree commit diff
path: root/fun/idual/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fun/idual/README.md')
-rw-r--r--fun/idual/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/fun/idual/README.md b/fun/idual/README.md
new file mode 100644
index 000000000000..922047617f25
--- /dev/null
+++ b/fun/idual/README.md
@@ -0,0 +1,34 @@
+# iDual light control
+
+This folder contains some tooling for controlling iDual LED lights
+(which use infrared controls) using a "Broadlink RM Pro" infrared
+controller.
+
+The supported colour codes of the iDual remote are stored in
+`codes.txt`.
+
+The point of this is to make it possible for me to automate my lights
+in the morning, so that I can actually get out of bed.
+
+## Capturing codes
+
+Capturing codes is relatively easy, assuming that the broadlink device
+is set up:
+
+```python
+import broadlink
+import base64
+
+devices = broadlink.discover(timeout=5)
+devices[0].auth()
+```
+
+For each code, the procedure is as follows:
+
+```python
+devices[0].find_rf_packet()
+# wait until this returns True
+
+devices[0].check_data()
+# this will return the code
+```