From e7d61c938c7a3100f4816e79bcbac28e06c5a542 Mon Sep 17 00:00:00 2001
From: Barwise <clacktronics@gmail.com>
Date: Wed, 10 Aug 2016 11:17:05 +0100
Subject: [PATCH] created Readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..53cec32
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+#pyb_DMX
+This module tries to make it slightly simpler to send DMX512 messages to lights
+
+Here is a very simple example of how it works, ideally ```write_frame()``` should be done on a timer interrupt as DMX lights expect a regular message
+
+```python
+# create a dmx device on UART port 1
+dmx1 = dmx.universe(1)
+
+# Set the channel(s) to the value you want
+DMX1.set_channels({1:i})
+
+# Send the message
+DMX1.write_frame()
+```
+
+thanks to this website for useful details
+[http://www.ubasics.com/DMX-512]