.TH edru 1 "November 2013" "open-plc-utils-0.0.3" "Qualcomm Atheros Open Powerline Toolkit"

.SH NAME
edru - Qualcomm Atheros Ethernet II Data Read Utility

.SH SYNOPSIS
.BR edru
.RI [ options ]
.RI [> stdout ]

.SH DESCRIPTION

.PP
Listen for incoming Ethernet II frames and write frame data, less header information, to stdout as a binary data stream.
Since frame data can contain anything, users should direct output to a file or pipe it through some type of filter to prevent corruption of the terminal session.
If all incoming data is known to be ASCII then directing stdout to the console should not cause any problems.

.PP
This program can be used to test remote Atheros UART-enabled powerline devices.
Remote device package serial data from their local host as Ethernet II frames and forwared them over the powerline to a specific destination.
The destination must be the Ethernet address of the receiving host.
This program reads such frames, discards the frame headers and writes the frame dat on stdout.
Data should appear exactly as sent by the remote hos.

.SH OPTIONS

.TP
-\fBe \fIethertype\fR
The protocol (or ethertype) of interest expressed as a 16-bit hexadecimal integer.
Prefix "\fB0x\fR" is optional.
This filters out frames having any other ethertype.
The default is \fBETH_P_802_2\fR as defined in \fBif_ether.h\fR.

.TP
-\fBi \fIinterface\fR
The host interface used to read frames.
The default is "\fBeth1\fR" because most people use "eth0" as their principle network connection; however, if the string "\fBPLC\fR" is defined in the environment then it will over-ride the program default.
Any interface specified on the command line will over-ride the default.

.TP
.RB - q
Quiet mode.
This option has no effect at this time.

.TP
-\fBt \fImilliseconds\fR
Read timeout in milliseconds.
Values range from 0 through UINT_MAX.
This is the maximum time allowed for a response.
The default is 50 milliseconds.

.TP
.RB - v
Verbose mode.
This option has no effect at this time.

.SH ARGUMENTS
None.

.SH EXAMPLES
The following example monitors host interface \fBeth1\fR for incoming 802.2 Ethernet frames and writes frame data to \fBstdout\fR.
In this case, \fBstdout\fR is the console.
Frame data is written, as it arrives, and forms a single output stream.
Directing output to  the console may corrupt your terminal session, forcing you to close the console window and open another one.

.PP
   # edru -ieth1

.PP
The next example does the same thing but directs output to file \fBtest.log\fR.
The output file may be inspected using a binary hex editor.
The programs continues to read and write until interrupted using \fBctrl-c\fR or \fBctrl-z\fR.

.PP
   # edru -ieth1 > test.log

.PP
The next example does the same thing but pipes output into program \fBhexdmp\fR which displays data in hexadecimal format.
This prevents terminal session corruptions caused by binary data.
Program\fBhexdmp\fR may not be provided with the toolkit.

.PP
   # edru -ieth1 | hexdmp

.SH SEE ALSO
.BR amp ( 1 ),
.BR efsu ( 1 ),
.BR hpav ( 1 )

.SH CREDITS
 Charles Maier