Application Note AN_241 FTDI_AOA_HyperTerm_User_Manual Version1.0 Issue Date: 2013-05-03 Android Honeycomb (3.1) and later versions support Android Open Accessory Protocol, which can receive and send data from an Android accessory without additional drivers. The utility is for FT311D/FT312D (USB Android Host chip) which is configured to be a USB to UART device. 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_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 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............................................................................................................................... 6 2.2.1 Send Plain Text Data.......................................................................................................... 6 2.2.2 Send Hexadecimal Format Data ........................................................................................ 6 2.2.3 Send Special Key Code Data .............................................................................................. 7 2.3 2.3.1 Receive File........................................................................................................................ 8 2.3.2 Send File .......................................................................................................................... 11 2.4 3 File Transfer ........................................................................................................................... 8 Menu Functions ................................................................................................................... 13 2.4.1 Content Format ............................................................................................................... 13 2.4.2 Font Size .......................................................................................................................... 15 2.4.3 Save Content Data ........................................................................................................... 16 2.4.4 Clean Screen .................................................................................................................... 16 2.4.5 Echo ................................................................................................................................. 16 2.4.6 Online Help ...................................................................................................................... 16 Contact Information...................................................................................................................... 17 Appendix A – References ...................................................................................................................... 18 Document References....................................................................................................................... 18 Acronyms and Abbreviations ............................................................................................................ 18 Appendix B – List of Figures .................................................................................................................. 19 Appendix C– Revision History ............................................................................................................... 20 1 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 1 Introduction This utility is for FT311D or FT312D (USB Android Host chips) which support the USB to UART bridge function. It is a convenient terminal application for use on an Android device. Android Honeycomb (3.1) and later versions support Android Open Accessory Protocol, which can receive and send data from an Android accessory without additional drivers. 1.1 Features • The application will open automatically when you plug in the FT311D or FT312D Android Open Accessory devices. • Suitable for use on any Android platform supporting Android Open Accessory Mode (Typically 3.1 onwards, however some platforms may port Open Accessory Mode to version 2.3.4). • Basic UART interface with RXD, TXD, RTS, CTS pins option. • Provide general terminal UART utility; easily adaptable to a console function. • Support CTS/RTS Flow control. • Support Baud from 300 to 921600 with CTS/RTS flow control. • Support Baud from 300 to 115200 without flow control. • Save file and Send file functions support XModem, YModem and ZModem file transfer protocols. • FT312D enlarges the UART RX buffer size to 5512 bytes for enhanced UART data streaming performance. FT311D RX buffer is 512Byte. • USB Plug and Play. • Provide power source to the Android device via the Y-cable configuration. • USB 2.0 Full Speed compatible. • USB error and over current indicator. • Suitable for TTL, RS232, RS422 or RS485 depending on the transceiver used in conjunction with the FT311D or FT312D. 2 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 1.2 Install Application Find this application in play store by searching “ftdi aoa” and then install it. Figure 1 The Application in Play Store 1.3 Launch and Exit Application When your android device is attached with FT311D/FT312D AOA device, it will ask you to execute this application. Figure 2 Launch Application To exit this application, you should tap the back button and it will show a notification message. Then tap the back button again to exit before the notification message disappears. Note that you have to reset or re-plug the FT311D/FT312D AOA device if you want to use it again. 3 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 2 Functions This section describes how to use this utility. Figure 3 Main Screen 2.1 Serial Settings Tap the “Setting” button and it shows a row with several setting items for serial settings. Figure 4 Serial Settings 4 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 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 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 or RTS/CTS flow control. It will show a warning message when “none” flow control is selected. After you select the required setting for each item, tap the “Configure” button to set it. “Setting” button becomes “Key Code” button and setting information will be shown on status bar: content format and UART setting. Figure 5 Information on Status Bar Note you can only do this once. To change settings a second time, the accessory has to be unplugged from the Android system and then re-inserted. 5 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 2.2 Send Data The sent data is also shown in the data area when the content format is character format, otherwise it will show a warning message three times when you tap the “Write” button. You may also tap the data format button to toggle CHAR or HEX format for sending data. 2.2.1 Send Plain Text Data Input data in the input area and tap “Write” button to send data when the data format button shows “CHAR”. Figure 6 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 7 Send Hexadecimal Format Data 6 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 Note you 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 you tap the “Write” button. 2.2.3 Send Special Key Code Data Tap “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 8 Send Special Key Code Data 7 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 2.3 File Transfer File transfer functions are allowed after the UART is configured and when content format is set to character format, otherwise it will show a warning message when you tap the “Save to File” button or “Send File” button. 2.3.1 Receive File Step 1: Tap “Save to File” button to prepare receiving file. Step 2: Select protocol. Figure 9 Select Protocol Step 3: Select file destination. I. For “ASCII”, ”XModem-CheckSum”, ”XModem-CRC” and “XModem-1KCRC” protocol, you could create a new file or select an exist file for saving. Figure 10 Select File Destination 8 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 (1) Create New File Tap "Select Directory" to select a directory for new file when it is in the folder you want. Figure 11 Select Directory Then input file name and tap “OK” to create a new file. Figure 12Create New File 9 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 (2) Save to File Select an exist file. Figure 13 Select a File II. For “YModem” and “ZModem” protocol, you need to select a folder for file saving. The file name will be created automatically depending on the content information. Figure 14 Select Directory Status bar will show the name of saving file and the saving progress. 10 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 2.3.2 Clearance No.: FTDI# 339 Send File Step 1: Tap “Send File” button to sending file. Step 2: Select protocol. Figure 15 Select Protocol Step 3: Select a file. Figure 16 Select a File Status bar will show the name of sending file and the sending progress. 11 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 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 17 Refresh File List 2. ZModem protocol of FTDI AOA HyperTerm is a simple file transfer protocol. It is implemented and verified with Microsoft XP hyper terminal and Moxa PComm terminal. 12 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 2.4 Menu Functions For tablet devices, tap the menu icon to launch menu: Figure 18 Menu Icon on Tablet Device For phone devices, press menu key to launch menu. 2.4.1 Content Format Select the data format of the content showed in data area. Default content format is character format. Figure 19 Select Content Format 13 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 I. Clearance No.: FTDI# 339 Character Here is the data shown in character format: Figure 20 Character Format II. Hexadecimal Here is the data showed in hexadecimal format: Figure 21 Hexadecimal Format Note that when content format is hexadecimal format, the new incoming data sent to Android device is not shown. 14 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 2.4.2 Clearance No.: FTDI# 339 Font Size Select the font size of the content shown in the data area. Default font size is 12. Figure 22 Select Font Size 15 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 2.4.3 Clearance No.: FTDI# 339 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.4 Clean Screen Clean all content in data area. 2.4.5 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 echo function is on. Figure 23 Select Echo Function 2.4.6 Online Help Get this user manual from FTDI website. 16 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 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 17 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 Appendix A – References Document References FT311D Data Sheet FT312D Data Sheet Acronyms and Abbreviations Terms Description AOA Android Open Accessory CTS Clear To Send HEX Hexadecimal RTS Request To Send RXD Received Data TTL Transistor-Transistor Logic TXD Transmitted Data UART Universal Asynchronous Receiver Transmitter USB Universal Serial Bus 18 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 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 SERIAL SETTINGS ..................................................................................................................................... 4 FIGURE 5 INFORMATION ON STATUS BAR ............................................................................................................. 5 FIGURE 6 SEND PLAIN TEXT DATA .......................................................................................................................... 6 FIGURE 7 SEND HEXADECIMAL FORMAT DATA ...................................................................................................... 6 FIGURE 8 SEND SPECIAL KEY CODE DATA ............................................................................................................... 7 FIGURE 9 SELECT PROTOCOL .................................................................................................................................. 8 FIGURE 10 SELECT FILE DESTINATION .................................................................................................................... 8 FIGURE 11 SELECT DIRECTORY................................................................................................................................ 9 FIGURE 12CREATE NEW FILE .................................................................................................................................. 9 FIGURE 13 SELECT A FILE ...................................................................................................................................... 10 FIGURE 14 SELECT DIRECTORY.............................................................................................................................. 10 FIGURE 15 SELECT PROTOCOL .............................................................................................................................. 11 FIGURE 16 SELECT A FILE ...................................................................................................................................... 11 FIGURE 17 REFRESH FILE LIST ............................................................................................................................... 12 FIGURE 18 MENU ICON ON TABLET DEVICE ......................................................................................................... 13 FIGURE 19 SELECT CONTENT FORMAT ................................................................................................................. 13 FIGURE 20 CHARACTER FORMAT.......................................................................................................................... 14 FIGURE 21 HEXADECIMAL FORMAT ..................................................................................................................... 14 FIGURE 22 SELECT FONT SIZE ............................................................................................................................... 15 FIGURE 23 SELECT ECHO FUNCTION ..................................................................................................................... 16 19 Copyright © 2013 Future Technology Devices International Limited Application Note AN_24141 FTDI_AOA_HyperTerm_User_Manual Version 1.0 Document Reference No.: FT_000666 Clearance No.: FTDI# 339 Appendix C– Revision History Document Title: AN_241 FTDI_AOA_HyperTerm_User_Manual Document Reference No.: FT_000832 Clearance No.: FTDI# 339 Product Page: http://www.ftdichip.com/FTProducts.htm Document Feedback: Send Feedback Revision Changes Date 1.0 Initial Release 03/05/2013 20 Copyright © 2013 Future Technology Devices International Limited