HPT快速使用手册 1.4.0beta

 

 

1 简介

Htek话机指派工具(Htek Provision Tool,HPT)是一款配合HTEK话机使用的软件,集配置文件可视化编辑、配置文件批量生成、设备发现、设备管理、话机手动指派、PNP、配置文件服务器、固件服务器等功能与一身,可方便快捷地完成对局域网内HTEK话机的配置指派。

 

2 运行环境

系统

Windows 7 及以后版本

显示器

最小1280X800分辨率

网络

运行该软件的电脑需要与将要指派的话机在同一局域网

3 页面功能介绍

3.1 可视化编辑(可视化编辑页)

在该页可以看到当前选择的设备模板,并且可以对选择的设备的Account、LineKey、EXP_KEY、Network等进行个性化设置,其可配置项与网页端基本相同。

该页左侧为话机图片,可点击图片上面的功能按键(账号键,可程序设计功能键,扩展板功能键等),中间目录以及页面右侧的内容会对此动作作出响应。亦可以直接点击中间的目录,右侧的内容会对此作出响应。

 

3.2 配置文件批量生成(批量制作页)

在该页可以导入合适的CSV文件,批量生成配置文件。

HPT可以按照关键词替换的方式进行配置文件的批量生成。“关键词替换”替换是指,可以将配置项(即P值)配置成独一无二的字符串,如“$$userid_1”,若CSV文件中包含列头为此字符串的列,则在生成配置文件时,软件会将文件中的该字符串替换成CSV文件该列中某一行的内容(具体行由MAC列决定)。

在MAC模式中,第一列必须为“MAC”列,该列为形如“001fc1aabbcc”(小写)格式的mac地址

在以下示例中,我们希望为每一个话机设置静态IPv4地址,因而我们将IPv4地址的四位分别设置了变量$$ip1, $$ip2, $$ip3, $$ip4,并将这四个变量对应填写在HPT工具的可视化编辑页面,以及将要导入的csv文件中。

 

该页的主要功能如下:

(1)文件导入和编辑

在该页可以对导入的CSV文件进行添加行(可以自定义添加的行数)、信息编辑和修改以文件另存为等操作。

(2)批量生成配置文件格式

可以在此模块选择生成配置文件的格式(BIN文件或者XML文件)以及是否加密文件。

(3)自动填写

该功能仅在内建HTTP服务器开启时可用(服务器/程序设置页面可进行此操作)。选择自动填写后,生成的Cfg文件中配置文件路径和固件路径则会被替换成内建服务器的路径。

(4)路径选择

选择“批量生成”支持自定义生成的配置文件的存放地址;选择“生成到内建服务器”,则生成的配置文件将保存到内建服务器的cfg目录下(如:C:\Users\admin\Desktop\HPT 1.4.0beta\server\htdocs\cfg)。

 

3.3 设备发现与手动指派(在线设备页)

在该页可以扫描局域网中的设备,并对选中的设备进行手动指派、升级、刷新状态以及重启等操作。

 

该页的主要功能如下:

扫描超时调控

配置此项,影响扫描时等待每个目的IP的响应超时。此值越小,扫描越快。网络畅通时,可以将此值可以适当设小。

(2)子网扫描模式

使用此模式,可以扫描到本电脑可以访问的网络,如实现不同VLAN之间的扫描。启用时,勾选Enable,IP地址栏(IP Address)填写目标网络中的任意合法地址,子网掩码(Subnet Mask)栏填写目标网络的子网掩码。

(3)MAC过滤

“预定义”:其中为预先配置好的过滤项——Htek(00-1f-c1-)。

“自定义”:需要用户手动输入,应输入形如“00-1f-c1”的mac地址的前面部分(如00-1f,00-1f-,00-1f-c, 00-1f-c1-11-22-等)。

(4)点击IP访问话机网页

在扫描结果列表的IP Address栏,按住CTRL键并点击IP地址,即可访问话机的管理页面。

(5)单设备操作

选中扫描结果列表中的某一设备(扫描结果列表第一列序号背景显示绿色高亮才是设备被选中了),点击鼠标右键,能对选中的设备进行指派、升级、刷新设备状态以及重启设备的操作。

“指派”:该命令会让话机到“服务器/程序设置”页配置的HTTP服务器去获取配置文件。

“升级”:目前该命令和“指派”一致。

“刷新状态”:该命令会检查话机是否还在线,所有选择的设备都会执行命令。

“Reboot”:该命令让话机重启,此时需要填写CMD的name和password,如下图所示:

3.3.1 扫描DSP信息功能介绍

此功能可以实现DSP版本信息显示。

示例:

       DSP列显示信息对照

 

  • 操作说明

 DSP功能在使用前请先点击Discover Devices进行设备扫描,设备扫描完毕后,再点击DSP ANALYING进行设备DSP信息获取。

用户名和密码如果在该网段下有修改,请填写修改后的,扫描分析程序会在运行后分别使用用户输入用户名和密码,默认用户名密码(admin-admin,user-1234)进行尝试获取。

因为用户名密码错误或者设备不支持原因可能会出现获取失败的情况,扫描后会显示NA,请仔细检查用户名密码是否输入错误。

注意:

每次使用Discover Devices 后,Dsp列都会刷新,需要点击DSP ANALYING重新获取,在获取过程中,按钮样式会变为[DSP ANALYING...] 在获取成功并显示之后会恢复原状。
本功能基于HTTP请求,使用前,请开启话机网页设置Network->Advanced→Web Server →Type 选择要有HTTP项,否则会造成访问失败导致的不能获取DSP信息。

3.4 设备管理

在该页可以简易同步设备状态(ONLINE、ACCOUNT、DND等)以及对设备进行指派、升级、配置文件下载等操作。

3.4.1 前置条件

  1. HPT工具的设备管理功能需要话机版本大于2.42.6.4.43R11(2021-10-30)

  2. 请确保话机配置了DM (Devices Manage) 服务器地址

需要配置的P值代码为P25107,P值为DM服务器地址:端口号,例如P25107=10.3.0.70:8080

可以通过HPT的指派配置功能,批量为要部署的话机设置这一P值

 

3.4.2 DM服务配置与运行

 DM服务需要正确配置并开启。其中Port填写端口号,最终DM服务的地址为宿主IP+Port,如10.2.0.70:8080,点击右侧“Start”开始运行,如下图:

如果DM服务不运行(即未点击“Start”),则DM刷新设备状态的功能以及图中的“Refresh”将不能工作。

成功开启后,DM服务器将显示运行中

 

Refresh(主动刷新):开启此功能后,可以设置话机状态主动刷新时间X分钟,DM将每隔X分钟(如图中为3分钟)对设备状态进行更新,即主动要求话机上报信息。该刷新是对上次数据更新已经超过X分钟的设备进行,若超过3次话机依然没有上报信息,该话机将会变成下线状态,即ONLINE变为“OFF”;

 

更新状态监控:DM以可视化的方式展现数据库中设备的更新,目前设定为每3秒计算一次。左上角的数字表示该图标坐标的上限。该图可以协助检测网络是否存在问题。

3.4.3 导入设备

在使用前,需导入设备信息。

设备信息可以通过csv文件编辑、导入(请注意使用UTF-8编码格式)。

在HPT工具的samples目录,你可以一份名为devices.csv的模板文件

设备信息的csv文件需要包含的信息如下:

  • MAC:必填项且必须唯一,用于存储mac地址,如:001FC1112233;

  • DEV_NAME:必填项,用于存储该设备名称,如:stephen;

  • STATION:必填项,用于存储站点名称,如:南京分公司;

  • SEC_ACC:选填项,用于存储话机网页登录账号;

  • SEC_PW:选填项,用于存储话机网页登录密码;

 

完整的csv文件可以参考下图示例:

 

HPT支持分段多次导入,即如第一次导入“南京分公司.csv”,第二次导入“北京分公司.csv”等。

同时,建议在导入设备信息前填写PIN码,用于对SEC_PW的内容进行加密(AES加密),能在一定程度上保证数据安全。但HPT不会存储该PIN码,只会存储其SHA256值,用以校验后续导入时PIN码是否一致,因此需要用户自行记住PIN码。

在设置PIN码后,点击Import导入编辑好的csv文件

3.4.4 设备信息展示

导入设备信息后,信息会按STATION分组展现,其中All组包含所有设备信息。设备信息包含如下:

MAC:导入设备的MAC地址,不可改变;

DEV_NAME:导入设备的名称,可以通过右键->Edit进行修改;

IP:设备IP地址,当设备联系DM服务时自动填入;

ONLINE:设备是否在线,当设备联系DM服务时自动变成“ON”,设备超过三次没有向DM服务上报状态信息后,此值将变成“OFF”;

ACCOUNT:话机ACCOUNT1的账号,由话机上报并自动填入;

REG:话机ACCOUNT1的注册状态,由话机上报,ACCOUNT1在线时该值填入“ON”,反之为“OFF”;

DND:话机DND状态,由话机上报,话机打开DND时时该值填入“ON”,反之为“OFF”;

FWD:话机forward状态,由话机上报,显示为话机forward的号码;

MODEL:话机型号,由话机上报;

VERSION:话机版本,由话机上报;

在设备列表界面,可以通过按“<”键或“>”键进行上下翻页,也可以直接输入具体页码,按回车键跳转到相应页码,“Total”表示当前列表总记录数。

站点导航与过滤

可以在站点导航界面直接点击站点进行导航,当站点数据过多时,可以在站点导航下方搜索框内输入关键字进行过滤。

3.4.5 站点状态与指派

站点区可以显示当前所选择站点的设备状态(若选择All,则为所有设备的状态)。

绿色为在线且注册上的话机数量(即ONLINE列为“ON”, 且REG列为“True”)。

红色为在线但未注册上的话机数量(即ONLINE列为“ON”, 且REG列为“False”)。

灰色为不在线的话机数量。该状态每分钟更新一次,每次切换站点会即刻更新。 

点击“Provison”按钮,可对所选组所有设备进行批量指派。

 

3.4.6 设备搜索

在搜索区,可以进行设备搜索。搜索按全匹配模式进行,暂不支持模糊搜索。对于“ONLINE”,“DND”等是非选项,输入1/yes/on表示真值,输入0/no/off表示假值,输入为空,表示搜索全部。

 

3.4.7 单设备操作

在设备列表区域,选中某个设备并右键,可弹出操作菜单,如下图(因在线情况不同,有些选项会变灰而无法使用):

 

指派:为话机指派配置,使用此功能需提前开启存有话机配置文件的HTTP服务器(服务器/程序设置页进行设置)。

升级:要求话机升级,使用此功能需提前开启存有话机配置文件的HTTP服务器(服务器/程序设置页进行设置),话机配置文件中的P192值需提前填写好存放了升级固件的服务器路径。

 

刷新:要求设备立即上报信息,刷新设备状态。

下载配置文件:下载bin格式的cfg文件,此功能需要数据库中有账号密码并且设备在线的情况下才可使用,若设备信息导入前输入了PIN码加密,则此时需要输入PIN码。

下载XML配置文件:下载xml格式的cfg文件,此功能需要数据库中有账号密码并且设备在线的情况下才可使用,若设备信息导入前输入了PIN码加密,则此时需要输入PIN码。

下载日志:下载LOG文件,此功能需要数据库中有账号密码并且设备在线的情况下才可使用,若设备信息导入前输入了PIN码加密,则此时需要输入PIN码。日志下载需要一定的时间,当出现以下弹窗提示时,请耐心等待。

 

抓包:网页抓包,当前版本会转至网页进行,需要下图中的Browser填入有效的浏览器执行程序路径(推荐chrome或firefox等)。若设备信息导入前输入了PIN码加密,则输入PIN码可直接通过https访问话机网页,无需填写用户名和密码进行登录认证;若不填写PIN码,则通过http访问话机网页并且需要填写用户名和密码进行登录认证。

重启:重启设备,若设备信息导入前输入了PIN码加密,则此时需要输入PIN码。

编辑:编辑设备信息,支持更改设备名称、话机网页登录账号,话机网页登陆密码以及话机所属站点。更改了设备所属站点后,设备可能显示不在线,在话机再次上报信息后会显示在线。

 

3.4.8 web页面访问

需要在Browser中填入有效的浏览器执行程序路径(推荐chrome或firefox等),按住Ctrl键,点击设备的IP地址,可直接访问话机的网页。若设备信息导入前输入了PIN码加密,则输入PIN码可直接通过https访问话机网页,无需填写用户名和密码进行登录认证;若不填写PIN码,则通过http访问话机网页并且需要填写用户名和密码进行登录认证。

4 服务器/程序设置页

在该页可以开启HTTP服务器,用作配置文件服务器和固件服务器。另可开启PNP服务器,用于话机自动指派。同时,在该页还可以修改HPT显示语言。

 

此页的主要功能如下:

(1)网络

选择一个本局域网中其他设备能够访问到的网络。

(2)HTTP服务器

开启内建HTTP服务器,需要填写合适的端口,然后点击“启动”运行。如果遇到端口不可用,需要修改为可用端口才可正常运行。

若选择外部服务器,需要填写真实有效的配置文件服务器地址(Cfg服务器地址),如“http://192.168.0.198:8080/cfgDir”(末尾不带“/”),同时应确保该路径能访问到。

(3)PNP服务器

启动PNP服务器。对于HTEK话机,“监听”栏中填写“224.0.1.75”,“端口”栏中填写“5060”。

(4)程序设置

在此模块可以设置工具语言(目前版本仅支持中文和英文两种语言),也可以在此模块选择保留的日志文件数量。

 

5 小工具

该页提供了一种加密工具来加密BIN和XML格式的可读Cfg文件。

可以在此页面设置加密密钥、加密文件存储路径、是否覆盖已存在的文件以及观察文件状态等。

 

6 其他

6.1 服务器运行状态

在工具顶部能够试试观测内建HTTP服务器、PNP服务器以及DM服务运行状态。“Stop”表示服务器停止运行,“Running”表示服务器正在运行。

6.2 模板导入与保存

点击“载入模板”加载一个bin格式的配置文件,以使用自定义的配置模板。

当编辑了“可视化编辑”页中内容后,“保存”按钮将可用,若点击该按钮,将会直接修改已加载的配置文件模板。点击“另存为”,会弹出另存为对话框,可以将当前的修改另存,而不会修改已加载的模板。

 

快速使用

步骤1:打开服务器

要完整的使用本工具的所有功能,需要首先配置和开启相关服务器(如果只进行配置文件生成,则不需要进行这一步操作)。

(1)切换页面到“服务器/程序设置”页;

(2)选择正确的网络,即在本局域网中其他设备能访问到网络;

(3)选择并开启HTTP服务器,若选择开启内建HTTP服务器,需填写合适的端口,然后点击“启动”运行。若选择外部服务器,需要填写真实有效的配置文件服务器地址(Cfg服务器地址),如“http://192.168.0.198:8080/cfgDir”(末尾不带“/”)。

(4)启动PNP服务器。对于HTEK话机,“监听”栏中填写“224.0.1.75”,“端口”栏中填写“5060”(若该端口被占用,需要关闭占用该端口的进程,确保端口可用)。

步骤2:选择设备模板

点击所示红框,选择可视化编辑时所用的设备模板。

 

步骤3(可选):使用配置文件模板

选择设备模板后,软件将使用该模板默认配置。点击“载入模板”加载一个bin格式的配置文件,以使用自定义的配置模板。

 

当编辑了“可视化编辑”页中内容后,“保存”按钮将可用,若点击该按钮,将会直接修改已加载的配置文件模板。

点击“另存为”,可以将当前的修改另存,而不会修改已加载的模板。

 

步骤4:可视化编辑

切换页面到“可视化编辑”,在该页进行模板的个性化设置。

右侧即为具体项目的编辑,每一项对应一个P值。编辑的过程中,软件会自动保存修改到内存中,因此可以直接切换目录,但如果需要使修改在下次打开软件时依然有效,则需要按照上一步(步骤3:加载配置文件模板)的操作进行保存。

 

步骤5:配置文件批量生成

切换页面到“批量制作”。

(1)准备好CSV文件,该文件可用文本编辑器或者Excel打开和制作(模板在HPT工具的samples文件夹中);

 

(2)点击“载入CSV文件”载入CSV文件。成功载入的文件内容将显示在页面左侧;

(3)如果需要,可以在此修改CSV文件。可以添加、编辑和保存文件;

(4)选择是否加密生成的文件,如果选择“加密”,将对生成的bin格式配置文件进行加密处理,避免文件泄露被其他人直接读取(默认为不加密);

(5)如果内建HTTP服务器已经启动,并且对话机的配置文件和固件服务器地址没有特别设置,则可以勾选“自动填写服务器地址”自动填写配置文件服务器和固件服务器地址;

(6)点击“批量生成”或“生成到内建服务器”保存生成的配置文件。

 

步骤6:搜索并指派在线设备

切换页面到“设备扫描”。在该页,可以搜索局域网内设备并对其进行指派。

(1)子网模式下选择正确的网络,即在本局域网中能访问到其他设备的网络;

(2)输入MAC地址过滤,“预定义”中为预先配置好的过滤项,也可以选择“自定义”手动输入。

(3)配置好后,点击“查找设备”便可开始搜索。当搜索到想要的内容后,可以点击该按钮结束搜索,或者等待其自行结束。

搜索结果会显示到如上图中,表头可用于设备筛选。

点击左侧的编号栏可以选择设备,再次点击可以取消选择。也可以通过按住左键拖拽实现多选。表格左上角可以全选,再次点击可以取消选择。

点击右键,会弹出功能菜单,支持指派、升级、刷新状态以及Reboot四个功能。

 

步骤7:使用DM服务

切换页面到“设备管理”页面。

  1. 填写可用端口,点击“开启”打开DM服务;

  2. 选择开启“刷新”,并设置话机上报状态信息的间隔时间,单位:分钟;

  3. 导入CSV文件,建议用户导入文件前输入PIN码以增加数据安全性;

  4. 在“浏览器”内填入有效的浏览器执行程序路径,用以访问话机网页、抓包等;

  5. 选中某一话机,鼠标右键,可执行指派、升级、刷新状态、下载bin格式的配置文件、下载xml格式的配置文件、下载话机log、话机网页抓包、话机重启以及话机信息编辑的功能(ONLINE为“OFF”的话机只能执行重启和编辑的功能)。

 

工具目录结构

工具的文件结构如下图所示:

根目录下有“cache”、“DB”、“default”、“ini”、“log”、“models”、“samples”和“server”文件夹。

“cache”文件夹用于存储缓存,不改名和删除。

“DB”文件夹是Devices Mananage页面存储设备信息的数据库,不可改名和删除。

“default”文件夹下有“$json”文件夹和“$cfg.bin”文件。当“models”文件夹为空时,工具会读取该文件夹的内容,不可删除。

“ini”文件夹下有“lang”文件夹和“$default.ini”文件。“lang”文件夹中保存着语言文件。“$default.ini”文件保存工具的默认设置。当使用过工具后,该文件中会有“setting.ini”文件,其中保存着用户设置,删除“setting.ini”文件会使工具恢复默认设置。“lang”文件夹和“$default.ini”文件不可删除。删除“setting.ini”文件会使工具恢复默认设置。

“log”文件夹用于存储日志。

“models”文件夹中保存着不同的设备资料。可以增减该文件夹下的内容来增减设备。请不要随意修改其中文件夹的名字。

“samples”文件夹中目前存有CSV模板。devices.csv文件用于Devices Mananage页面的CSV文件导入,MacModeSample.csv用于批量制作页面的CSV文件导入。

“server”下的“htdocs”文件夹中有“cfg”文件夹(用于存放cfg文件)和“fw”文件夹(存放固件)。内建HTTP服务器需要这些文件夹。

 

疑问与处理

为什么PNP服务器不能启动?

通常这是因为端口被占用。如3CX服务器会独占5060端口,对此您可选择停止3CX的服务,或者使用其他的PC。

“指派”命令让话机重启了,但是话机没有取到配置文件。

造成这种问题的原因很多。比如:(1)检查配置文件的名称是否正确(应该是形如“cfg001fc1112233”格式);(2)检查配置文件服务路径是否正确并能正常访问;(3)检查网络中是否有设备开启了DHCP Option 66功能;(4)检查网络中是否有其他的PNP服务器等。

为什么加载CSV文件后表是空的?

对于一些CSV编辑器,打开的文件会被独占。你需要先关闭编辑器,然后用本软件加载。

为什么无法在WIFI环境中使用“指派”命令指派926E话机?

抱歉,当前版本不支持该功能。我们正在解决这个问题。

 

历史更新

2020-10-27:1.4.0beta

1.新增Devices Manage功能和说明;

2020-10-15:1.3.5beta

1.新增扫描超时调控;

2.新增子网扫描模式;

3.新增点击IP访问话机网页;

4.其他细节调整。

2019-12-05:1.3.4beta

1.新增通过action url重启话机的命令。

2019-11-07:1.3.3beta

1.修改导入的csv文件字段中有空格会导致提示语法错误的问题

2019-07-11:1.3.2beta

1.修改默认配置中mac filter名字

2.修改cfg模板中最后一个配置value值丢失的问题。

2018-09-27: 1.3.1beta

1.添加默认密钥以加密XML文件。

2018-09-13: 1.3beta

1.支持加载和生成XML格式的cfg文件;

2.添加cfg文件加密工具以加密BIN和XML格式的文件;

3.修复有时生成的cfg文件不完整的错误。

2018-01-17: 1.2beta

1.修复使用内置HTTP服务器配置话机失败的错误;

2.修复“发现设备”重置失败的问题;

3.增加日志机制;

4.其他修复和更改。

2017-09-26:1.1beta

1.提供了界面多语言支持;

2.提高了在多网卡下HTTP服务器可用问题。

2017-09-07:1.0beta

1.HPT首次发布版本。