SYNTAX

    rcomm [options] [<port_name>] [<mode>]


OPTIONS

-h (--help) bool

Display help.

-c (--csy-name) string

The name of the C32 plug-in module to load, e.g. ECUART.CSY. Need not be specified if the required module is already loaded.

-a (--access) uint

The access mode to open the port in as defined by TCommAccess in c32comm.h:

  0  ECommExclusive
  1  ECommShared
  2  ECommPreemptable

If not specified, defaults to ECommShared.

-b (--buffer) uint

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

-r (--raw) bool

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.

Raw mode is always assumed if the mode is "consume".

-v (--verbose) bool

Print verbose output.


ARGUMENTS

[<port_name>]

The name of the port, e.g. COMM::0. If not specified, information about the CSY is displayed (or about all CSYs if the --csy-name option isn't used). [string]

[<mode>]

The mode of operation.

read

Read from the port and print the results to STDOUT.

write

Read STDIN and write the results to the port.

consume

Like read, but throws away the data silently rather than printing it.

command

Listen for single-byte commands on the comport and write the results. Currently the only commands are a byte 0x00 <= n <= 0x19 (decimal 25) which means write 2^n buffers of data (of size given by --buffer) to the port.


DESCRIPTION

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

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).


SEE ALSO

rsocket, rconn, iap


COPYRIGHT

Copyright (c) 2007-2011 Accenture. All rights reserved.