From: ian <ian>
Date: Sun, 9 Jan 2005 02:10:13 +0000 (+0000)
Subject: document new params
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ijackson/git?a=commitdiff_plain;h=fd7bde0eeffbad2c28060e0f1b5a9f58d0aa4730;p=trains.git

document new params
---

diff --git a/hostside/README b/hostside/README
index 71dd7ca..78786bb 100644
--- a/hostside/README
+++ b/hostside/README
@@ -1,12 +1,22 @@
-./hostside /dev/ttyS0 <hex-digit-pairs> c|r|n
+./hostside /dev/ttyS0 <hex-digit-pairs> c|r|n \
+  [<serial-fudge-delay> [<repeat-delay> [<iterations>]]]
 
  c = send directly to serial port as specified
  r = nmra packet with checksum - encode for pic (including preamble) and send
  n = nmra packet without checksum
 
+ delays are in us.
+ serial-fudge delay is usleep between bytes transmitted to serial port
+  (for pic to catch up in slow, debugging, mode), 0 meaning not to usleep
+ repeat-delay is -1 not to repeat, or 0 not to usleep, or +ve
+  to repeat with usleeps in between
+ iterations limits the looping (default is unlimited)
+
 Eg,
- ./hostside /dev/ttyS0 0348 n
-to tell decoder 3 to go speed 13 forwards
+ ./hostside /dev/ttyS0 0348 n 0 10000 1000
+to tell decoder 3 to go speed 13 forwards every 10ms
+ (on norway this means it actually happens every 20ms, a bit of a fudge
+  really)
 
  7f       7f       00       64       41       97         output bytes
  01111111 01111111 00000000 01100100 01000001 10010111   as bits