Scanserial - Revision history

Mgloff at 19:51, 6 November 2015

2015-11-06T19:51:13Z

Kyoungmeyer: Fixed a link and some overlapping text/formatting.

2015-11-05T23:17:26Z

Fixed a link and some overlapping text/formatting.

Mdean: Finished self review, made revisions, and marked Review.

2015-11-05T17:07:24Z

Finished self review, made revisions, and marked Review.

Mdean: Ready for self review.

2015-11-05T01:30:47Z

Ready for self review.

Mdean: Incremental save.

2015-11-04T23:06:43Z

Incremental save.

Mdean: Initial Content.

2015-11-04T22:15:04Z

Initial Content.

Mdean: Corrected TODO tag.

2015-11-04T18:17:58Z

Corrected TODO tag.

Mdean: Initial Page Creation

2015-11-04T18:17:29Z

Initial Page Creation

New page

{{todo| NotStarted (11.04.2015-12:17->MD+)| Mdean | project=OE 5.0,MD }}
{{#seo:
|title=scanserial
|titlemode=append
|keywords=
|description=Using scanserial to find your serial ports.
}}




<span style="background:#00FF00;color:#FF0000;font-size:300%">'''''Put the page description text here.'''''</span>

__TOC__




{{:Templateimpl:bg | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}




{{:Templateimpl:geninfo | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}




{{:Templateimpl:using | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}




{{:Templateimpl:examples | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}




{{:Templateimpl:conclusion | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}




{{:Templateimpl:moreinfo | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}
*

{{:Templateimpl:whatnext | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}
*

@@ Line 1: / Line 1: @@
-{{todo| FinalDraft (11.04.2015-12:17->MD+);(11.05.2015-11:05->MD+);(11.05.2015-17:15->KY+)|Mike Dean| project=OE 5.0,MD,KY,FinalDraft }}
+{{todo| Complete (11.04.2015-12:17->MD+);(11.05.2015-11:05->MD+);(11.05.2015-17:15->KY+);(11.06.2015-13:50->MG+)|Mike Dean| project=OE 5.0,MD,KY,Complete }}
 {{#seo:
 |title=scanserial

@@ Line 1: / Line 1: @@
-{{todo| Review (11.04.2015-12:17->MD+);(11.05.2015-11:05->MD+)|Mike Dean| project=OE 5.0,MD,Review }}
+{{todo| FinalDraft (11.04.2015-12:17->MD+);(11.05.2015-11:05->MD+);(11.05.2015-17:15->KY+)|Mike Dean| project=OE 5.0,MD,KY,FinalDraft }}
 {{#seo:
 |title=scanserial
@@ Line 15: / Line 15: @@
 __TOC__
 <!-- /*********************************************************************************************************/ -->
 <!-- /***************************************** Background Information ****************************************/ -->
@@ Line 43: / Line 42: @@
 The <code>scanserial</code> tool is provided by EMAC to assist customers in getting a development environment set up.  Since <code>scanserial</code> is an EMAC provided tool, you will need to install it unless you are using an EMAC LDC (which has it pre-installed).
-If your Ubuntu machine isn't already configured to use the EMAC apt repository for installing software, you will need to [[Getting_Started_with_the_EMAC_OE_SDK| follow this guide]] on how to do so.  When your system is configured for the EMAC apt repository, you can install the <code>scanserial</code> tool by installing the <code>emac-tools-util</code> package.  To install it with <code>apt-get</code> on the command line, run:
+If your Ubuntu machine isn't already configured to use the EMAC apt repository for installing software, you will need to [[Install_the_EMAC_SDK#Install_Using_apt_.28Recommended.29| follow this guide]] on how to do so.  When your system is configured for the EMAC apt repository, you can install the <code>scanserial</code> tool by installing the <code>emac-tools-util</code> package.  To install it with <code>apt-get</code> on the command line, run:
 {{cli|username=developer|hostname=developerpc|sudo apt-get install emac-tools-util}}
@@ Line 131: / Line 130: @@
 {{cliop | username=developer | hostname=developerpc |}}
 {{closp}}
+<br />
 ''Further output, in this example, was truncated for the sake of brevity.''
@@ Line 145: / Line 144: @@
 {{cliop | username=developer | hostname=developerpc |}}
 {{closp}}
+<br />
 If you have multiple loopbacks attached, they will all show up in the output list.  If you wish to ensure that <code>scanserial</code> is checking every device node you're expecting it to check, you can add the verbose flag (<code>--verbose</code> or <code>-v</code> for short) when you call <code>scanserial</code>.  For example, if you have two loopbacks attached and call <code>scanserial</code> with the verbose flag set, it might look like this:
@@ Line 174: / Line 173: @@
 The <code>scanserial</code> tool greatly simplifies the once cumbersome, manual, trial-and-error process of figuring out which of the potentially 100+ device nodes have associated physical serial ports, and which of those is/are the one(s) you're looking for.  This freely available tool can save you a great deal of time when configuring serial ports.  If you don't need to perform this task right now, perhaps because you're using an EMAC LDC, keeping in mind that EMAC provides this tool may help you save time and frustration at a later date.
 <!-- /*********************************************************************************************************/ -->
@@ Line 184: / Line 182: @@
 * [[Network_Connections | Connecting an EMAC OE Linux 5.x Machine to a Network]]
 * [[Network_Configuration | Configuring Networking]]
 {{:Templateimpl:whatnext | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}
 * [[Example_serial_test | Example Serial Communications Program]]
 * [[Quick_Reference | EMAC Quick Reference]]

@@ Line 1: / Line 1: @@
-{{todo| InProgress (11.04.2015-12:17->MD+)|Mike Dean| project=OE 5.0,MD,InProgress }}
+{{todo| Review (11.04.2015-12:17->MD+);(11.05.2015-11:05->MD+)|Mike Dean| project=OE 5.0,MD,Review }}
 {{#seo:
 |title=scanserial
@@ Line 22: / Line 22: @@
 Linux systems use virtual files to provide device nodes which represent hardware devices attached to a system.  These device nodes reside in the <code>/dev</code> directory.  Each device node corresponds to one device, or to one endpoint within a device.
 The serial ports typically are represented by device nodes with one of the two following naming schemes:
@@ Line 32: / Line 34: @@
 Any given system may have one or both of these types of serial devices attached to it.  Serial ports provided by a motherboard or add-in PCI/PCIe card are classified in this document as Standard Serial Devices.  USB to serial devices, including USB devices which provide several serial ports, are classified in this document as USB Serial Devices.
-Serial devices normally provide a character device (rather than a block or FIFO).  Each device node describes the type of device it is associated with, in this case character, and has an associated major and minor magic number.  The magic numbers are used to identify to the operating system kernel the specific device on the system to which the device node corresponds.  Further details about device nodes are beyond the scope of this document, but can be found on this site and elsewhere in documentation on Linux device drivers.
+Each device node describes the class of device it is associated with, and has an associated major and minor magic number.  Serial devices normally provide a character device, rather than a block or FIFO class device. The magic numbers are used to identify to the operating system kernel the specific device on the system to which the device node corresponds.  Further details about device nodes are beyond the scope of this document, but can be found on this site and elsewhere in documentation on Linux device drivers.
 <!-- /*********************************************************************************************************/ -->
@@ Line 67: / Line 69: @@
 ;-l, --list-serials
-: Lists the serial device nodes found in /dev which appear to be serial ports.  If combined with the verbose option, this will also show metadata about each one.  Add the color switch to colorize the output to make it easier to read.
+: Lists the serial device nodes found in <code>/dev</code> which appear to be serial ports.  If combined with the verbose option, this will also show metadata about each one.  Add the color switch to colorize the output to make it easier to read.
 ;--version
@@ Line 171: / Line 173: @@
 {{:Templateimpl:conclusion | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}
-The <code>scanserial</code> tool greatly simplifies the once cumbersome, manual, trial-and-error process of figuring out which of the potentially 100+ device nodes have associated physical serial ports, and which of those is/are the one(s) you're looking for.  This freely available tool can save you a great deal of time when configuring serial ports.  If you don't need to do perform this task right now, perhaps because you're using an EMAC LDC, you would still be wise to remember that this tool exists so that you will be able to find it later.
+The <code>scanserial</code> tool greatly simplifies the once cumbersome, manual, trial-and-error process of figuring out which of the potentially 100+ device nodes have associated physical serial ports, and which of those is/are the one(s) you're looking for.  This freely available tool can save you a great deal of time when configuring serial ports.  If you don't need to perform this task right now, perhaps because you're using an EMAC LDC, keeping in mind that EMAC provides this tool may help you save time and frustration at a later date.
@@ Line 181: / Line 183: @@
 * [[System_Log_In | Logging Into an EMAC OE Linux 5.x Machine]]
 * [[Network_Connections | Connecting an EMAC OE Linux 5.x Machine to a Network]]
 {{:Templateimpl:whatnext | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}
 * [[Quick_Reference | EMAC Quick Reference]]

@@ Line 10: / Line 10: @@
 <!-- /****************************************  Page Description Text  ****************************************/ -->
 <!-- /*********************************************************************************************************/ -->
-EMAC provides a tool named <code>scanserial</code> to assist a user in finding out which device nodes on a computer correspond to its serial ports, and in finding out which particular device node corresponds to a particular serial port.  The <code>scanserial</code> tool was created because no existing tool provides this functionality in a convenient way.  Other methods for determining this all require a slow trial and error approach.
+EMAC provides a tool named <code>scanserial</code> to assist a user in finding out which device nodes on a computer correspond to its serial ports, and to assist in finding out which particular device node corresponds to a particular serial port.  The <code>scanserial</code> tool was created because no existing tool provides this functionality in a convenient way.  Other methods for determining this all require a slow trial and error approach.
 This guide walks the reader through the steps required to perform these tasks using the EMAC <code>scanserial</code> tool.
@@ Line 41: / Line 41: @@
 The <code>scanserial</code> tool is provided by EMAC to assist customers in getting a development environment set up.  Since <code>scanserial</code> is an EMAC provided tool, you will need to install it unless you are using an EMAC LDC (which has it pre-installed).
-If your Ubuntu machine isn't already configured to use the EMAC apt repository for installing software, you will need to [[Getting_Started_with_the_EMAC_OE_SDK| follow this guide]] on how to do so.  When your system is configured for the EMAC apt repository, you can install the <code>scanserial</code> tool by installing the <code>emac-tools-util</code> project.  To install it with <code>apt-get</code> on the command line, run:
+If your Ubuntu machine isn't already configured to use the EMAC apt repository for installing software, you will need to [[Getting_Started_with_the_EMAC_OE_SDK| follow this guide]] on how to do so.  When your system is configured for the EMAC apt repository, you can install the <code>scanserial</code> tool by installing the <code>emac-tools-util</code> package.  To install it with <code>apt-get</code> on the command line, run:
-{{cli|username=developer|hostname=developerpc| sudo apt-get install emac-tools-util}}
+{{cli|username=developer|hostname=developerpc|sudo apt-get install emac-tools-util}}
 Alternatively, you may open the Ubuntu Software Center and search for the <code>emac-tools-util</code> project.  Clicking on the search result will provide you with an option to install the package.  Click the <b>Install</b> button to install it.
@@ Line 103: / Line 103: @@
 {{cliop | username=developer | hostname=developerpc |}}
 {{closp}}
 ====Listing Detailed Information About Serial Ports====
@@ Line 109: / Line 111: @@
 {{clop}}
-{{cliop | username=developer | hostname=developerpc | scanserial -lv }}
+{{cliop | username=developer | hostname=developerpc |scanserial -lv }}
 /dev/ttyS0:
 	type:       	4   	line:      	 	0
@@ Line 132: / Line 134: @@
 ====Finding an Attached Loopback====
-When you need to figure out which device node corresponds to the specific one you wish to use, which can be especially difficult when you have a lot of serial ports (like the 14 on the system shown above), a loopback is very useful.  A loopback is a connection between the Rx and Tx lines on a serial port.  Many large vendors sell RS-232 serial loopback dongles.  In a pinch, you can make your own loopback by connecting the Rx and Tx lines together with a wire.
+When you need to figure out which device node corresponds to the specific one you wish to use, which can be especially difficult when you have a lot of serial ports (like the 14 on the system shown above), a loopback is very useful.  A loopback is a connection between the Rx and Tx lines on a serial port.  Many large vendors sell RS-232 serial loopback dongles.  In a pinch, you can make your own loopback by connecting the Rx and Tx lines together with a wire or jumper.
 Once you have a loopback connected to the desired port, run the <code>scanserial</code> command with the <code>--find-loopback</code> or <code>-f</code> (the shortened abbreviated version) argument:
 {{clop}}
-{{cliop | username=developer | hostname=developerpc | scanserial -f}}
+{{cliop | username=developer | hostname=developerpc |scanserial -f}}
-Found loopback on /dev/ttyUSB0
+/dev/ttyUSB6	:	Found!
 {{cliop | username=developer | hostname=developerpc |}}
 {{closp}}
@@ Line 148: / Line 170: @@
 <!-- /*********************************************************************************************************/ -->
 {{:Templateimpl:conclusion | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}
 <!-- /*********************************************************************************************************/ -->
@@ Line 153: / Line 178: @@
 <!-- /*********************************************************************************************************/ -->
 {{:Templateimpl:moreinfo | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}
+* [[Serial_Connections | Making Serial Connections to EMAC OE Linux 5.x Machines]]
 {{:Templateimpl:whatnext | initials=MD | title=scanserial | desc=Using scanserial to find your serial ports. | project=OE 5.0 }}
+* [[Quick_Reference | EMAC Quick Reference]]

@@ Line 83: / Line 83: @@
 ====Listing Available Serial Ports====
-Use the <code>-l</code> (lowercase L) option to list available serial ports.  Here, there are 8 standard serial ports and 8 USB serial ports available.
+Use the <code>-l</code> (lowercase L) option to list available serial ports.  Here, there are 6 standard serial ports and 8 USB serial ports available.
-{{clo}}
+{{clop}}
-{{clio|username=developer|hostname=developerpc|scanserial -l}}
+{{cliop|username=developer|hostname=developerpc|scanserial -l}}
-/dev/ttyS0/dev/ttyS1/dev/ttyS4/dev/ttyS5/dev/ttyS6/dev/ttyS7/dev/ttyUSB0/dev/ttyUSB1/dev/ttyUSB2/dev/ttyUSB3/dev/ttyUSB4/dev/ttyUSB5/dev/ttyUSB6/dev/ttyUSB7
+/dev/ttyS0
-{{clos}}
+/dev/ttyS1
 ====Listing Detailed Information About Serial Ports====
@@ Line 96: / Line 110: @@
 {{clop}}
 {{cliop | username=developer | hostname=developerpc | scanserial -lv }}
 {{closp}}
-''Further output was truncated for the sake of brevity in this example.''
+''Further output, in this example, was truncated for the sake of brevity.''