summaryrefslogtreecommitdiff
path: root/mesecons_luacontroller/help/events.txt
diff options
context:
space:
mode:
Diffstat (limited to 'mesecons_luacontroller/help/events.txt')
-rw-r--r--mesecons_luacontroller/help/events.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/mesecons_luacontroller/help/events.txt b/mesecons_luacontroller/help/events.txt
new file mode 100644
index 0000000..cd2bcef
--- /dev/null
+++ b/mesecons_luacontroller/help/events.txt
@@ -0,0 +1,12 @@
+Events
+======
+
+Unlike some other types of programs, Luacontroller programs cannot run continously.
+Instead, they run whenever something (an event) happens, and an "event" table is made available with details.
+
+Event types include:
+* 'program' - Program was loaded
+* 'on' and 'off' - A Mesecons pin changed on/off state
+* 'digiline' (if Digilines is installed) - A Digilines message was received
+* 'interrupt' - An interrupt timer reached zero
+* 'terminal' - Text was typed into the terminal