EPICS_driver_modules/StreamDevice
0
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Improve docu about serial device setup

Browse Source
This commit is contained in:
zimoch
2018-07-25 16:15:44 +02:00
parent 57ad547df6
commit 8e92be073d
1 changed files with 27 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
documentation/setup.html
View File

@ -231,14 +231,14 @@ connected device.
</p> </p>
<h3>Example:</h3> <h3>Example:</h3>
<p> <p>
A power supply with serial communication (9600 baud, 8N1) is connected to A device with serial communication (9600 baud, 8N1, no flow control) is
<kbd>/dev/ttyS1</kbd>. connected to <kbd>/dev/ttyS1</kbd>.
The name of the power supply is <tt>PS1</tt>. The name of the device shall be <tt>PS1</tt>.
Protocol files are either in the current working directory or in the Protocol files are either in the current working directory or in the
<kbd>../protocols</kbd> directory. <kbd>../protocols</kbd> directory.
</p> </p>
<p> <p>
Then the startup script must contain lines like this: Then the startup script may look like this:
</p> </p>
<pre> <pre>
epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols") epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
@ -252,7 +252,26 @@ asynSetOption ("PS1", 0, "clocal", "Y")
asynSetOption ("PS1", 0, "crtscts", "N") asynSetOption ("PS1", 0, "crtscts", "N")
</pre> </pre>
<p>If the power supply was connected via telnet-style TCP/IP <p>All above options are the defaults.
Thus their usage in optional in this case.
</p>
<p>
If the device uses hardware flow control, change the last two lines to:
</p>
<pre>
asynSetOption ("PS1", 0, "clocal", "N")
asynSetOption ("PS1", 0, "crtscts", "Y")
</pre>
<p>
Newer versions of <em>asyn</em> also support software flow control
(CTRL-S,CTRL-Q). If the device uses this, you may want to set:
</p>
<pre>
asynSetOption ("PS1", 0, "ixon", "Y")
asynSetOption ("PS1", 0, "ixany", "Y")
</pre>
<p>If the device was instead connected via telnet-style TCP/IP
at address 192.168.164.10 on port 23, at address 192.168.164.10 on port 23,
the startup script would contain: the startup script would contain:
</p> </p>
@ -369,8 +388,9 @@ specify them enclosed in parentheses:
<p> <p>
The communication channel is specified with <code><var>bus</var></code> The communication channel is specified with <code><var>bus</var></code>
(aka <em>asynDriver</em> "port") and <code><var>addr</var></code>. (aka <em>asynDriver</em> "port") and <code><var>addr</var></code>.
If the bus does not have addresses, <code><var>addr</var></code> is dispensable. If the bus does not have addresses, <code><var>addr</var></code> may be skipped.
Optional <code><var>parameters</var></code> are passed to the bus driver. Optional <code><var>parameters</var></code> are passed to the bus driver.
(At the moment, no bus driver supports parameters.)
</p> </p>
<h3>Example:</h3> <h3>Example:</h3>