Related Manuals for PalmMicro AR1688
Summary of Contents for PalmMicro AR1688
- Page 1 C o m m u n i c a t i o n s , I n c . AR1688 Based IP Phone Development Guide PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
-
Page 2: Table Of Contents
C o m m u n i c a t i o n s , I n c . Table of Contents Program Structure ............4 AR1688 Program Director y ................ 4 Bin Directory ....................4 Doc Directory ....................4 Include Directory .................. - Page 3 Setting phone ..................... 39 Other Function ................... 39 Update Program ................... 39 Read/Write Phone Settings ................. 40 Read/Write PhoneBook ................40 Debug Function ................... 40 PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
-
Page 4: Program Structure
C o m m u n i c a t i o n s , I n c . 1 Program Structure We provide software API for all AR1688 IP phone authorized manufacturers and end users. The API includes part of source codes and part of object files. Those source codes are provided under GPL license. -
Page 5: Src Directory
Full source code of those special tools in "bin" directory, in Visual Studio 2008 or MS Visual C++ 6.0 project. AR1688 Program Structure AR1688 series phones use P rogram Flash with 2M bytes. Details as follows: structure, each page has 64k page0 -- boot.bin and safemode.bin, ar168x_none_xx_xxxxxx.bin page1 -- settings.dat, options, flags, digitmap and address book... -
Page 6: Page11
The size of ring tone data in page2 -- page4 must be 192K(3×64K), namely 196608 bytes, and the filename format is ringtone_xxx.dat, where xxx are any strings. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 7: Page31
– page31 are divided into 2 parts with the same contents, which is a safety characteristic of the AR1688. page12 – page19 is section 1 and the data starts in page 12. page22 – page31 is section 2 and the data starts in page 22. We distinguish the two parts from each other by the configuration option “system_page”. -
Page 8: Program Compile
C o m m u n i c a t i o n s , I n c . 2 Program Compile Compile Environment Compile AR1688 with SDCC compiler. The configuration of compile path is in the file D:\sdcc\src\makefile and the configuration determines location of compiler and program. Makefile is as follows:... -
Page 9: Compile Operation
[protocol]=SIP, import settings_sip.htm and [protocol]=IAX2, import settings_iax2.htm; Compile Operation Compile operation of AR1688 runs on DOS environment. Enter the directory C:\sdcc\src\, which includes compile (mk.bat) and clean (clean.bat) bat file, as follows: mk.bat Batch File mk.bat compiles source codes and produces program files. - Page 10 “XX” that must be lowercase. In version.h, they are: // Country and District #define RES_CN #define RES_US PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
- Page 11 Compile ar168x phone, using SIP protocol, English and no OEM. Command line: C:\sdcc\src>mk ar168x sip us (Enter) After compiling, phone upgrade program file, ar168x_sip_us_032000.bin is created in src directory. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
-
Page 12: Clean.bat Batch File
Error and Warning information will show. clean.bat Batch File clean.bat is to clear all compile results and its syntax: clean(Enter). PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 13: Update
C o m m u n i c a t i o n s , I n c . 3 Update Updating operation of AR1688 series phones supports TFTP and HTTP protocols. Tftp Update Enter DOS window and input tftp(enter), help information for this command displays. -
Page 14: Update Ring Tone
Read Phone Information Use get parameter to read phone information and write it to specified file. Command syntax: tftp –I host get destination (Enter). PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 15: Http Update
Enter phone setting WEB page, select update program item and open update program page, as follows: According to your request, choose the updating option and finish the updating operation. Updating operation in WEB page will be found in the AR1688 phone user guide. We show PalmMicro Communications, Inc. © 2006-2007... -
Page 16: Firmware
It is a binary file for updating phone ring tone. Steps of generating it are: Record a pcm ring by referencing chapter 6 Use convert command to convert ringtone.pcm to a binary file ringtone_allice.dat, for example: PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 17: Call Hold Music File
Use convert command to convert holdmusic.pcm to a binary file holdmusic_allice.dat, for example: convert -r holdmusic.pcm holdmusic_allice.dat (Enter) Update the phone with holdmusic_allice.dat Note: Description of convert.ext can be found in chapter 5 PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 18: Debug
X = 3：stop 8K sampling digital self-test; X = 4：start speaker mode, 8K sampling digital self-test. Stopping test is “#6*3”. ·Press “#9*0” combination to restart the phone. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 19: Command And Batch File
[-C|--bin2cfg]: “C” in -C must be uppercase，Convert configuration binary file to text file; [-w|--web2web]: Convert html file to AR1688 acceptable html format; [-i|--web2info]：Read parameters in the web page and convert it to a header file. [-h|--bin2h]: Convert a file to a c headfile;... - Page 20 C:\sdcc\src>..\bin\convert -C settings.dat settings_201.txt (Enter) C:\sdcc\src>..\bin\convert --bin2cfg settings_iax2.dat settings_iax2.txt (Enter) After above operation completes, settings_iax2.txt is created in D:\sdcc\src. -w | --web2web Convert the html file to AR1688 acceptable html format. Command syntax: convert -w srcFile dstFile (Enter) convert --web2web srcFile dstFile (Enter) SrcFile is a html file to be converted and dstFile is a specified output html file converted.
- Page 21 --bin2h srcFile dstFile (Enter) SrcFile is a binary file to be converted and dstFile is a specified output c head file converted. For example: PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
- Page 22 C:\sdcc\settings>..\bin\convert --bin2h iax2.txt settings_iax2.h (Enter) After above operation completes, settings_iax2.h is created in C:\sdcc\settings. -r | --ring2bin Cut the recorded music file to the size permitted by AR1688 and save as a binary file(bin) Command syntax: convert -r srcFile dstFile (Enter) convert --ring2bin srcFile dstFile (Enter) srcFile is a music file to be converted, and dstFile is an output binary file converted.
- Page 23 With [-f|--force] in the command line, if an output file (dstFile) has existed in the directory the file will be overwritten. Without [-f|--force] in the command line, if an output file (dstFile) has existed in the PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
-
Page 24: Getopt.bat And Setopt.bat
Write options.txt to a phone and the phone will restart. File options.txt include 2 different section of [settings] and [digitmap]. Phone configure listed under [settings]. Digit maps listed under [digitmap]. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 25: Getpb.bat And Setpb.bat
“=”. For example: “pb_name001 = support1 pb_number001 = 01088365621”: the first item in the phonebook, the name is support1and the number is 01088365621. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 26: Create Music File
Point “Transport Buttons” and click the record button Time for record ring tone is 24.48 seconds; Point “Save As…” on “File” menu and click it; Click “Options: PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 27: Cut Music File
DOS window and input following commands in sdcc\src directory: tftp -i 192.168.1.205 put holdmusic_allice.dat (Enter) “192.168.1.205”is phone IP address. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 28: Do Not Upgrade "Long" Ring Tone
Don’t upgrade a ring tone more than 192K bytes. AR1688 ring tone is located in bank 2, 3, 4, total 192k bytes; AR1688 hold music is located in bank 5, 6, 7, the format and size is the same as ring tone. -
Page 29: Http Auto-Provisioning
Please choose the keyboard or WEB orders and set Auto-provisioning server address and server port. For more details see phone user guide in chapter 5.1.7 or 5.2.5. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 30: Auto-Upgrade Settings File And Firmware File
When “auto-upgrade interval” in the phone settings expires, the phone will connect with the server to get [MAC].txt automatically. If config_id is the same with the one in the phone, it will stand by. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... -
Page 31: How To Modify Web Page
Input format: mkweb [protocol] (Enter) For the converting operation of the phone setting page. After modifying settings_iax2.htm or settings_sip.htm, run mkweb.bat, converting .htm file to html file accepted by AR1688 and generating web_info_iax2.h and web_info_sip.h in SDCC\include\. Note: We convert web_info_iax2.h and web_info_sip.h according to the English setting page. -
Page 32: Mkweball.bat
Step 4. Modify the mkweball.bat file to deal with files in \res\fr\ directory. Contents in mkweball.bat: IF "%1"=="cn" GOTO Do_cn GOTO Do_us :Do_cn md temp_cn ..\..\bin\convert -w -f cn\abort.htm temp_cn\abort.htm ..\..\bin\convert -w -f cn\failure.htm temp_cn\failure.htm PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA... - Page 33 ..\..\bin\convert -w -f fr\abort.htm temp_fr\abort.htm ..\..\bin\convert -w -f fr\failure.htm temp_fr\failure.htm ..\..\bin\convert -w -f fr\login.htm temp_fr\login.htm ..\..\bin\convert -w -f fr\phonebook_head.htm temp_fr\phonebook_head.htm ..\..\bin\convert -w -f fr\phonebook_tail.htm temp_fr\phonebook_tail.htm PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
-
Page 34: Modify Page Layout
:End Step 5. Input command line mkweball fr(Enter), convert all files in \res\fr\ directory to html files accepted by AR1688 and save them in a temporary directory \res\temp_fr\; Step 6. Overwrite files in \res\fr\ with files in \res\temp_fr\; Step 7. Recompile the phone program with mk.bat and choose French, for example, mk ar168f iax2 fr;... -
Page 35: Delete Option
Delete above codes and save the file; Step 2. Input command line mkweb iax2(Enter), convert settings_iax2.htm in \res\us\ to a html file accepted by AR1688 and generate a new file settings_iax2.htm in res directory; Step 3. While doing step2, generate a new web_info_iax2.h in SDCC\include directory;... -
Page 36: How To Add Regional And Language
Chinese and English, volunteers all over the world helped us to do the entire localization works. I believe that we can do this again with AR1688, hopefully even better because it is well planned from the beginning. - Page 37 For users with less programming experience, only step 3, 4 and 5 are necessary, we will do the other works after we have received the translations for step 3, 4 and 5. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
-
Page 38: How To Change Mac Address
If you do not know how to upgrade by TFTP, do not know how to enter safe-mode, or do not know what MAC address is, you can skip the rest. Make sure you have most recent AR1688 API in hand, feel free to write to support@palmmicro.com.cn for a copy if you do not have it. -
Page 39: Manager Tool
C o m m u n i c a t i o n s , I n c . 11 Manager Tool Manager.exe can manage AR1688 easily, such as upgrading, updating, debug and so on. AR1688 user can look AR1688 information with PalmTool no longer. -
Page 40: Read/Write Phone Settings
More phones can be selected at the same time. Debug Function With debug window explore all kinds of messages of AR1688. Click “Start Debug” controller and pop debug window. Explore different phone information according to debug options. - Page 41 Click “Start Debug” controller and pop debug window, the text on the controller will change to “Stop Debug”. Click “Stop debug” and the debug window close. PalmMicro Communications, Inc. © 2006-2007 Room 0611, Bldg.B Tsinghua Tongfang Technology Plaza, 1 Wangzhuang Road, Beijing, CHINA...
Need help?
Do you have a question about the AR1688 and is the answer not in the manual?
Questions and answers