aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Fincham <michael@hotplate.co.nz>2016-09-01 22:48:08 +1200
committerGitHub <noreply@github.com>2016-09-01 22:48:08 +1200
commit52aa1881e1c3232dc74e538ef3ff563588704a58 (patch)
tree283e83127320899cd5b36b119141387fb6201f52
parente21bb6224ea5e97feb0a129c64d45ce5d4e1fac5 (diff)
downloadnodemcu-socket-relay-master.tar.gz
nodemcu-socket-relay-master.tar.bz2
nodemcu-socket-relay-master.zip
Add example sessionHEADmaster
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0ba7647..7cbdee8 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
# nodemcu-socket-relay
For a first project with NodeMCU, turns a relay on and off with a TCP connection. Simulates the use of a hardware interlock.
+
+## Usage
+<pre>
+fincham@amdahl:~$ telnet 192.168.1.1 2323
+Trying 192.168.1.1...
+Connected to 192.168.1.1.
+Escape character is '^]'.
+
+command unknown.
+> status
+soft armed: false. firing: false.
+> firenow
+unable to fire, not yet armed.
+> softarm
+soft arming in 10 seconds.
+> status
+soft armed: false. firing: false.
+> status
+soft armed: true. firing: false.
+# firenow
+firing for five seconds now!
+# status
+soft armed: true. firing: true.
+# disarm
+disarmed.
+> status
+soft armed: false. firing: false.
+>
+</pre>