Application Note AN_242 FTDI_UART_Terminal_User_Manual Version 1.0 Issue Date: 2013-06-24 This utility is for use with FTDI USB to UART devices. The utility provides a terminal emulation function for use on Android devices. The Android system must use Android OS version 3.2 or later and provide a USB host port. Use of FTDI devices in life support and/or safety applications is entirely at the user’s risk, and the user agrees to defend, indemnify and hold FTDI harmless from any and all damages, claims, suits or expense resulting from such use. Future Technology Devices International Limited (FTDI) Unit 1, 2 Seaward Place, Glasgow G41 1HH, United Kingdom Tel.: +44 (0) 141 429 2777 Fax: + 44 (0) 141 429 2758 Web Site: http://ftdichip.com Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 Table of Contents 1 2 Introduction ......................................................................................... 2 1.1 Features ........................................................................................ 2 1.2 Install Application ........................................................................... 3 1.3 Launch and Exit Application .............................................................. 3 Functions ............................................................................................ 4 2.1 Serial Settings ................................................................................ 4 2.2 Send Data...................................................................................... 5 2.2.1 Send Plain Text Data ................................................................. 5 2.2.2 Send Hexadecimal Format Data .................................................. 5 2.2.3 Send Special Key Code Data ....................................................... 6 2.3 2.3.1 Receive File .............................................................................. 7 2.3.2 Send File ................................................................................ 10 2.4 3 File Transfer ................................................................................... 7 Menu Functions ............................................................................ 12 2.4.1 Setting ................................................................................... 12 2.4.2 Content Format ....................................................................... 14 2.4.3 Font Size ................................................................................ 16 2.4.4 Save Content Data .................................................................. 17 2.4.5 Clean Screen .......................................................................... 17 2.4.6 Echo ...................................................................................... 17 2.4.7 Online Help ............................................................................. 17 Contact Information ............................................................................ 18 Appendix A – References .......................................................................... 19 Acronyms and Abbreviations ................................................................... 19 Appendix B – List of Figures ...................................................................... 20 Appendix C– Revision History .................................................................... 21 1 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 1 Introduction This utility is for use with FTDI USB to UART devices. The utility provides a terminal emulation function for use on Android devices. The Android system must use Android OS version 3.2 or later and provide a USB host port. 1.1 Features • The application will open automatically when you plug in supported FTDI devices. • It supports FTDI USB TTL Serial, USB RS232, RS422, RS485 and USB Hi-Speed cables. • Suitable for use on any Android platform with a USB host port running Android v3.2 or later versions. • Provide general terminal UART utility. • Support CTS/RTS, DTR/DSR and XOFF/XON Flow controls. • Support Baud from 300 to 921600. • Save file and Send file functions support XModem, YModem and ZModem file transfer protocols. • USB Plug and Play. • USB 2.0 Full Speed compatible. 2 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 1.2 Install Application Find this application in the “Play Store” by searching “ftdi uart” and then install it, by clicking on the icon. Figure 1 The Application in Play Store 1.3 Launching and Exiting the Application When the Android device is attached to the FTDI device over the USB port, the Android device will prompt the user to execute this application. Figure 2 Launch Application To exit this application, tap the back button and it will show a notification message. Tap the back button again to exit before the notification message disappears. 3 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 2 Functions This section describes how to use this utility. Figure 3 Main Screen 2.1 Serial Settings The application automatically configures the serial port of the FTDI USB to UART device with default settings: 9600 baud, 1 stop bit, 8 data bit, no parity, CTS/RTS flow control for port 0 when the FTDI device is connected. Please refer to 2.4.1 Setting for the details of manually configuring the port. 4 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 2.2 Send Data The sent data is shown in the data area when the content format is character format, otherwise it will show a warning message three times when the “Write” button is tapped. Tapping the data format button toggles CHAR or HEX format for sending data. 2.2.1 Send Plain Text Data Input data in the input area and tap the “Write” button to send data when the data format button shows “CHAR”. Figure 4 Send Plain Text Data 2.2.2 Send Hexadecimal Format Data Input data in the input area and tap the “Write” button to send data when the data format button shows “HEX”. Figure 5 Send Hexadecimal Format Data 5 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 Note the need to input 2 characters for hexadecimal data and both character should be from ‘0’ to ‘9’ or from ‘a’ to ‘f’, otherwise the application will show a warning message when the “Write” button is tapped. 2.2.3 Send Special Key Code Data Tap the “Key Code” button and it will show a row with two buttons: Ctrl-C and ESC. Tap “Ctrl-C” or “ESC” button to send its corresponding key code data. Figure 6 Send Special Key Code Data 6 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 2.3 File Transfer File transfer functions are allowed after the UART is configured and when the content format is character format, otherwise it will show a warning message when the “Save to File” button or “Send File” button is tapped. 2.3.1 Receive File Step 1: Tap the “Save to File” button to prepare receiving file. Step 2: Select protocol. Figure 7 Select Protocol Step 3: Select file destination. I. For “ASCII”, ”XModem-CheckSum”, ”XModem-CRC” and “XModem-1KCRC” protocol, there is the option to create a new file or select an exist file for saving. Figure 8 Select File Destination 7 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 (1) Create New File Tap "Select Directory" to select a directory for the new file to be stored in. Figure 9 Select Directory Input the file name and tap “OK” to create a new file. Figure 10 Create New File 8 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 (2) Save to File Select an exist file. Figure 11 Select a File II. For “YModem” and “ZModem” protocol, select a directory for file saving. The file name will be created automatically depending on the content information. Figure 12 Select Directory The status bar will show the name of the file being saved and the saving progress. 9 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 2.3.2 1.0 Clearance No.: FTDI# 343 Send File Step 1: Tap the “Send File” button to send a file. Step 2: Select protocol. Figure 13 Select Protocol Step 3: Select a file. Figure 14 Select a File The Status bar will show the name of the file to be sent and the sending progress. 10 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 Note: 1. When the file list is not updated, tap ".." to go to its parent folder and enter this folder again, and the file list will be refreshed. Figure 15 Refresh File List 2. ZModem protocol of FTDI UART Terminal is a simple file transfer protocol. It is implemented and verified with Microsoft XP hyper terminal and Moxa PComm terminal. 11 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 2.4 Menu Functions For tablet devices, tap the menu icon to launch the menu: Figure 16 Menu Icon on Tablet Device For phone devices, press the menu key to launch the menu. 2.4.1 Setting The setting menu displays a row with several setting items for serial port configuration. Figure 17 Serial Settings 12 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 The configuration settings allow the baud rate to be set at standard values between 300 and 921600 baud with CTS/RTS flow control and the values between 300 and 115200 baud with or without flow control. Stop bits may be set for 1 or 2. Data bits may be set for 7 or 8 Parity may be set for None, ODD, EVEN, Mark or Space. Flow allows for no flow control, RTS/CTS, DTR/DSR and XOFF/XON flow controls. The application will show a warning message when “none” flow control is selected. Port number items are dependent on the connected cable/device. After selecting the required setting for each item, tap the “Configure” button to set it and setting information will be shown on the status bar: content format, target port number and UART setting. Figure 18 Information on Status Bar 13 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 2.4.2 1.0 Clearance No.: FTDI# 343 Content Format Select the data format of the content shown in the data area. The default content format is character format. Figure 19 Select Content Format I. Character The data is displayed in character format in Figure 20: Figure 20 Character Format 14 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 II. 1.0 Clearance No.: FTDI# 343 Hexadecimal The data is displayed in hexadecimal format in Figure 21: Figure 21 Hexadecimal Format Note that when content format is hexadecimal format, the new incoming data sent to the Android device is not shown. 15 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 2.4.3 1.0 Clearance No.: FTDI# 343 Font Size Select the font size of the content shown in the data area. Default font size is 12. Figure 22 Select Font Size 16 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 2.4.4 1.0 Clearance No.: FTDI# 343 Save Content Data Save the data currently shown in the data area into a new file or an exist file. The process is the same with 2.3.1 Receive File - Step 3: Select file destination - I. 2.4.5 Clean Screen Clear all content shown in the data area. 2.4.6 Echo Select the echo function to be on or off. Default echo setting is on. The data sent by tapping the “Write” button is shown in the data area when the echo function is on. Figure 23 Select Echo Function 2.4.7 Online Help Get this user manual from the FTDI website (http://www.ftdichip.com/Support/Documents/AppNotes/AN_242_FTDI_UART_Terminal_User_Man ual.pdf). 17 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 3 Contact Information Head Office – Glasgow, UK Branch Office –Tigard, USA Unit 1, 2 Seaward Place, Centurion Business Park Glasgow G41 1HH United Kingdom Tel: +44 (0) 141 429 2777 Fax: +44 (0) 141 429 2758 7130 Fir Loop, Tigard, OR 97223-8160 USA Tel: +1 (503) 547 0988 Fax: +1 (503) 547 0987 E-mail (Sales) E-mail (Support) E-mail (General Enquiries) E-Mail (Sales) E-Mail (Support) E-Mail (General Enquiries) [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] Branch Office – Shanghai, China Branch Office – Taipei, Taiwan 2F, No. 516, Sec. 1, NeiHu Road Taipei 114 Taiwan , R.O.C. Tel: +886 (0) 2 8797 1330 Fax: +886 (0) 2 8751 9737 Room 1103, No. 666 West Huaihai Road, E-mail (Sales) E-mail (Support) E-mail (General Enquiries) E-mail (Sales) E-mail (Support) E-mail (General Enquiries) Shanghai, 200052 China Tel: +86 21 62351596 Fax: +86 21 62351595 [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] Web Site http://ftdichip.com System and equipment manufacturers and designers are responsible to ensure that their systems, and any Future Technology Devices International Ltd (FTDI) devices incorporated in their systems, meet all applicable safety, regulatory and system-level performance requirements. All application-related information in this document (including application descriptions, suggested FTDI devices and other materials) is provided for reference only. While FTDI has taken care to assure it is accurate, this information is subject to customer confirmation, and FTDI disclaims all liability for system designs and for any applications assistance provided by FTDI. Use of FTDI devices in life support and/or safety applications is entirely at the user’s risk, and the user agrees to defend, indemnify and hold harmless FTDI from any and all damages, claims, suits or expense resulting from such use. This document is subject to change without notice. No freedom to use patents or other intellectual property rights is implied by the publication of this document. Neither the whole nor any part of the information contained in, or the product described in this document, may be adapted or reproduced in any material or electronic form without the prior written consent of the copyright holder. Future Technology Devices International Ltd, Unit 1, 2 Seaward Place, Centurion Business Park, Glasgow G41 1HH, United Kingdom. Scotland Registered Company Number: SC136640 18 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 Appendix A – References Acronyms and Abbreviations Terms Description CTS Clear To Send DSR Data Set Ready DTR Data Terminal Ready HEX Hexadecimal RTS Request To Send TTL Transistor-Transistor Logic UART Universal Asynchronous Receiver Transmitter USB Universal Serial Bus 19 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 Appendix B – List of Figures List of Figures FIGURE 1 THE APPLICATION IN PLAY STORE ........................................................................................................... 3 FIGURE 2 LAUNCH APPLICATION ............................................................................................................................ 3 FIGURE 3 MAIN SCREEN.......................................................................................................................................... 4 FIGURE 4 SEND PLAIN TEXT DATA .......................................................................................................................... 5 FIGURE 6 SEND SPECIAL KEY CODE DATA ............................................................................................................... 6 FIGURE 7 SELECT PROTOCOL .................................................................................................................................. 7 FIGURE 8 SELECT FILE DESTINATION ...................................................................................................................... 7 FIGURE 9 SELECT DIRECTORY.................................................................................................................................. 8 FIGURE 10 CREATE NEW FILE.................................................................................................................................. 8 FIGURE 11 SELECT A FILE ........................................................................................................................................ 9 FIGURE 12 SELECT DIRECTORY................................................................................................................................ 9 FIGURE 13 SELECT PROTOCOL .............................................................................................................................. 10 FIGURE 14 SELECT A FILE ...................................................................................................................................... 10 FIGURE 15 REFRESH FILE LIST ............................................................................................................................... 11 FIGURE 16 MENU ICON ON TABLET DEVICE ......................................................................................................... 12 FIGURE 17 SERIAL SETTINGS ................................................................................................................................. 12 FIGURE 18 INFORMATION ON STATUS BAR ......................................................................................................... 13 FIGURE 19 SELECT CONTENT FORMAT ................................................................................................................. 14 FIGURE 20 CHARACTER FORMAT.......................................................................................................................... 14 FIGURE 21 HEXADECIMAL FORMAT ..................................................................................................................... 15 FIGURE 22 SELECT FONT SIZE ............................................................................................................................... 16 FIGURE 23 SELECT ECHO FUNCTION ..................................................................................................................... 17 20 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24242 FTDI_UART_Terminal_User_Manual Version Document Reference No.: FT_0006668 1.0 Clearance No.: FTDI# 343 Appendix C– Revision History Document Title: AN_242 FTDI_UART_Terminal_User_Manual Document Reference No.: FT_000838 Clearance No.: FTDI# 343 Product Page: http://www.ftdichip.com/FTProducts.htm Document Feedback: Send Feedback Revision Changes Date 1.0 Initial Release 24/06/2013 21 Copyright © 2013 Future Technology Devices International Limited