OTA User Guide v1.0

Revision HistoryVersion Author Date DescriptionV1.0chris1/11/2013Initial VersionTable of Contents1.Introduction (1)1.1. Purpose and Main Content (1)1.2. Who may need this (1)age of OTA and Frequent Errors (2)2.1. Validation and error checking of Server End (2)2.1.1. Validation (2)2.1.2. Error checking (3)2.2. Server End Configuration (4)2.3. Client End Configuration (6)2.3.1. Modification of Update apk (6)2.3.2. Debugging of Update apk (6)2.4. Brief Summary (8)1.Introduction1.1.Purpose and Main ContentThis user manual is a supplement to ‘OTA release DOC.rar’. It mainly describes how to use OTA and keeps record of errors frequently occurred in practice.1.2.Who may need this?This user manual can be used for all Allwinner android solutions which have used the OTA solution following ‘OTA release DOC.rar’.age of OTA and Frequent Errors2.1.Validation and Error Checking of Server End2.1.1.ValidationAfter following ‘The OTA Server-End Configuration.pdf’, use the methods below to check if the server works properly.After the server end environment is set up, there should be a update directory in /var/lib/tomcat6/webapps/ .An example is given below, please use the right IP address of the server to replace the IP used below when you are testing.（1）Use parameters in files /var/lib/tomcat6/webapps/update/parameter.conf and /var/lib/tomcat6/webapps/update/update.conf to write sections in http://82.144.24.39/update/form.jsp:Parameters in parameter.conf are shown as below：Parameters in update.conf are shown as below:（2）Enter http://82.144.24.39/update/form.jsp on the browser，after form.jsp is opened, fill it in with the information in parameter.conf and update.conf shown above. Section id is always 1. Sections device, board, android must be filled in with parameters in parameter.conf.Section firmware is V1.0 as it is shown in update.conf. All the other sections can be left blank if no corresponding information can be found in parameter.conf and update.conf. The form.jsp should be like the one below：（3）After submission, the return page should be like the one below. The content is the same as that in update.conf.2.1.2.Error CheckingThere may be some problems during server end configuration. These problems are:（1）After submission, if nothing returns, please check the following:a.Sections mentioned above are not filled in rightly. Please make sure all parametersare the same as those in parameter.conf and update.conf.b.After modifying files in /var/lib/tomcat6/webapps/, restart service tomcat6 usingthe following command：#service tomcat6 restart（2）After submission，if it returns ‘HTTP 500 ERROR’，this means the version of Java is not right. The Java version should be ORACLE JDK 1.6 or above. Don’t use OPEN JDK. Use the following command to check Java version：# java -version2.2.Server End ConfigurationThe steps to add a new model are listed as below. An example is given with a model name b801h9. b801h9 should be replaced by the model name you are testing：1.Copy directory /var/lib/tomcat6/webapps/update and rename it b801h9. Update b801h9 to /var/lib/tomcat6/webapps.2. Restart service tomcat, then try steps in section2.1.1 to test if the right URL is returned. The test URL is http://82.144.24.39/b801h9/form.jsp now.3.After the URL http://82.144.24.39/b801h9/form.jsp has been tested without errors，it must be given to the software engineer who provides firmware for the model. The software engineer must change the URL in Update.apk to http://82.144.24.39/b801h9/update.He must also give the following information to the maintainer on the server side.（1）Properties：ro.build.version.release <---------> android in parameter.conf,ro.product.device<---------> device in parameter.conf,ro.product.board<---------> board in parameter.conf,ro.product.firmware<--------->firmware version in update.conf.（2）The new image or update.zip with the new URL for OTA update；Maintainer on the server side needs to do the following work :4. Modifying configuration files on the server end by using the properties provided：（1）/var/lib/tomcat6/webapps/b801h9/parameter.confandroid=4.2.2：based on ro.build.version.releasedevice=fiber-M784q6glow6181：based on ro.product.deviceBoard=exdoid：based on ro.product.boardparameter.conf is used to match the model, each section in it must be written properly.Please refer to ‘The Server Execution Flow’ in‘The OTA Server-End Configuration v1.00.pdf’ to add other sections by using the right properties.（2）/var/lib/tomcat6/webapps/b801h9/update.confThe content is shown as below:The firmware version is on the left side of the equality sign, it must be the same as property r o.product.firmware. The right side is the update xml link address for the firmware on the left.This link address must be replaced by the right server which is under test. For example, http://82.144.24.39/b801h9/xml/update/1.4rc3-1.4rc3-OTA.xml corresponds to /var/lib/tomcat6/webapps/b801h9/xml/update/1.4rc3-1.4rc3-OTA.xml on server82.144.24.39；（3）/var/lib/tomcat6/webapps/b801h9/xml/update/1.4rc3-1.4rc3-OTA.xml The name of this xml file must be the same as that in update.conf. Each update.zip has some XML instruction files for users to download. By analyzing them, users can get the OTA package address, OTA package md5 and the change log.command：OTA update command. Users can only recognize update_with_inc_ota at present. If Propery ‘force’ is true , it means force update. It is not supported on the client end at the moment.url: the released version update.zip addressmd5: the md5 of the released update.zipdescription：It describes the fixed bug or new functions. Multiple languages are supported.The sample XML file is like the one below：URL http://82.144.24.39/ota/1.4rc3-1.4rc3-OTA_b801h9.zip corresponds to /var/www/html/ota/1.4rc3-1.4rc3-OTA_b801h9.zip. Another download address can also be used here.MD5 can be generated by UpdateTools.jar which is provided by Allwinner or other tools which can generate MD5.（4）/var/www/html/ota/1.4rc3-1.4rc3-OTA_b801h9.zipThis file is provided by software engineer who provides firmware and must be uploaded to the server;5. Do all the modifications mentioned above and test the server. If everything is OK, go to client end to test Update.apk.2.3.Client End Configuration2.3.1.Modification of Update apk1. Modifying server URL in Update apkWrite the right URL provided by ther server side in Update\src\com\softwinner\update\Utils.java：public static final String SERVER_URL = "http://82.144.24.39/b801h9/update";If the test server address is http://82.144.24.39/test/form.jsp，the URL in Update.apk must be http://82.144.24.39/test/update；2. Modifying user manual in Update apkThe user manual can be provided with an htm file. It can be opened and edited by Word.2.3.2.Debugging of Update apkAdd some debugging code in private void sendPost()in Update\src\com\softwinner\update\CheckingTask.java Add the source code in blue as shown below to find what is the problem on the client side.2.4.Brief SummaryIf all the methods above can’t solve your OTA problems, please contact Allwinner for support.。