Htek UC802 User manual

1
Htek UC8xxSERIES SIP PHONE
Auto Provision User Guide
Nanjing Hanlong Technology Co., Ltd.
0086-25-84658050
www.htek.com
[email protected]

Table of Contents
Table of Contents
1. Introduction.................................................................................................................................................1
2. Manage Configuration ................................................................................................................................1
2.1 Obtain configuration files................................................................................................................2
2.2 Obtain phone information ..................................................................................................................3
2.3 Manage configuration files.................................................................................................................3
2.4 How to edit cfg000x.xml file...............................................................................................................3
2.5 How to edit cfg$mac file.....................................................................................................................3
2.6 How to edit cfgmac.xml file................................................................................................................7
3. Encrypt Configuration Files.........................................................................................................................9
3.1 How to encrypt the XML configuration file..........................................................................................9
4. Customize Resource Files........................................................................................................................10
4.1 Customize ring tone.........................................................................................................................10
4.2 Customize LCD language................................................................................................................10
4.3 Customize web language ................................................................................................................11
4.4 Customizing wallpaper.....................................................................................................................12
4.5 Customizing screensaver ................................................................................................................13
4.6 Customizing weblogo.......................................................................................................................13
5. Upgrade resource files..............................................................................................................................13
5.1 How to configure URL for hlpres.tar.................................................................................................13
5.2 How to configure URL for Language.tar...........................................................................................14
5.3 How to configure URL for exp_pres.tar............................................................................................14
5.4 How to configure Path for ringx.bin..................................................................................................14
5.5 How to configure URL for Screensaver............................................................................................14
5.6 How to configure URL for Wallpaper................................................................................................14

Table of Contents
6 Upgrade Firmware.....................................................................................................................................15
6.1 Configuring HTTP Server ................................................................................................................15
6.2 How to Configuring HTTP Server.....................................................................................................15
7. Obtain Provisioning Server's Address.......................................................................................................17
8. Update mode............................................................................................................................................19
9. Download and Verify Configurations.........................................................................................................21
9.1 Download configuration files............................................................................................................21
9.2 Resolve and Update configurations.................................................................................................21
9.3 Verify configurations........................................................................................................................21
10. Firmware and Configuration File Prefix and Postfix.................................................................................23
11. Firmware Server and Configuration File Server ......................................................................................24
12. Manage Firmware and Download Configuration File...............................................................................24
13. Pre_Configuration and Configuration Redirection...................................................................................25
14. Automatic Provisioning Within LAN.........................................................................................................26
15. Troubleshooting......................................................................................................................................27
16. Glossary.................................................................................................................................................28
17. How to Edit cfg000x.xml .........................................................................................................................29
18. Generate Configuration File with HLLiteTool and Upgrade the Configuration File via
HTTP/HTTPS/FTP/TFTP..............................................................................................................................33
18.1 Generate the configuration file for Htek IP Phones........................................................................33
18.1.1 Select manual mode to generate CFG file...............................................................................33
18.1.2 Select File Input mode to generate CFG file............................................................................35
18.2 Upgrade cfgmac file via HTTP/TPFP/FTP/HTTPS.........................................................................39
19.Making Ringtone Notes ...........................................................................................................................42
20.LCD and Web Language custom Guide...................................................................................................44
20.1.LCD Language custom guide ........................................................................................................44
20.2.Web Language custom guide........................................................................................................45
21.LCD and Web GUI custom Guide............................................................................................................47

Table of Contents
21.1 How to custom the wallpaper1-wallpaper6?...................................................................................48
21.2 How to custom the screensaver1- screensaver3? .........................................................................48
21.3 How to custom the weblogo?.........................................................................................................48
21.4 How to customthe eights meuns(.png)in the main menu?..............................................................48
21.5 How to customthe ...Icon.png? ......................................................................................................48
21.6 How to custom the lcdlogo_color.png? ..........................................................................................48
21.7 How to customthe lcdlogo_bw.png? ..............................................................................................48
22.Firmware Upgrade...................................................................................................................................50
22.1. Upgrade through TFTP.................................................................................................................50
22.2. Upgrade through FTP...................................................................................................................52
22.3. Upgrade through HTTPS..............................................................................................................53
23.Parameter List.........................................................................................................................................54

Introduction
1
1.Introduction
Please note:
8xx including all models:
UC802(P)/UC803(P)/UC804(P)/UC806(P)/UC840P/UC842/UC860P/UC862
Htek IP Phone could be plugged directly into an IP network and be used without any manual
configuration.
This guide provides instructions on how to provision Htek IP Phone with the minimum settings. Htek
IP Phone supports FTP, TFTP, HTTP, and HTTPS for auto provisioning and are configured by default
to use the HTTP.
This guide is a basic guidance for provisioning on Htek IP phones, including the models: Htek
UC802(P)/UC803(P)/UC804(P)/UC806(P)/UC840P/UC842/UC860P/UC862
Note:The auto provision just applies to FW 1.0.3.70 or FW after 1.0.3.70. For the latest FW, please
download from our website www.htek.com.
2. Manage Configuration
Htek IP Phone could be configured via Web Interface and via Configuration File that download
through TFTP/FTP/HTTP/HTTPS. All devices support a configuration file in proprietary binary format.
Products like UC8xx, Unicorn3xxxandUnicorn6xxxaccept configuration files in XML format inlegacy
proprietary binary format. The XML provisioning implementation also allows generic XML
configuration file on top of the MAC based configuration file.
When Htek IP Phone boots up or reboots, it will issue a request for these configuration files named
“factory000x.bin” --> “cfg000x.xml” -->”cfgMAC” --> “cfgMAC.xml “, in which “000x” is the Device
Code. Take UC862 For example, the configuration file name should
be factory0000.xml. You can refer to the <<Device Type and file list>>. where “MAC” is
the device Mac address, for example “cfg001fc10608ab”.The configuration file name should be in
lower case. The file “cfgMAC” is a proprietary binary format configuration file that must be generated
by Htek configuration tools.
Device type, Device code and file list:
Device Type
Device Code
Device file
UC862
0000
factory0000.bin/cfg0000.xml
UC842
0001
factory0001.bin/cfg0001.xml
UC860
0002
factory0002.bin/cfg0002.xml
UC840
0003
factory0003.bin/cfg0003.xml
UC806
0004
factory0004.bin/cfg0004.xml
UC804
0005
factory0005.bin/cfg0005.xml
UC803
0006
factory0006.bin/cfg0006.xml

Manage Configuration
2
UC802
0007
factory0007.bin/cfg0007.xml
UC824
0008
factory0008.bin/cfg0008.xml
UC826
0009
factory0009.bin/cfg0009.xml
Process of Htek products are as follows:
factory000x.bin -----used for factory default configuration for ODM/OEM
cfg000x.xml ----- used for update the common configuration which doesn’t include the account
information.
cfg001fc1xxxxxx ---- this file is a private format for each device
cfg001fc1xxxxxx.xml------used for configuration for each device. xml format
Provisioning Flow Chart:
Picture 1: Provisioning Flow Chart
Note:The provisioning program will apply and reload the settings after downloading the new
configuration files. It means that a provision/re-direction server can redirect the device to a
provisioning server without reboot. It can also be used to send the XML encryption password.
If factory000x.bin file does not successfully download, the provisioning program will download the
cfg000x.xml file, or download the cfgMAC file. If the cfgMAC file does not download successfully, the
provision program will download the cfgMAC.xml file.
2.1 Obtain configuration files
Before provisioning, first you need to obtain the configuration file. There are three CFG template files,
cfg000x.xml, cfg$mac and cfgmac.xml. The cfg000x.xml is a common configuration file which

Manage Configuration
3
doesn’t include the account information. The “mac” only takes effect for a specific phone. The file
name is a12-digit mac address of the phone. For example, if the phone's mac address is
001fc11a0012, the cfg$mac file name must be cfg001fc11a0012; The cfgmac.xml file name must be
cfg001fc11a0012.xml.
The phone will try to download these CFG files from the server during provisioning.
Note: The IP Phones that in FW 1.0.3.70 or FW after 1.0.3.70would only recognize CFG files which
use UTF-8 or ANSI encoding.
2.2 Obtain phone information
Before provisioning, you need the phone information i.e.
the MAC address and the SIP account .
MAC Address: The unique 12-digit serial number of the phone. You can obtain it from the back of
the phone.
SIP Account Information: It may include SIP credentials, such as the user name, password and the
IP address of the SIP server. Contact your system administrator for SIP account information.
2.3 Manage configuration files
Auto provision enables Htek IP Phone to update automatically via downloading configuration files.
Before provisioning, you may need to edit and customize your configuration file which is composed
of many configuration parameters. A configuration parameter is associated with particular field in the
web configuration page. A parameter consists of a Capital letter P and 2 to 5 digit numeric numbers.
i.e., P2 is associated with “Admin Password” in the Advanced Page. For detailed parameter list,
please refer to <<parameter list>> in page 68.
2.4 How to edit cfg000x.xml file
You can customize configuration parameters by editing XML configuration file “cfg000x.xml”, and
different device would use different file name. you can refer to<< How to Edit cfg000x.xml>>in page
40.
2.5 How to edit cfg$mac file
Cfg$mac file is a binary format configuration. It contains configuration parameters which apply to all
phone models.

Manage Configuration
4
The line beginning with “#” is considered to be the annotation, and it’s easy to understand each P
value.
The parameters commonly edited in the cfg$mac file are described as follows:
###############################################################################
#####
## Configuration template for UC860 firmware version 1.0.3.70
###############################################################################
#####
###############################################################################
#####
# Account Settings
###############################################################################
#####
#---------------------------------------
# Account 1--basic setting
#---------------------------------------
# Account Active (In Use). 0 - No, 1 - Yes
# Number: 0, 1
# Mandatory
P271 = {$line_active.line.1|1}

Manage Configuration
5
# Primary SIP Server(eg:sip.mycompany.com or IP address)
# String
P47 = {$server_host.line.1}
# Failover SIP Server (Optional, used when primary server no response)
# String
P967 =
# Second Failover SipServer (Optional, used when Failover SIP Server no response)
P8851 =
# Prefer Primary SIP Server (Yes-will register to Primary SIP Server if Failover registration expires)
# Prefer Primary SIP Server (In Use). 0 - No, 1 - Yes
# Number: 0, 1
# Mandatory
P4567 = 0
# Outbound Proxy(proxy.myprovider.com, or IP address, if any)
# string
P48 =
# Backup Outbound Proxy (This is Usually Set as IP addr)
P20047 =
# SIP Transport
# 0 - UDP, 1 - TCP, 2 - TLS
P130 = 0
# NAT Traversal. 0 - No, 1 - STUN 2 - No, but send keep alive
#Number: 0-2
# Mandatory
P52 = 2
# SIP User ID
P35 = {$username.line.1}
# Authenticate ID
P36 = {$username.line.1}
# Authenticate password
P34 = {$secret.line.1}
# Name
P3 = {$displayname.line.1}

Manage Configuration
6
# DNS Mode. 0 - A Record, 1 - SRV, 2 - NAPTR/SRV
# Number: 0-2
# Mandatory
P103 = 0
# User ID Is Phone Number.0 - No, 1 - Yes
# Number:0, 1
P63 = 0
# SIP Registration. 0 - No, 1 - Yes
# Number:0, 1
# Mandatory
P31 = 1
# Unregister On Reboot.0 - No, 1 - Yes
# Number:0, 1
# Mandatory
P81 = 1
# Register Expiration (in minutes. default is1 hour, max 45 days)
P32 = 15
# Outgoing Call Without Registration.0 - No, 1 - Yes
# Number:0, 1
# Mandatory
P109 = 1
# Local SIP Port (default 5060)
P40 = 5060
# Use Random Port.0 - No, 1 - Yes
# Number:0, 1
# Mandatory
P78 = 0
# Voice Mail UserID(UserID for voice mail system)
P33 =
# RPort.0 - No, 1 - Yes
P136 = 0
# RFC 2543 Hold.0 - No, 1 - Yes
P1100 = 1

Manage Configuration
7
Weoffer free Configuration File generator software in both Linux/Unix and Windows platform.
You can refer to <<Generate Configuration Files with HLLiteTool >> in the page 45.
2.6 How to edit cfgmac.xml file
General XML syntax consists of a list of name-value pairs. P-Value is the element and value of the
elementre presents the value for a particular configuration which P-Value represents corresponding.
Method1:
You need to download cfg.xml file from IP Phone webpage(Management->Configuration->Download
xml file) or download this cfgmac.xml file from website www.htek.com,then change the file name to
cfgmac.xml(mac is IP Phone address), and open the cfgmac.xml, See the below screen shot:
The parameters edited in the cfgmac.xml file are described as follows:

Manage Configuration
8
<?xml version="1.0" encoding="UTF-8" ?>
<hl_provision version="1">
<mac para="Mac">001fc11a0012</mac>
<config version="1">
<!--Account1/Basic-->
<P271 para="Account1.Active"></P271>
<P47 para="Account1.Sipserver"></P47>
<P967 para="Account1.FailoverSipserver"></P967>
<P8851 para="Account1.SecondFailoverSipserver"></P8851>
<P4567 para="Account1.PreferPrimaryServer"></P4567>
<P48 para="Account1.OutboundProxy"></P48>
<P130 para="Account1.SipTransport"></P130>
<P52 para="Account1.NatTraversal"></P52>
<P20000 para="Account1.Lable"></P20000>
<P35 para="Account1.SipUserId"></P35>
<P36 para="Account1.AuthenticateID"></P36>
<P34 para="Account1.AuthenticatePassword"></P34>
<P3 para="Account1.DispalyName"></P3>
<P103 para="Account1.DnsMode"></P103>
<P63 para="Account1.UserIdIsPhoneNumber"></P63>
<P31 para="Account1.SipRegistration"></P31>
<P81 para="Account1.UnregisterOnReboot"></P81>
<P32 para="Account1.RegisterExpiration"></P32>
<P109 para="Account1.OutCallWithoutReg"></P109>
<P40 para="Account1.LocalSipPort"></P40>
<P78 para="Account1.UseRandomPort"></P78>
You can edit the value in <></>field.
For example: The phone’s SIP Server is 192.168.0.100, you need to edit the <P47
para="Account1.Sipserver">192.168.0.100</P47>.
If you want to configure others, for example:
,you need to change it as
, only in this way you can change
the value.
Method 2:
Login phone webpage, configure each item you want (like, account information, programmable keys,
firmware upgrade path...). Management ->Configuration, download XML file, then change the name
to cfgmac.xml.

Encrypt Configuration Files
9
3. Encrypt Configuration Files
Htek Configuration Generator allows user to encrypt the generated configuration file with AES 128-bit
encryption. It allows user to choose not to encrypt the configuration file in Windows version, but it is
recommended to use encryption for security reason.
3.1 How to encrypt the XML configuration file
The XML configuration file could be encrypted in AES-128-CBC algorithm. The encryption password is
defined in P8631 (Management->Auto Provision->Set CommonAES Key) of the configuration file.
The Password length is from 1-16, and password must [0-9,A-F]
THE SHAREDIV::IV:0B1E1D000F0B07091D1F04071F1E0407
The OpenSSL command-line to encrypt the file is as follows:
Openssl enc –e –aes-128-cbc –K <password>-iv: 0B1E1D000F0B07091D1F04071F1E0407 –in cfg.xml –out
cfgxxxxxxxxxxxx.xml
When the XML configuration file is encrypted in this method, Phone would only be able to decrypt and parse
the file if user set the XML Config File Password in P8631 of binary configuration file or in the web UI.
Detailed steps:
Step 1: Login webpage, click ManagementConfiguration, download cfg.xml file, then run, input ”Openssl
enc –e –aes-128-cbc –K<password>-iv: 0B1E1D000F0B07091D1F04071F1E0407 –in cfg.xml –out
Cfgxxxxxxxxxxxx.xml” (xxxxxxxxxxxx is the MAC address)
THE SHARED IV: 0B1E1D000F0B07091D1F04071F1E0407
Step 2: Put the Cfgxxxxxxxxxxxx.xml under upgrade server path
Step 3: You must set theAES Key: ManagementAuto Provision: AES Key:

Customize Resource Files
10
4. Customize Resource Files
Htek IP Phone allows you to customize some resource files, such as the ring tone file, language package file
and the logo files. For how to customize these resource files, the procedure is as follows:
4.1 Customizering tone
Htek IP Phone has several factory-default ring tones (Ring1, Ring2, Ring3). You can customize
Ring4,Ring5,Ring6,Ring7 and Ring8 tone and upload them to the phone via auto provisioning.
You can change the ring tone configuration parameter to personalized ring tone:
For example:P8721 = 8
For more information on customizing ring tone file, please refer to <<Making Ringtone Notes>>in page 53.
4.2 Customize LCD language
Htek IP Phone supports multiple languages, you can modify the language and add a new language to the
phone. The following table lists all available languages, associated language files and language template files:
Available language
Associated language files
Language template file
English
(Default, can't be customized)
LCD_English_Template.xml
French
1_Français(French).xml
German
2_Deutsch(German).xml
Spanish
3_Español(Spanish).xml
Portuguese
4_Português(Portuguese).xml
Russian
5_русский(Russian).xml
Italian
6_Italiano(Italian).xml
Polish
7_Polski(Polish).xml
Turkish
8_Türk(Turkish).xml
Serbian
9_Srpski(Serbian).xml
Chinese Simplified
10_简体中文(ChineseSimplified).xml
Slovenian
12_Slovenščina(Slovenian).xml
Persian
13_Persian(Farsi).xml
Below picture shows a portion of LCD_English_Template.xml file:

Customize Resource Files
11
English is the default language, you can change configuration parameter to other languages:
For more information on customizing an LCD language, please refer to <<LCD Language custom guide>>in
page 56.
4.3 Customize web language
Htek IP Phone supports multiple language, you can modify the language and add a new language to the
phone’s webpage. The following table lists all available languages, associated language files and language
template file:
Available language
associated language files
language template file
English
(Default, can't be customized)
Web_English_Template.js
German
2_German.js
Portuguese
4_ Portuguese.js
Italian
6_Italian.js
Polish
7_Polish).js
Chinese Simplified
10_ ChineseSimplified.js

Customize Resource Files
12
Below picture shows a portion of Web_English_Template.xml file:
English is the default language, you can change configuration parameter to other languages:
For more information on customizing web language file, please refer to << Web Language custom guide>>in
page 58.
4.4 Customizing wallpaper
You can customize Htek UC840P/UC842/UC860P/UC862 IP phones' wallpaper.
Below table shows wallpaper's format and resolution for UC840P/UC842/UC860P/UC862 IP phones:
Phone model
photo format
resolution
One file size
Photo number
UC840P/UC842/UC860P/UC862
.jpg
480*320
<=2M
<=6
Wallpaper2 is default wallpaper, you can change configuration parameter to other wallpaper:

Customize Resource Files
13
For more information on customizing wallpaper, please refer to <<LCDand Web GUI custom Guide >>in page
60.
4.5 Customizing screensaver
You can customize Htek UC840P/UC842/UC860P/UC862 IP phones' screensaver.
Below table shows wallpaper's format and resolution for UC840P/UC842/UC860P/UC862 IP phones:
Phone model
photo format
resolution
One file size
Photo number
UC840P/UC842/UC860P/UC862
.jpg
480*320
<=2M
<=6
Screensaver default is Off; you can change configuration parameter to activate the Screensaver:
For more information on customizing screensaver, please refer to <<LCDand Web GUI custom Guide >>in
page 61.
4.6 Customizing weblogo
You can customize Htek all phone models' weblogo on webpage.
For more information on customizing weblogo, please refer to << LCDand Web GUI custom Guide >> in page
61.
5. Upgrade resource files
Htek IP phone supports upgrade resource files through URL(support HTTP(s) server). The files contain
hlpres.tar, Language.tar, ring4.bin, ring5.bin, ring6.bin, ring7.bin, ring8.bin, exp_pres.tar, Screensaver and
wallpaper. For how to configure these files URL as follow:
5.1 How to configure URL for hlpres.tar
You can change the hlpres server configuration parameter to locate the file:
Phone model
photo format
resolution
File size
UC840P/UC842/UC860P/UC862/U
C802(P)/UC803(P)/UC804(P)/UC80
6(P)
.jpg
225*93
<=2M

Customize Resource Files
14
P20176=http(s)://192.168.0.254/hlpres.tar
5.2 How to configure URL for Language.tar
You can change the Language server configuration parameter to locate the file:
P20175=http(s)://192.168.0.254/Language.tar
5.3 How to configure URL for exp_pres.tar
You can change the exp_pres server configuration parameter to locate the file:
P20177=http(s)://192.168.0.254/exp_pres.tar
5.4 How to configure Path for ringx.bin
You can change the Ring server configuration Path, and IP Phone will get the files: ring4.bin, ring5.bin,
ring6.bin, ring7.bin, ring8.bin automatically:
P20174=http(s)://192.168.0.254
5.5 How to configure URL for Screensaver
This parameter is only applicable to UC840, UC842, UC860, UC862
You can change the Screensaver server configuration to locate the file:
P20051=http(s)://192.168.0.254/Screensaver.png
Note: 1. screensaver file phone gets from server will cover the screensaver photo1
2. Only support format .png.
5.6 How to configure URL for Wallpaper
You can change the Wallpaper server configuration to locate the file:
P20052=http(s)://192.168.0.254/wallpaper.png
Note: 1. Wallpaper file phone gets from server will cover the wallpaper6
2.Only support format .png.

Upgrade Firmware
15
6. Upgrade Firmware
Version number and support files list:
Note:
When the phone which version is 1.0.3.71 or older upgrade to 1.0.3.73, phone will upgrade img_8xx.bin then
automatically upgrade fw8xx.rom. fw8xx.rom is all-in-one firmware file. After upgrade to the 1.0.3.73 firmware,
in the next time, phone will only need upgrade one file fw8xx.rom.
6.1 Configuring HTTP Server
Htek IP Phone supports using FTP, TFTP, HTTP and HTTPS protocols to obtain the address of provision
server. Default way is HTTP. For how to configure a HTTP server, as follows:
You can download a free HTTP server from http://httpd.apache.org/or use Microsoft IIS web server. Then
setup HTTP server.
For more information on how to configure TFTP,FTP and HTTPS servers, please refer to Upgrade through
TFTPin page 63,Upgrade through FTPin page 66 and Upgrade through HTTPSin page 67.
6.2 How to Configuring HTTP Server
Login webpage, Management”-> “auto provision” ->” Firmware Upgrade”-> “Upgrade Mode” needs to be set
to HTTP. “Firmware Server Path” needs to be set to be a valid URL of a HTTP server, server name can be in
either FQDN or IP address format. Below are examples of some valid URLs.
e.g. firmware.mycompany.com:5688/Htek
e.g. www.mycompany.com:5688/fm/Htek
e.g. 218.2.83.110
Below are Instructions for FW upgrade via HTTP:
(1)You can download a free HTTP server from http://httpd.apache.org/ or use Microsoft IIS web server. Then
setup HTTP server.
(2) Unzip the firmware file and put the files under the root/fm directory of the HTTP server.
(3) Visiting “HTTP:\\192.168.0.254\fm\fw860.rom on localhost by browser” to verify the HTTP Server. If visiting
1.0.3.58-1.0.3.72
1.0.3.73 or later
boot_8xx.bin
img_8xx.bin
hlpres.tar
Language.tar
ring4.bin
ring5.bin
ring6.bin
ring7.bin
ring8.bin
fw8xx.rom

Upgrade Firmware
16
“HTTP: \\192.168.0.254\fm\fw860.rom on another computer is no prompt to download fw860.rom file, please
check the firewall (Suggest to close the firewall).
(4) Change the setting of UC8xx (192.168.0.254 is HTTP server):
Click “SaveSet”.
(5) Restart the UC8xx, IP Phone will restart and automatically get firmware files from HTTP server.
NOTES:
(1) We recommend you to use Htek HTTP server, or you can also use your own TFTP/HTTP/FTP/HTTPS
server for upgrade and provisioning procedures.