1. Introduction

Htek UC900 Series including all models:

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.

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.

Back to Top

2. Manage Configuration

2.1 Htek IP Phone Provision Process

When Htek IP Phone boots up, it will issue request one by one for these configuration files named "cfgDeviceCode.xml" →  "cfgMAC" →  "cfgMAC.xml ".

DeviceCode: Device Code is a short code represent one or one series model. e.g., device code 0012 represent UC924, so it uses cfg0012.xml; device code 0019 represent UC912 and UC912G,  so they both use cfg0019.xml.

MAC: The device MAC address, a unique 12-digit serial number of the phone. You can obtain it from the label back of the phone. And please note that it must be lowercase.

Although there are three types of configuration files the phone use, actually there are only two formats.

The format of file "cfgDeviceCode.xml" is the same with "cfgMAC.xml", they use XML language to describe the configurations.

But the "cfgDeviceCode.xml" could used to provision all phones if they are the same model, at the same time, "cfgMAC.xml" is unique for every phone.

The file "cfgMAC" is also unique for every phone. But it is proprietary binary format and is usually be used for backup the configurations because it is encrypted when you download it. Thus we don't recommend you use it to provision the phone.

Provisioning Flow Chart:

Note:

1. factory000x.bin is used in Htek factory, please don't try to provision it, otherwise it will influence the stability and Htek reserves the right to refuse to provide support in this case.

2. If the phone retrieved a configuration file successfully, it will not continue to get the next one. For example, if the phone get "cfgDeviceCode.xml" successfully, it will not try to get "cfgMAC" and "cfgMAC.xml".

2.2 Obtain Configuration Template Files

The fastest way you could obtain the cfgMAC.xml configuration template is to download it from any phones with factory default settings.

Just enter phone's webpage → Management → Configuration → Download Xml File.

You could refer to IP Phones Firmware & Release Note to get the latest firmware, so you will get the latest cfgMAC.xml. Also, you could contact support@htek.com.

2.3 Know about P-Code and P-Value

P-Code is a code starts with a capital letter P and follow by at least one positive integer.

One P-Code represents one single setting, like P47 represents Primary SIP Server of Profile 1, P747 represents Primary SIP Server of Profile 2.

The value of a P-Code is called P-Value.

For example, the Primary SIP Server of Profile 1 is 192.168.0.68:5060. In this case, P-Code is P47, P-Value is 192.168.0.68:5060.

2.4 Edit cfgDeviceCode.xml and cfgMAC.xml

The format of "cfgDeviceCode.xml" and "cfgMAC.xml" is very simple.

All the settings are contained in such a fixed structure like below.

<?xml version="1.0" encoding="UTF-8" ?>
<hl_provision version="1">
    <config version="1">
	......
	...settings area...
	......
    </config>
</hl_provision>

And the format of the setting is <P-Code para="Description">P-Value</P-Code>, e.g., <P47 para="Account1_Sipserver">192.168.0.68:5060</P47>. Although the Description field is not required, it is friendly for read.

You may see some settings don't have the same format, like <P-Code Para="Description" />, this format is only used when a setting is blank and has no default value.

Here is an example which contains a few settings to show the unbroken structure.

<?xml version="1.0" encoding="UTF-8" ?>
<hl_provision version="1">
    <config version="1">
        <!--Profile1/Basic-->
        <P47 para="Profile1_Sipserver">192.168.0.68:5060</P47>
        <P967 para="Profile1_FailoverSipserver" />
        <P4567 para="Profile1_PreferPrimaryServer">1</P4567>
        <P24065 para="Profile1_DHCPSIPServer">0</P24065>
        <P48 para="Profile1_OutboundProxy" />
        <P20047 para="Profile1_BackUpOutboundProxy" />
        <P130 para="Profile1_SipTransport">0</P130>
        <P52 para="Profile1_NatTraversal">2</P52>
        <P103 para="Profile1_DnsMode">0</P103>
        <P63 para="Profile1_CallMessageFormat">0</P63>
        <P24785 para="Profile1_TrsRelSetting">0</P24785>
        <P31 para="Profile1_SipRegistration">1</P31>
        <P81 para="Profile1_UnregisterOnReboot">1</P81>
        <P32 para="Profile1_RegisterExpiration">15</P32>
        <P24816 para="Profile1_FallBackInterval">600</P24816>
        <P25092 para="Profile1_ServerRetryCounts">3</P25092>
        <P109 para="Profile1_OutCallWithoutReg">1</P109>
        <P136 para="Profile1_RPort">0</P136>
        <P1100 para="Profile1_RFC2543Hold">1</P1100>
        <P8775 para="Profile1_ConnectMode">1</P8775>
    </config>
</hl_provision>

If a P-Code is missed in a "cfgDeviceCode.xml" or "cfgMAC.xml" file, you could add it in the <settings area> just follow the format, but please note the validity of the P-Value.

For all P-Codes and the P-Value, please ask your sale, provider or support@htek.com for the file Htek_Parameter_List.

3. Encrypt cfgMAC.xml

3.1 How to encrypt the XML configuration file

The XML configuration file could be encrypted using  algorithm.

You could encrypt the cfgMAC.xml file using openssl.

The supported algorithm is AES-128-CBC. The parameter iv is fixed 0B1E1D000F0B07091D1F04071F1E0407, and the valid key (parameter K) could contain 16 characters in [0 - 9, A - F].

Here is an example.

openssl enc -aes-128-cbc -K 001FC1BC -iv 0B1E1D000F0B07091D1F04071F1E0407 -in cfg001fc11e5105.xml -out cfg001fc11e5105b.xml

After you encrypt the cfgMAC file, you need to enable Authenticate Cfg File and set a common AES key to let the phone could decrypt the file. In the above case, you should set it as 001FC1BC.

You could find this setting on webpage → Management → Auto Provision → Set Common AES Key. (P-Code is P8631)

Back to Top

4. Customize Resource Files

Htek IP Phone allows to customize some resource files, like ring tone file, language package file and logo files. For how to customize resource files, as follows:

4.1 Customize ring 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 personalize ring tone:
For example: P8721 = 8
For more information on customizing ring tone file, please refer to <<Making Ringtone Notes>> in page 60.

4.2 Customize LCD language

Htek IP Phone supports multiple language,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 file:

Below picture shows a portion of LCD_English_Template.xml file:
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 62.

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:

Below picture shows a portion of Web_English_Template.js 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 64.

4.4 Customizing wallpaper

You can customize Htek UC923/UC924/UC926 IP phones' wallpaper.
Below table shows wallpaper's format and resolution for UC923/UC924/UC926 IP phones:

Wallpaper2 is default wallpaper, you can change configuration parameter to other wallpaper:
For more information on customizing wallpaper, please refer to <<LCD and Web GUI custom Guide >> in page 68.

4.5 Customizing screensaver

You can customize Htek UC923/UC924/UC926 IP phones' screensaver.
Below table shows screensaver's format and resolution for UC923/UC924/UC926 IP phones:

Screensaver default is Off, you can change configuration parameter to activate the Screensaver :
For more information on customizing screensaver, please refer to <<LCD and Web GUI custom Guide >> in page 68.

4.6 Customizing weblogo

You can customize Htek all phone models' weblogo on webpage.

For more information on customizing weblogo, please refer to << LCD and Web GUI custom Guide >> in page 68.

Back to Top

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:
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 UC923, UC924, UC924E, UC926, UC926E.
You can change the Screensaver server configuration to locate the file:
P20051=http(s)://192.168.0.254/Screensaver.jpg
Note: 1. Screensaver file phone gets from server will cover the screensaver photo1.
2. Only support format .jpg, .bmp.

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.jpg
Note: 1. Wallpaper file phone gets from server will cover the wallpaper6.
2. Only support format .jpg, .bmp.

Back to Top

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_9xx.bin then automatically upgrade fw9xx.rom. fw9xx.rom is all-in-one firmware file. After upgrading to the 1.0.3.73 firmware, in the next time, phone will only need upgrade one file fw9xx.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 TFTP in page 71, Upgrade through FTP in page 74 and Upgrade through HTTPS in page 75.

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, and 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/fw924.rom on localhost by browser" to verify the HTTP Server. If visiting "http://192.168.0.254/fm/fw924.rom on another computer is no prompt to download fw924.rom file, please check the firewall (Suggest to close the firewall).
(4) Change the setting of UC9xx (192.168.0.254 is HTTP server):
                                                                        
Click "SaveSet".
(5) Restart the UC9xx, 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.
(2) You need to update the settings and restart the IP Phone after "Firmware Server Path" is set. If the configured firmware server is found and a new code image is available, UC9xx IP Phone will attempt to retrieve the new image files by downloading them into the UC9xx's SDRAM. During this stage, the phones LEDs will blink more frequently until the checking/downloading process is finished. Upon verification of checksum, the new code image will be saved into the Flash. If TFTP/HTTP/FTP/HTTPS fails for any reason (e.g. TFTP/HTTP/FTP/HTTPS server is not responding, there are no code image files available for upgrade, or checksum test fails, etc.), the phone will stop the TFTP/HTTP/FTP/HTTPS process and simply boot using the existing code image in the flash.
(3) Firmware upgrade takes 3 to 8 minutes over Internet, or just 1 minute on a LAN. We recommend you to upgrade the FW in a controlled LAN environment.

Back to Top

7. Obtain Provisioning Server's Address

Htek IP Phone supports to obtain the provisioning server address in below 3 ways:

• Plug and Play (PnP) Server

• DHCP Options

• Phone Flash

The priority of obtaining the provisioning server address: PNP Server (SIP PnP MCAST) --> DHCP Option 128 or 150 or 66 --> Configuration in Flash.
1) The PNP Server feature is enable default.
Webpage --> Management --> Auto Provision --> PnP Active: No/Yes
If you set "Yes", the Phone will obtain the provisioning server address from the PnP Server.
2) Setting of "DHCP Option 128 or 150 or 66":
If you set "PnP Active" to "No", login Webpage --> Management --> Auto Provision --> Allow DHCP Option (128 or 150 or 66) To Override Server: No/Yes
If you set "To Override Server" to "Yes", the Phone will obtain the provisioning server address from the DHCP Option (128). For examples:
DHCP option 128 is tftp://192.168.1.240/cfg, the phone will get the configuration file from 192.168.1.240/cfg through TFTP protocol.
If the default setting is:
DHCP option 66 is http://192.168.1.240/cfg, the phone will get the configuration file from 192.168.1.240/cfg through HTTP protocol.
3) Configuration in Flash.
If you set both "PnP Active" and "To Override Server" to "No", or don't set DHCP option 128/66/150 in your DHCP server, the phone will obtain the provisioning server address from the setting "Config Server Path".
For examples, when the setting is:
The phone will get the configuration file from 192.168.0.254/cfg through HTTP protocol.
Note: You can set the phone to automatically upgrade every certain time:
For examples:
The phone will check the configuration file and the firmware every 10080 minutes (7 days). If there are the new cfg files or the new firmware, the phone will upgrade automatically.

Back to Top

8. Update mode

Update mode sets the desired time frames for phone to perform the auto provisioning process.
Below is the introduction of the 3 updating modes in detail:

• Power On

• Repeatedly

• SIP NOTIFY Message

Power On
Power On mode is set as default. The phone will perform auto provisioning process when it is power on.
Repeatedly
The phone performs auto provisioning process at a regular interval. You can configure the interval for the Repeatedly mode. The default interval is 10080 minutes.
To activate the Repeatedly mode via web user interface:
1. Click the Management->Auto Provision:
2. AUTO Upgrade set Yes:
3. Click the "SaveSet" button to save the change.
SIP NOTIFY Message
The phone will perform auto provisioning process when receiving a SIP NOTIFY message which contains the header "Event: check-sync". If the header of the SIP NOTIFY message contains an additional string "reboot=true", the phone will reboot immediately and then perform the auto provisioning process. For this update mode, it requires the server supports.
Below picture shows the message flow:

Back to Top

9. Download and Verify Configurations

9.1 Download configuration files

Once obtaining a provisioning server address in one of the ways introduced above, the phone will connect to the provisioning server and download configuration files. During the auto provisioning process, the phone will try to download the common configuration file cfg000x.xml firstly, and then try to download the cfgMAC.xml file from the provisioning server.

9.2 Resolve and Update configurations

The phone will resolve the configuration files after downloading, then update the configurations to the phone flash. Generally, the phone will reboot to make the configurations effective after the auto provisioning process is finished.

9.3 Verify configurations

You can verify the update via phone user interface after auto provisioning, or you can verify it via web user interface
During the auto provisioning process, you can monitor the downloading requests and response messages by a wireshark tool.
Some examples show as follows:
Example1: Htek UC924 IP Phone downloads configuration files from TFTP server.
Example2: Htek UC924 IP Phone downloads configuration files from FTP server .
Example3: Htek UC924 IP Phone downloads configuration files from HTTP server .

Back to Top

10. Firmware and Configuration File Prefix and Postfix

Htek IP Phone supports Prefix and Postfix for both firmware and configuration files.
Parameter P232 and P233 are for Prefix and Postfix for Firmware, respectively. Parameter P234 and P235 are for Prefix and Postfix for Configuration file, respectively.
Firmware Prefix and Postfix allows device to download the firmware name with the matching Prefix and Postfix.
In addition, when Parameter P238 (Check New Firmware only when F/W pre/suffix changes) is set to 1, the device will only issue the Firmware Upgrade request if there are changes in the firmware Prefix or Postfix.
Below are the firmware BASIC NAMES that are related to UC924P:
If the firmware version is earlier than 1.0.3.73, the firmware BASIC NAMES as follows:

• boot_924.bin

• img_924.bin

• ring4.bin

• ring5.bin

• ring6.bin

• ring7.bin

• ring8.bin

• Language.tar

• hlpres.tar

Service provider can use "hl_" as prefix, and "_1.0.3.70" as postfix, the above files will be changed to:

• hl_boot_924.bin_1.0.3.70

• hl_img_924.bin_1.0.3.70

• hl_ring4.bin_1.0.3.70

• hl_ ring5.bin_1.0.3.70

• hl_ ring6.bin_1.0.3.70

• hl_ ring7.bin_1.0.3.70

• hl_ ring8.bin_1.0.3.70

• hl_ Language.tar _1.0.3.70

• hl_ hlpres.tar _1.0.3.70

If the firmware version is 1.0.3.73 or later than 1.0.3.73, the firmware BASIC NAME as follows:

• fw924.rom

Service provider can use "hl_" as prefix, and "_1.0.3.73" as postfix, the above files will be changed to:

• hl_ fw924.rom _1.0.3.73

In this way, all of the firmware with different version could be stored in one single directory, and they could be differentiated by using prefix or postfix, i.e., all files with a postfix of "_1.0.3.73" belong to the firmware version 1.0.3.73.
Same rule applies to configuration files, i.e., for configuration file named "cfg001fc1001708", there could be 3 versions: "hl_ cfg001fc1001708_cfg001", "hl_ cfg001fc1001708_cfg002", and "hl_ cfg001fc1001708_cfg003". The BASIC NAME of the configuration file is "cfg001fc1001708", but there are 3 different versions, the one that will be accepted is the one with matching prefix and postfix specified in the current configuration.

Back to Top

11. Firmware Server and Configuration File Server

Beside the Prefix and Postfix for firmware and configuration files, different server paths for firmware upgrade or Configuration File Server can be specified in different FQDN, i.e.:
The parameters are P192 and P237 for Firmware and Config Server

Back to Top

12. Manage Firmware and Download Configuration File

When parameter P194 (Auto Upgrade) is set to 1, Service Provider can use P193 (Auto Check Interval) to have the devices periodically check with either Firmware Server or Config Server, whenever they are defined. This allows the device periodically check if there are any new changes need to be taken on a scheduled time. By defining different intervals in P193 for different devices, Service Provider can distribute the Firmware or Configuration File download schedule to reduce the Firmware or Provisioning Server load at any given time.

Back to Top

13. Pre_Configuration and Configuration Redirection

Please note:If your phone default setting is as below: 
Currently Htek Phone does not support pre_configuration and configutration Redirection, please refer to section 6 in page 24.
For mass deployment, we provide TFTP/HTTP redirection service. By default, all Htek products point to our provisioning system. When a unit is powered up, it will automatically contact our provisioning server. Our provisioning server will redirect the unit to customer's TFTP/FTP/HTTP/HTTPS server. The unit will reboot and send further provisioning request to ask for configuration file (or firmware file) from customer's TFTP/FTP/HTTP/HTTPS server.
Below is the information that we need from service providers for TFTP/HTTP redirection:

1. MAC address range, this should be printed on the carton box

2. Your TFTP/FTP/HTTP/HTTPS server IP address

3. Your company name and address

Here are the things that service providers should do:

1. Create configuration files for all the devices and put them on your TFTP/HTTP server.

2. Download the latest official release from www.htek.com/support/Document_And_Firmware and put them on your TFTP/FTP/HTTP/HTTPS server (same directory as above)

3. After we inform you that the devices have been entered into our central provisioning database, please take out a few devices to test. Upon powering up, they should contact our provisioning server https://rps.htek.com/index.php/fn/g first, and then get redirected to your TFTP/FTP/HTTP/HTTPS server and pull out the configuration files and the firmware files. They will be upgraded to the latest firmware with your configurations.

Back to Top

14. Automatic Provisioning Within LAN

Htek products support DHCP Option 66 or 128 or 150 for automatic provisioning within a Local Area Network. The provisioning server URL is embedded inside standard option 66 or 128 or 150 of DHCP responses.
Htek IP Phones send DHCP DISCOVER with the following information:
DHCP Server can be configured to send the following information in its DHCP OFFER. Please notice that in this example, an HTTP://URL is provided in the Option 66 "TFTP Server Name" field or Option 128 "TFTP server IP address" or Option 150 "TFTP server address". Device will then issue HTTP requests instead of the traditional TFTP requests to the server. This design makes more flexible in device provisioning.

Back to Top

15. Troubleshooting

This part provides guidance to help you solve problems you might encounter when deploying phones.
If you require additional information or assistance with the deployment, please contact your system administrator.
Why does the phone fail to download configuration files?

• Ensure that auto provisioning feature is configured properly.

• Ensure that the provisioning server and network are reachable.

• Ensure that authentication credentials configured on the phone are correct.

• Ensure that configuration files exist on the provisioning server.

Why does the provisioning server return HTTP 404?

• Ensure that the provisioning server is properly set up.

• Ensure that the access URL is correct.

• Ensure that the requested files exist on the provisioning server.

Why does the phone display "Network Down"?

• Ensure that the Ethernet cable is plugged into the Internet port on the phone and the Ethernet cable is not loose.

• Ensure that the switch or hub in your network is operational.

• Ensure that the configurations of network are properly set in the configuration files.

Why is the permission denied when uploading files to the root directory of the FTP server?

• Ensure that the complete path to the root directory of the FTP server is authorized.

• Check security permissions on the root directory of the FTP server, if necessary, change the permissions.

Why doesn't the phone obtain the IP address from the DHCP server?

• Ensure that settings are correct on the DHCP server.

• Ensure that the phone is configured to obtain the IP address from the DHCP server.

Why doesn't the phone display the Language, only display English on LCD and Web?

• Ensure that the name of the language is correct.

• Ensure that the network is available and the root directory is right for downloading.

• Ensure that the parameters are correctly set in the configuration files.

• Ensure that the language's Coding format is UTF-8.

Why doesn't the phone display the wallpaper or ScreenSaver or the weblogo of webpage?

• Ensure that the file format of the wallpaper, ScreenSaver and weblogo is *.jpg.

• Ensure that the size of the wallpaper, ScreenSaver and weblogo file is not larger than that the phone supports, or check the hlpres.tar is not larger than 2M.

• Ensure that the name of the wallpaper, ScreenSaver and weblogo are correct.

• Ensure that the network is available and the root directory is right for downloading.

• Ensure that the wallpaper, ScreenSaver and weblogo files in the hlpres.tar file.

Why doesn't the phone update configurations?

• Ensure that the configuration files are different from the last ones.

• Ensure that the phone has downloaded the configuration files.

• Ensure that the parameters are correctly set in the configuration files.

Back to Top

16. Glossary

MAC Address: A Media Access Control address (MAC address) is a unique identifier assigned to network interfaces for communications on the physical network segment.
DHCP: Dynamic Host Configuration Protocol (DHCP) is a network configuration protocol for hosts on Internet Protocol (IP) networks. Computers that are connected to IP networks must be configured before they can communicate with other hosts.
FTP: File Transfer Protocol (FTP) is a standard network protocol used to transfer files from one host to another host over a TCP -based network, such as the Internet. It is often used to upload web pages and other documents from a private development machine to a public web-hosting server.
HTTP: The Hypertext Transfer Protocol (HTTP) is an application protocol for distributed, collaborative, hypermedia information systems. HTTP is the foundation of data communication for the World Wide Web.
HTTPS: Hypertext Transfer Protocol Secure (HTTPS) is a combination of Hypertext Transfer Protocol (HTTP) with SSL/TLS protocol. It provides encrypted communication and secure identification of a network web server.
TFTP: Trivial File Transfer Protocol (TFTP) is a simple protocol to transfer files. It has been implemented on top of the User Datagram Protocol (UDP) using port number 69.
AES: Advanced Encryption Standard (AES) is a specification for the encryption of electronic data.
URL: A uniform resource locator or universal resource locator (URL) is a specific character string that constitutes a reference to an Internet resource.
XML: Extensible Markup Language (XML) is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.

Back to Top

17. How to Edit xml format configuration file

You can customize configuration parameters by editing XML configuration file "cfg000x.xml", and different device would use different file name.

For example, if you have a Htek device UC924 and you want to configure its Line key 1 as BLF to monitor extension 1002, you can realize this by following two methods.
1.Create a new XML file and add configuration parameters.
Step 1: Create a new XML file entitle it as cfg0000.xml. If your Htek device is UC924, you should entitle it as cfg0012.xml
Step 2: Login webpage, find out Web Setting Path of line key1. Function Keys-Line Key-Key1
Step 3: Refer to UC900 Series IP Phones Provisioning#23. Parameter List, you can get detailed description of this parameter.
According to description of parameter, we know parameter P41200 should be 3, parameter P41300 should be 1002 and parameter P41600 should be 20.
Step 4: Edit cfg0012.xml as follow
Step 5: Put this XML configuration file in your config server path.
Step 6: Restart phone to apply to the settings.
2.Edit relevant parameter in the template file(template.xml)
Step 1: Login webpage, enter Function Keys -> Memory Key
Step 2 : Configure options you want, for example
Step 3: click "saveset" button to save the configuration.
Step 4: Enter Management -> Configuration
Click "Download Xml File" button to download the configuration Xml file. This file includes all parameters of this phone.
Step 5: Open the Xml file that you downloaded, you can find that the parameter has been changed.
Step 6: Change the xml file's name to cfg0012.xml.
Step 7: Put this XML configuration file in your config server path.
Step 8: Restart phone to apply to the settings.

Back to Top

19. Making Ringtone Notes

Prepare:
Tool: ringtool.exe
Ring file format: pcm
1. To make ring tone for UC9xx
1.1 Double click ringtool.exe
1.2 Select the Maximum Length and Output Filename:
For example, 16 seconds, ring 2.bin
1.3 Click Select to Input the desired ring tone file, and then click Generate Ringfile.
Then, you will get Ringfile Created.
1.4 Now, you get the ring2.bin, also you can rename it as ring5.bin, or other the one you want to replace.
1.5 Upload the ring file by TFTP or HTTP, the ringtone is replaced successfully.

Back to Top

20. LCD and Web Language Custom Guide

20.1 LCD Language custom guide

1. You need to contact us about how to obtain the Language.tar file.
2. Unzip the Language.tar using 7-zip tool. 
3. Open the Language folder:
Note: The file name must be " digital_" at the beginning,the format of the file name is the order of the on the LCD.
4. For example, custom Chinese Language
If your country's language is not existing in the language folder, you can new a xml file with correct naming format. [e.g. 13_xxx(xxx).xml]
If your country's language in the folder, you can custom directly your language.
Open the LCD_English_Template.xml with UltraEdit→ Translate English into Chinese (Can't leave out any items, otherwise the upgrade failed) →save as 10_简体中文(ChineseSimplified).xml in Language folder (Coding format is UTF-8)
→ Select the Language folder→ Compress Language.tar package using 7-zip tool and Cover the original→Delete the Language folder

If you want to put your language on the front of other languages, you can also rename the file, for example: 

20.2 Web Language custom guide

1. You need to contact us about how to obtain the Language.tar file
2. Unzip the Language.tar using 7-zip tool. 
3. Open the Language folder:
Note: The file name must be " digital_letter" at the beginning. The format of the file name is the order of that on the Web.
4. For example, custom Chinese Language
If your country's language is not existing in the language folder, you can new a xml file with correct naming format. [e.g. 13_xxx.js]
If your country's language in the folder, you can custom directly your language reference Web_English_Template.js.
Open the Web_English_Template.js with UltraEdit→ Translate English into Chinese (Can't leave out any items, otherwise the upgrade failed) →save as 10_ChineseSimplified.js in Language folder (Coding format is UTF-8)
→ Select the Language folder→ Compress Language.tar package using 7-zip tool and Cover the original→Delete the Language folder

If you want to put your language on the front of other languages, you can also rename the file, for example: 
When you finish the Language.tar, you must send the Language.tar package to us, then we provide the firmware to you.

Back to Top

21. LCD and Web GUI custom Guide

Unzip the hlpres.tar package (Need to contact us to obtain the hlpres.tar package)
You can replace some file in the hlpres to finish the customization of 1.1 to 1.7

21.1 How to custom the wallpaper1-wallpaper6?

Open hlpres folder→you can custom the wallpaper4.jpg-wallpaper6.jpg (dimension:480*320 size: through Photoshop tools make the size smaller→Select the hlpres folder→Compress hlpres.tar package

21.2 How to custom the screensaver1- screensaver3?

Open hlpres folder→you can custom the screensaver1.jpg-screensaver3.jpg (dimension:480*320 size:through Photoshop tools make the size smaller) →Select the hlpres folder→Compress hlpres.tar package

21.3 How to custom the weblogo?

Open hlpres folder→you can custom the weblogo.jpg (dimension:225*93 size: through Photoshop tools make the size smaller) →Select the hlpres folder→Compress hlpres.tar package

21.4 How to custom the eights menus(.png)in the main menu?

Open hlpres folder→you can custom the .png(dimension:65*65 size: through Photoshop tools make the size smaller) →Select the hlpres folder→Compress hlpres.tar package

21.5 How to custom the ...Icon.png?

Open hlpres folder→you can custom the ...Icon.png (dimension:65*65 size: through Photoshop tools make the size smaller) →Select the hlpres folder→Compress hlpres.tarpackage

21.6 How to custom the lcdlogo_color.png?

This logo is only applicable to UC923, UC924,UC924E, UC926, UC926E.
Open hlpres folder→you can custom the lcdlogo_color.png (dimension:400*42 size: through Photoshop tools make the size smaller) →Select the hlpres folder→Compress hlpres.tar package.
Enter Menu→Display→Screensaver Time-out:1min; Screensaver Type: Time & Logo→Save, this logo displays correctly.

21.7 How to customthe lcdlogo_bw.png?

This logo is only applicable to UC601, UC901, UC902, UC903, UC912/G/GM.
Open hlpres folder→you can custom the lcdlogo_bw.png (dimension:100*11 size: through Photoshop tools make the size smaller) →Select the hlpres folder→Compress hlpres.tar package.
Enter Menu→Display->Screensaver Time-out:1min; Scrrensaver Type:Time & Logo→Save, this logo display correctly.
The lcdlogo_bw.png's property must be the following standard:
Note:
The photo's name and format must be the same as before;
The size of hlpres file is not more than 2M.
When you finish the hlpres.tar, you must send the hlpres.tar package to us, then we provide the firmware to you.

Back to Top

22. Firmware Upgrade

Please note: When the phone whose firmware version is 1.0.3.62 or earlier upgrades to 1.0.3.73, you must put the upgrade files(include fw8xx.rom/ fw9xx.rom and img_8xx.bin/ img_9xx.bin ) into the server path and the phone will upgrade img_8xx.bin/ img_9xx.bin then automatically upgrade fw8xx.rom/ fw9xx.rom.
After upgrading to the new firmware, in the next time, you will only need to put one file fw8xx.rom/ fw9xx.rom into the server path. Upgrade steps of later than 1.0.3.73 version and earlier than 1.0.3.73 version is the same.

22.1 Upgrade through HTTP

To upgrade via HTTP, the "Management"->"Auto Provision" ->"Firmware Upgrade" -> "Upgrade Mode" field needs to be set to HTTP, respectively. "Firmware Server Path" needs to be set to a valid URL of a HTTP server, server name can be in either FQDN or IP address format. Here are examples of some valid URL.
e.g. firmware.mycompany.com:5688/Hanlong
e.g. www.mycompany.com:5688/fm/Hanlong
e.g. 218.2.83.110
Instructions for firmware upgrade via HTTP:
(1) End users can choose to download the free HTTP server from http://httpd.apache.org/ or use Microsoft IIS web server. Then set up HTTP server.
(2) Unzip the firmware file and put all of them under the root/phone directory of the HTTP server.
(3) Visit "http://192.168.0.106/phone/fw924.rom" on localhost by browser to verify the HTTP Server. If visiting "http://192.168.0.106/phone/fw924.rom" on other computer is no prompt to download fw924.rom file, please check the firewall (Suggest close the firewall).
(4) Change the setting of the IP Phone (192.168.0.106 is HTTP server):
Click "SaveSet".
(5) Restart the IP Phone, and it will restart and auto-get firmware files from HTTP server.
NOTES:

• Htek recommends end-user use the Htek HTTP server. For large companies, we recommend to maintain their own TFTP/HTTP/FTP/HTTPS server for upgrade and provisioning procedures.

• Once a "Firmware Server Path" is set, user needs to update the settings and restart the IP Phone. If the configured firmware server is found and a new code image is available, the IP Phone will attempt to retrieve the new image files by downloading them into the IP Phone's SDRAM. During this stage, the IP Phone's LEDs will blink fastly until the checking/downloading process is completed. Upon verification of checksum, the new code image will then be saved into the Flash. If TFTP/HTTP/FTP/HTTPS fails for any reason (e.g. TFTP/HTTP/FTP/HTTPS server is not responding, there are no code image files available for upgrade, or checksum test fails, etc), the IP Phone will stop the TFTP/HTTP/FTP/HTTPS process and simply boot using the existing code image in the flash.

• Firmware upgrade may take as long as 3 to 8 minutes over Internet, or just 1 minutes if it is performed on a LAN. It is recommended to conduct firmware upgrade in a controlled LAN environment if possible.

• Hanlong's latest firmware is available at www.htek.com →Support →Document & Firmware.

• Oversea users are strongly recommended to download the binary files and upgrade firmware locally in a controlled LAN environment.

22.2 Upgrade through TFTP

(1) We recommend that you can install a TFTP Server(e.g. SolarWinds -TFTP -Server.exe).
(2) Make a new directory, such as D:\FM.
(3) Unzip the firmware file and put all of them under the directory D:\FM.
(4) The PC running the TFTP server and the IP Phone should be in the same LAN segment.
(5) Set TFTP Root Directory to D:\FM.
TFTP SERVER → File → Configure
(6) Go to File -> Configure -> Security to change the TFTP server's default setting from "Receive Only" to "Transmit Only" for the firmware upgrade.
(7) Start the TFTP server, Configure the Firmware Server Path with the IP address (192.168.0.240 is TFTP server) in the IP Phone's web configuration page.
(8) Save the change and restart the IP Phone.
(9) You can test your TFTP server by other PC which is in the same LAN segment.
For examples, in PC which IP address is 192.168.0.126, type command:
TFTP -i 192.168.0.240 get fw924.rom f:/fw924.rom
If your TFTP server is OK, something like "Transfer successful: " will be printed in command windows.

22.3 Upgrade through FTP

(1) Setup a FTP Server(e.g. FileZilla Server).
(2) Unzip the firmware file and put all of them under the root/phone directory of the FTP Server.
(3) Configure the FTP Server.
(4) Visit ftp://192.168.0.106/phone/fw924.rom on localhost by browser, enter username and password, and you will view upgrade file. If visiting ftp://192.168.0.106/phone/fw924.rom on other computer is no prompt to download fw924.rom file, please check the firewall (Suggest close the firewall).
(5) Configure the Firmware Server Path in the IP Phone's web configuration page.( 192.168.0.106 is FTP server)
(6) Click the "SaveSet" and then click "Restart" in the webpage.

22.4 Upgrade through HTTPS

(1) Install and configure an Apache HTTPS Server in local computer.
(2) Unzip the firmware file and put all of them under the root/phone directory of the HTTPS Server.
(3) Visit "https://192.168.0.106/phone/fw924.rom" on localhost by browser to verify the HTTPS Server. If visiting "https://192.168.0.106/phone/fw924.rom" on other computer is no prompt to download fw924.rom file, please check the firewall (Suggest close the firewall).
(4) Configure the Firmware Server Path in the IP Phone's web configuration page. (192.168.0.106 is HTTPS server)
(5) Click the "SaveSet" and then click "Restart" in the webpage.

Back to Top