1 # rcomm.cif

     2 # 

     3 # Copyright (c) 2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 # 

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 ==name rcomm

    14 

    15 ==short-description

    16 

    17 Get info about supported serial channels, or read / write to them.

    18 

    19 ==long-description

    20 

    21 A command for reading data from or writing data to a serial comms port. With no arguments (or just a CSY name) lists all ports (on the given CSY).

    22 

    23 ==see-also

    24 

    25 L<rsocket|rsocket>, L<rconn|rconn>, L<iap|iap>

    26 

    27 ==argument string csy_name optional

    28 

    29 The name of the C32 plug-in module to load, e.g. C<ECUART.CSY>. If not specified, information about all the currently loaded CSY modules is displayed.

    30 

    31 ==argument string port_name optional

    32 

    33 The name of the port, e.g. C<COMM::0>. If not specified, information about the CSY is displayed.

    34 

    35 ==argument string mode optional

    36 

    37 The mode of operation.

    38 

    39 =over 5

    40 

    41 =item * C<read>

    42 

    43 Read the port and write the results to STDOUT.

    44 

    45 =item * C<write>

    46 

    47 Read STDIN and write the results to the port.

    48 

    49 =back

    50 

    51 ==option uint a access

    52 

    53 The access mode to open the port in as defined by C<TCommAccess> in F<c32comm.h>:

    54 

    55   0  ECommExclusive

    56   1  ECommShared

    57   2  ECommPreemptable

    58 

    59 If not specified, defaults to C<ECommShared>.

    60 

    61 ==option uint b buffer

    62 

    63 The size of buffer to use for either reading or writing. If not specified, defaults to 1 KB.

    64 

    65 ==option bool r raw

    66 

    67 Ordinarily reads from the comm port will be expanded from 8 bit data to 16 bit data (i.e. it is assumed the data be read is ASCII). Likewise, writes will be collapsed from 16 bit to 8 bit. This option disables the expansion and collapse functionality.

    68 

    69 ==option bool v verbose

    70 

    71 Print verbose output.

    72 

    73 ==copyright

    74 

    75 Copyright (c) 2007-2010 Accenture. All rights reserved.

    76