Difference between revisions of "Getting Started With Minicom"

From wiki.emacinc.com
Jump to: navigation, search
m (Reviewed, made changes, noted issues, and marked buggy.)
Line 1: Line 1:
−
{{todo| Review (10.28.2015-16:36->JJ+);(11.2.2015-18:00->JJ+);(11.3.2015-14:25->JJ+);(11.04.2015-13:00->MD-);(11.04.2015-17:15->JJ+) |Jeffrey Jung| project=OE 5.0,Review,JJ,MD}}
+
{{todo| Buggy (10.28.2015-16:36->JJ+);(11.2.2015-18:00->JJ+);(11.3.2015-14:25->JJ+);(11.04.2015-13:00->MD-);(11.04.2015-17:15->JJ+);(11.05.2015-18:55->MD-) |Jeffrey Jung| project=OE 5.0,Buggy,JJ,MD}}
 
{{#seo:minicom
 
{{#seo:minicom
 
|title=Getting Started With Minicom
 
|title=Getting Started With Minicom
Line 18: Line 18:
  
 
Please note that while PuTTY will work, it is missing a number of features relative to a real Linux terminal.  In particular, a number of keystroke shortcuts will not work with PuTTY, and not all output will be displayed correctly in PuTTY (although it does manage to display most output correctly). For serious work with Linux, a real Linux terminal (such as minicom, described here) is strongly recommended.
 
Please note that while PuTTY will work, it is missing a number of features relative to a real Linux terminal.  In particular, a number of keystroke shortcuts will not work with PuTTY, and not all output will be displayed correctly in PuTTY (although it does manage to display most output correctly). For serious work with Linux, a real Linux terminal (such as minicom, described here) is strongly recommended.
−
 
−
 
−
<!-- Pulling a lot of this information from the LifeRay 'Using Minicom' and 'iPac-9x25 Getting Started' pages -->
 
  
 
<!-- /*********************************************************************************************************/ -->
 
<!-- /*********************************************************************************************************/ -->
Line 27: Line 24:
 
{{:Templateimpl:geninfo | initials=JJ | title=Getting Started With Minicom | desc=Description for SEO | project=OE 5.0 }}
 
{{:Templateimpl:geninfo | initials=JJ | title=Getting Started With Minicom | desc=Description for SEO | project=OE 5.0 }}
 
The use of a terminal emulator, such as <code>minicom</code>, is required when connecting to an EMAC board via a serial console. This page sets out to provide general information about using <code>minicom</code> to communicate between EMAC machines and a development PC.
 
The use of a terminal emulator, such as <code>minicom</code>, is required when connecting to an EMAC board via a serial console. This page sets out to provide general information about using <code>minicom</code> to communicate between EMAC machines and a development PC.
 +
 +
{{warning|This is good info from the Liferay page that we should include:}}
 +
 +
The following list of arguments can be used to alter its behavior from the command line.
 +
 +
-b <baudrate> = The serial port baud rate used by the external device–typically a SOM.
 +
 +
-D <device_name> = The device name for the serial port being used.
 +
 +
-h = Show a list of arguments that minicom accepts.
 +
 +
For a more comprehensive list of options and their descriptions, read the manpage for minicom:
 +
man minicomThe calling convention for minicom is as follows:
 +
 +
minicom [OPTIONS] [configuration]
 +
 +
Where[OPTIONS] is a space-delimited list of options from among those listed above.
 +
[configuration] is a configuration file that can be found in /etc/minicom/.
 +
 +
Note that most configurations are named minirc.<some_name> where <some_name> is what should be specified in place of [configuration] above.
 +
 +
{{warning| end additional content.  The arguments/descriptions should probably be put into definition lists (see the MediaWiki syntax for help on how to format it that way).}}
  
 
<!-- /*********************************************************************************************************/ -->
 
<!-- /*********************************************************************************************************/ -->
Line 42: Line 61:
 
alias minicom='minicom -con'
 
alias minicom='minicom -con'
 
</pre>
 
</pre>
−
<br />
 
  
−
<!-- I tried using adduser from my machine and it said I'm already in the group, yet still couldn't save unless I ran sudo. I talk to Michael G about it and after a while, we determined that it'll only work if we use sudo. -->
+
{{warning | It still shows the alias instead of the use of the MINICOM variable.}}
  
 
* The first thing that will need to be configured is the '''Serial port setup'''. Arrow down to the title and press the 'Enter' key.
 
* The first thing that will need to be configured is the '''Serial port setup'''. Arrow down to the title and press the 'Enter' key.
Line 65: Line 83:
 
* Once you have saved the configuration, arrow down to '''Exit from Minicom'''.
 
* Once you have saved the configuration, arrow down to '''Exit from Minicom'''.
 
</cl>
 
</cl>
 +
 +
{{warning | Weren't you also going to show the alternate way to configure it?}}
  
 
== Running Minicom ==
 
== Running Minicom ==
Line 73: Line 93:
 
You're now able to communicate to the device and use <code>minicom</code> in the same way as using the terminal for the device.  
 
You're now able to communicate to the device and use <code>minicom</code> in the same way as using the terminal for the device.  
 
</cl>
 
</cl>
 +
{{ note | When opening a connection to a different serial port than what has been saved from the <code>minicom</code> configurations, use the <code>-D</code> option to specify the path to the desired serial port. For example, to use <code>/dev/ttyUSB0</code>, run <code>minicom</code> like this:
 +
 +
 +
{{cli|minicom -D /dev/ttyUSB0| hostname=developerpc| username=user}}
  
−
{{ note | When opening a connection to a different serial port than what has been saved from the <code>minicom</code> configurations, use the <code>-D</code> option and specify the path to the desired serial port. See the example below.
 
 
}}
 
}}
−
 
  
 
<!-- /*********************************************************************************************************/ -->
 
<!-- /*********************************************************************************************************/ -->
 
<!-- /*****************************************      Examples        *****************************************/ -->
 
<!-- /*****************************************      Examples        *****************************************/ -->
 
<!-- /*********************************************************************************************************/ -->
 
<!-- /*********************************************************************************************************/ -->
 +
<!-- There's only one example, so we really don't need an entire section for it.  Plus, the cli template looks nice inside the Note box.
 +
 
{{:Templateimpl:examples | initials=JJ | title=Getting Started With Minicom | desc=Description for SEO | project=OE 5.0 }}  
 
{{:Templateimpl:examples | initials=JJ | title=Getting Started With Minicom | desc=Description for SEO | project=OE 5.0 }}  
 
Suppose the port <code>/dev/ttyS10</code> is specified as the default. If the desired path to a different port is at <code>/dev/ttyUSB0</code>, run <code>minicom</code> as follows:
 
Suppose the port <code>/dev/ttyS10</code> is specified as the default. If the desired path to a different port is at <code>/dev/ttyUSB0</code>, run <code>minicom</code> as follows:
−
{{cli|minicom -D /dev/ttyUSB0| hostname=developerpc| username=user}}
+
{{cli|minicom -D /dev/ttyUSB0| hostname=developerpc| username=user}} -->
 +
 
 
<!-- /*********************************************************************************************************/ -->
 
<!-- /*********************************************************************************************************/ -->
 
<!-- /******************************************    Conclusion      ******************************************/ -->
 
<!-- /******************************************    Conclusion      ******************************************/ -->

Revision as of 18:56, 5 November 2015

TODO: {{#todo: Buggy (10.28.2015-16:36->JJ+);(11.2.2015-18:00->JJ+);(11.3.2015-14:25->JJ+);(11.04.2015-13:00->MD-);(11.04.2015-17:15->JJ+);(11.05.2015-18:55->MD-) |Jeffrey Jung|OE 5.0,Buggy,JJ,MD}}

Background

minicom is a serial communication program that connects to devices through a GNU/Linux PC's serial ports. If run by calling its name without any additional arguments, it uses whatever settings have been saved for its defaults in /etc/minicom/minirc.dfl. For those using Windows, PuTTY is a viable application to make such connections between a Windows PC and one of our EMAC devices. More information about PuTTY can be found at http://wiki.emacinc.com/wiki/PuTTY.

Please note that while PuTTY will work, it is missing a number of features relative to a real Linux terminal. In particular, a number of keystroke shortcuts will not work with PuTTY, and not all output will be displayed correctly in PuTTY (although it does manage to display most output correctly). For serious work with Linux, a real Linux terminal (such as minicom, described here) is strongly recommended.

General Information

The use of a terminal emulator, such as minicom, is required when connecting to an EMAC board via a serial console. This page sets out to provide general information about using minicom to communicate between EMAC machines and a development PC.



WARNING!
This is good info from the Liferay page that we should include:


The following list of arguments can be used to alter its behavior from the command line.

-b <baudrate> = The serial port baud rate used by the external device–typically a SOM.

-D <device_name> = The device name for the serial port being used.

-h = Show a list of arguments that minicom accepts.

For a more comprehensive list of options and their descriptions, read the manpage for minicom: man minicomThe calling convention for minicom is as follows:

minicom [OPTIONS] [configuration]

Where[OPTIONS] is a space-delimited list of options from among those listed above. [configuration] is a configuration file that can be found in /etc/minicom/.

Note that most configurations are named minirc.<some_name> where <some_name> is what should be specified in place of [configuration] above.



WARNING!
end additional content. The arguments/descriptions should probably be put into definition lists (see the MediaWiki syntax for help on how to format it that way).


Getting Started With Minicom

  1. If minicom has yet to be installed on your Linux machine, use apt-get to install the minicom package

    user@developerpc:~# sudo apt-get install minicom

  2. The minicom settings will need to be changed so that the application will be able to find your device. Pull up the settings using the -s option.

    user@developerpc:~# sudo minicom -s

    This should bring up a colorful display listing the different settings. If the display isn't colored, arrow down to Exit from Minicom. Run the minicom command with the option -con. The c specifies the color display and on tells minicom to display the interface in color. minicom can be made to always run in color by modifying the ~/.bashrc file, setting an alias for minicom to minicom -con, and restarting your terminal session (or sourcing your .bashrc) to make the change take effect.: 

    alias minicom='minicom -con'



    WARNING!
    It still shows the alias instead of the use of the MINICOM variable.


  3. The first thing that will need to be configured is the Serial port setup. Arrow down to the title and press the 'Enter' key.

  4. To modify the different configurations, press the key corresponding to the setting. For example, press the 'A' key to modify the path to the Serial Device. Press the 'Enter' key to save the parameters for the setting. The settings for specific EMAC devices can be found at the Serial Connections page.
    Serial Port Setup for minicom
    In this screenshot, the "115200 8N1" for the Bps/Par/Bits setting indicates the baud rate is set to 115200, data bits set to 8 (the '8' in 8N1), parity is set to none (the 'N' in 8N1), and stop bits is set to 1 (the '1' in 8N1).

  5. You will most likely wish to modify the Serial Device setting to have the path to the serial port you normally use. This way, you'll be able to run the command without any options or commands. The scanserial tool provided in the emac-tool-util package can display a list of serial ports using the -l option.

    user@developerpc:~# scanserial -l

    More information about the scanserial program can be found at the scanserial page. Press the 'Esc' key to be be brought back to the configurations page.

  6. The next setting that needs to be configured is the Modem and dialing. Press the 'A' key and delete its content. Hit the 'Enter' key to set the setting as blank. Also do this for B through K, and for H. Hit the 'Esc' key when finished deleting the content of these settings.

  7. That's all the modifications that need to be done to get minicom set up. Arrow down to Save setup as dfl and press 'Enter'. If a message pops up saying "cannot write to /etc/minicom/minirc.dfl", you likely aren't running the command as root. Re-run the command with sudo.

  8. Once you have saved the configuration, arrow down to Exit from Minicom.



WARNING!
Weren't you also going to show the alternate way to configure it?


Running Minicom

Now that everything is configured, you are ready to open the serial connection.

  1. Run the minicom command to start minicom with the serial port setting you configured above. If you wish to use minicom on a different serial port than the one you configured above, see the note below.

  2. Log in with the appropriate username and password for the device. Login information can be found here. You're now able to communicate to the device and use minicom in the same way as using the terminal for the device.



NOTE
When opening a connection to a different serial port than what has been saved from the minicom configurations, use the -D option to specify the path to the desired serial port. For example, to use /dev/ttyUSB0, run minicom like this:


user@developerpc:~# minicom -D /dev/ttyUSB0


Conclusion

This program is a very important tool for developers. The serial console is essential for working with the bootloader on ARM systems, since U-Boot cannot be accessed via ssh. Using the serial console, you will be able to configure the bootloader, to program new kernels via the bootloader, to program new filesystems, to make a copy of the filesystem on a board, and to perform memory checks using U-Boot. The serial console will also enable you to see startup and shutdown messages, to configure and debug the system when networking is not configured or is not working, and to debug the system when the machine is not booting up.

Further Information

Where to Go Next


Pages with Related Content
Retrieved from "https://wiki.emacinc.com/index.php?title=Getting_Started_With_Minicom&oldid=4989"