aboutsummaryrefslogtreecommitdiff
path: root/simplemotion.h
diff options
context:
space:
mode:
authorTero Kontkanen <tero.k@granitedevices.com>2017-08-19 20:02:59 +0300
committerTero Kontkanen <tero.k@granitedevices.com>2017-08-19 20:05:40 +0300
commit2dfdc771b531716f2547c38864a1ea3ab549808c (patch)
tree7dce32a7ddcb24c6a15cc01061fa483c5d4e95d4 /simplemotion.h
parent98fc91e77907285c0c2f9d8f6209d2df004835e1 (diff)
downloadSimpleMotionV2-2dfdc771b531716f2547c38864a1ea3ab549808c.tar.gz
SimpleMotionV2-2dfdc771b531716f2547c38864a1ea3ab549808c.zip
Completed FTDI support on macOS & Added FTDI binary libraries
Diffstat (limited to 'simplemotion.h')
-rw-r--r--simplemotion.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/simplemotion.h b/simplemotion.h
index 80db602..38d97e8 100644
--- a/simplemotion.h
+++ b/simplemotion.h
@@ -99,7 +99,10 @@ LIB smbus smOpenBus( const char * devicename );
LIB void smSetBaudrate( unsigned long pbs );
/** Set timeout of how long to wait reply packet from bus. Must be set before smOpenBus and cannot be changed afterwards
- * max value 5000ms. In unix this is rounded to 100ms (rounding downwards), so 99 or less gives 0ms timeout.
+ * max value 5000ms. Range may depend on underyling OS / drivers. If supplied argument is lower than minimum supported by drivers,
+ * then driver minimum is used without notice (return SM_OK).
+ *
+ * In unix PC serial port minimum is 100ms, on Windows serial port recommended minimum is 30ms and with FTDI driver 10ms. On TCP/IP: TBD.
*
*This is the only function that returns SM_STATUS which doesn't accumulate status bits to be read with getCumulativeStatus because it has no bus handle
*/