IP-SwitchSDK说明.doc

一、RS485 /RS232 通讯协议IP-Switch 通过RS485/RS232 接口与模拟设备进行通讯，接受RS485/RS232 总线上任何模拟设备向IP-Switch 发出的指令，并根据通讯协议对指令进行解析；或者通过RS485/RS232向模拟设备发出相应的指令应答和通过网络数据解析后的有关指令。1.1 RS485 /RS232 通讯波特率设置Baud Rate： 从1200bps 到 38400bps 。可通过 AVConfig 工具设置Data bit：8Stop Bit：1Parity Bit：None1.2 名词定义1. IP-Switch 在本文中特指网络协议转换器。a) IP-Switch 可用于传统的模拟可视对讲系统中，通过对现有模拟系统的软件进行升级，可以将传统的模拟系统中的模拟音频数据、模拟视频数据、以及RS485/RS232总线数据转变为数字信号，并在遵循标准的TCP/IP 协议的网络内自由传输。b) IP-Switch 主要实现以下两类功能i. 音视频数据的模数互转、MPEG4 编解码及网络收发与回放。ii. RS485/RS232 总线制数据的网络转发。2. 设备ID 设备地址。在本文中设备是指与IP-Switch 相连接的传统模拟可视对讲设备。每台设备在整个系统中拥有一个唯一的设备地址（设备ID）。设备地址被定义为4 字节长，用户可以定义其指定的含义，但00000000 与FFFFFFFF 为系统保留，后者表示群发地址。例如：可以用8 位BCD 码来组成一个唯一的设备地址，其中后5 位表示分机编码，而前3 位则表示该分机对应的门口机编码，不足位数者用F 填充。如：102FF503与102 号门口机相连接的503 号设备；302FFFFF 表示编码为302 的门口机或者管理机；等等3. IP地址 每台 IP-Switch 在整个网络系统中拥有一个唯一的IP 地址，可以使用工具软件AVConfig 为IP-Switch 配置一个静态的IP 地址，并同时设定子网掩码、网关等相关的网络信息。4. 地址表 描述了系统中所有的 IP-Switch（IP 地址）与模拟设备（设备ID）的连接关系。5. AVConfig 通过网络对IP-Switch 进行远程配置的工具软件。1.3 编程说明1. 鉴于 RS485 总线半双工的工作特性，在发送每一条指令之前都必须确保当前RS485 总线为空闲状态。（在模拟机与IP-SWITCH 的通讯方式为RS485 的情况下）2. 发向 RS485/RS232 的的所有指令都必须遵守第6.4 节描述的指令格式，只需要简单地将原有命令加上一个适当的通讯协议头就可以完成该项工作（原有命令被当成是一条转发的指令，做为转发内容经由IP-Switch 被转发到指定的目的地）。3. 根据业务逻辑的需要，填写适当的通讯协议头内容。这其中包括在什么时候并发地对IP-Switch 对行音视频状态的控制。4. 从 RS485/RS232 总线上收到的所有指令都符合第1.4 节描述的指令格式，必须按照该协议对指令进行正确地解析。1.4 RS485/RS232 协议指令格式指令格式序号123456字节数11114DATALEN格式STARTCMDLENGTHFLAGADDRDATA格式注解序号符号含义备注1START起始标志位0xA12CMD指令的类型，IP-SWITCH依据此命令进行操作3LENGTH指令的长度，为8+DATALEN。最大可达2550x08 至0xFF4FLAGADDR 的含义标识0xA5 或0x5A5ADDR目标地址6DATA为数据的长度，最大可达247 字节关于 FLAG 和ADDR 的注解FLAGADDR备注0xA5目标设备的 ID 标识。目标设备是指与 IP-SWITCH 通过RS485/232 通讯的模拟对讲设备，这些设备在系统中拥有唯一的地址码(ID)，由8 位BCD 码来表示。00000000 与FFFFFFFF 为系统保留ID。0x5AIP-SWITCH 的IP 地址。说明 1：无论是在发送指令时，还是在接收指令时，ADDR 始终表示着本次通讯的远端地址。说明 2：当ADDR=0xFFFFFFFF 时，IP-SWITCH 会把该条指令转发到网络中的所有设备中。指令类型 CMD取值功能说明备注0x01 数据转发0x02 启动音频0x03 启动音频+数据转发0x04 停止音频0x05 停止音频+数据转发0x08启动视频接收(解码)0x09启动视频接收(解码)+数据转发0x10停止视频接收(解码)0x11停止视频接收(解码)+数据转发0x20启动视频发送(编码)0x21启动视频发送(编码) +数据转发0x40停止视频发送(编码)0x41停止视频发送(编码)+数据转发0x0A启动音频+启动视频接收(解码)0x0B启动音频+启动视频接收(解码)+数据转发0x14停止音频+停止视频接收(解码)0x15停止音频+停止视频接收(解码) +数据转发0x22启动音频+启动视频发送(编码)0x23启动音频+启动视频发送(编码) +数据转发0x44停止音频+停止视频发送(编码)0x45停止音频+停止视频发送(编码) +数据转发注 1：通讯波特率可以为以下值：1200,2400,4800,9600,19200,38400。(单位bps)。注 2：其它通讯参数可以通过AV-CONFIG 进行配置更改。1.5 通讯过程示例以管理机（地址：F00FFFFF，IP-Switch地址：192.168.0.80）与主机（FFFFF456，IP-Switch地址：192.168.0.81）的一次通讯握手为例。Step 1 管理机向主机发出连接请求，同时启动视频接收与音频收发。假定连接请求的指令为 4 字节0xF1F2F3F4。CMD： 0x0BLENGTH： 0x0CFLAG： 0xA5ADDR： 4-7 字节填写目标方的设备ID，即FFFFF456。123456789101112A10B0CA5FFFFF456F1F2F3F4Step 2 主机收到该请求，收到的指令格式应为：123456789101112A10B0C5AC0A80050F1F2F3F4FLAG 的值为0x5A。ADDR 的值表示的是指令发出方（即管理机）的IP 地址（0xC0A80050 = 192.168.0.80）。根据 F1F2F3F4 进行处理。Step 3 主机对该指令进行解析，并做出应答，同时启动视频发送与音频收发。假定应答的指令为 4 字节0xF6F7F8F9。由于已知目标方的 IP 地址，FLAG 取值0x5A。CMD 取值为0x23。123456789101112A1230C5AC0A80050F6F7F8F9Step 4 管理机收到该应答，收到的指令格式应为：123456789101112A1230C5AC0A80051F6F7F8F9FLAG 的值为0x5A。4-7 字节表示的是指令发出方（即主机）的IP 地址（0xC0A80051 = 192.168.0.81）。根据 F6F7F8F9 进行处理。二、地址表地址表描述了 IP-SWITCH 与模拟设备的连接关系。每个IP-SWITCH有一个IP地址和一组挂在它下面的模拟设备地址。例如：IP地址为：192.168.0.81 (在通信数据中以4字节表示为 0xC0 0xA8 0x00 0x51)模拟设备地址（4字节）为：0x001FF001 0x001FFFFF，其中001（前一个半字节）表示IP-SWITCH的设备号，后两个半字节为对应的模拟设备地址简要型地址表：仅录入与IP-SWITCH 直接相连接的设备IP-SWITCH IP地址模拟设备的 ID编码设备种类192.168.0.81001FFFFFD门口机/围墙机192.168.0.82002FFFFFD门口机/围墙机192.168.0.83911FFFFFD门口机/围墙机192.168.0.84999FFFFFMC明细型地址表：录入与IP-SWITCH 直接连接、间接连接的所有设备IP-SWITCH IP地址模拟设备的 ID编码设备种类192.168.0.81001FFFFFD(门口机/围墙机)001FF001R(户内分机)001FF002R(户内分机)001FF003R(户内分机)001FF004R(户内分机)192.168.0.82002FFFFFD(门口机/围墙机)002FF001R(户内分机)002FF002R(户内分机)002FF003R(户内分机)002FF004R(户内分机)192.168.0.83911FFFFFD(门口机/围墙机)192.168.0.84999FFFFFMC(管理中心机)地址表是在通讯时将目标设备的 ID 编码转换为与该设备对应的IP-SWITCH 的IP 地址的依据。因此，具体采用哪一种类型的地址表，需根据用户原模拟系统的业务逻辑及通讯协议而确定。三、AVConfig（配置程序）启动 IP-SWITCH。查看IP-SWITCH 的状态指示灯，以确保IP-SWITCH 处于工作状态。网络指示灯接入网络时点亮，未接入网络时闪烁视频编码指示灯编码时点亮，平时熄灭视频解码指示灯解码时点亮，平时熄灭音频指示灯编解码时点亮，平时熄灭串口收发数据指示灯接收或者发送一帧数据时闪烁AVConfig 的功能1. 设置指定 IP-SWITCH 的IP 地址。2. 查看指定设备的配置参数。3. 调节配置参数，可以即时更新到单一设备或全体设备。4. 地址表的编辑、更新。5. 查看指定 IP-SWITCH 的I地址表。AVConfig 的界面（注：界面可能会有局部的改动，具体问题可联系相关工程师咨询）图一：主界面 搜索说明：IP-SWITCH 的出厂IP 缺省为192.168.68.100。确保PC 机的IP 地址处于同一网段中。搜索：可搜索网络中全部在线的设备。(设备的IP 必须与PC 同一网段才可以搜索到)。更改网络地址：更改列表中选中的设备的IP 地址、子网掩码、网关和网卡地址。查看配置表：可以获得列表中选中的设备的配置参数。查看地址表：可以获得列表中选中的设备的地址表。图二 更改网络地址说明：请注意 IP 地址的规则。确定：确认所做的修改。取消：取消所做的修改。图三 查看配置表说明：超时值是为了避免在通信中由于偶然因素出现的不可靠导致音视频始终处于编解码状态而设置的，用户可将其设置为略大于模拟对讲的最长通话时间即可。单一配置：仅对指定的设备进行参数的更新。批量配置：对网络中的全部设备进行参数的更新。图四 查看地址表说明：查看指定设备的地址表。图五 地址表配置说明：左侧列表中显示了当前的地址表。可以通过右键菜单进行编辑(删除、增加、修改等)。保存为默认值：编辑好的地址表可以保存到电脑中备用； 导入地址表：从电脑保存的文件中导入地址表；导出地址表：将当前地址表保存到电脑上；批量更新：对网络中的所有设备全部的地址表进行更新。地址表也可以手工来编辑。导出的地址表的格式为INI 格式，以下是一个示例：192.168.0.10COUNT=21=F00000012=F0000003192.168.0.11COUNT=51=B00000012=B00000023=B00000034=B00000045=B0000005192.168.0.12COUNT=31=BF0000022=BF0000033=BF000004四、PC 端网络控制协议通讯远程 PC 端向IP-SWITCH发送网络指令，从而对IP-SWITCH进行远程控制。为方便编程，其通讯协议与485 通讯协议基本上保持一致。4.1 指令的基本格式序号123456字节数11114DATALEN格式STARTCMDLENGTHFLAGADDRDATA4.2 格式注解序号符号含义备注1START起始标志位0xA12CMD指令的类型，IP-SWITCH依据此命令进行操作3LENGTH指令的长度，为8+DATALEN。最大可达2550x08 至0xFF4FLAGADDR 的含义标识0xA5 或0x5A5ADDR目标地址6DATA为数据的长度，最大可达247 字节DATALEN 为数据的长度，最大可达247 字节4.3 关于 FLAG 和ADDR 的注解FLAGADDR备注0xA5目标设备的 ID 标识。目标设备是指与 IP-SWITCH 通过RS485/232 通讯的模拟对讲设备，这些设备在系统中拥有唯一的地址码(ID)，由8 位BCD 码来表示。00000000 与FFFFFFFF 为系统保留ID。0x5AIP-SWITCH 的IP 地址。说明 1：无论是在发送指令时，还是在接收指令时，ADDR 始终表示着本次通讯的远端地址。说明 2：当ADDR=0xFFFFFFFF 时，IP-SWITCH 会把该条指令转发到网络中的所有设备中。4.4 指令类型 CMD取值功能说明备注0x01 数据转发0x02 启动音频0x03 启动音频+数据转发0x04 停止音频0x05 停止音频+数据转发0x08启动视频接收(解码)0x09启动视频接收(解码)+数据转发0x10停止视频接收(解码)0x11停止视频接收(解码)+数据转发0x20启动视频发送(编码)0x21启动视频发送(编码) +数据转发0x40停止视频发送(编码)0x41停止视频发送(编码)+数据转发0x0A启动音频+启动视频接收(解码)0x0B启动音频+启动视频接收(解码)+数据转发0x14停止音频+停止视频接收(解码)0x15停止音频+停止视频接收(解码) +数据转发0x22启动音频+启动视频发送(编码)0x23启动音频+启动视频发送(编码) +数据转发0x44停止音频+停止视频发送(编码)0x45停止音频+停止视频发送(编码) +数据转发0x89请求监视 网络命令0x91 停止监视网络命令4.5 其他说明1. IP-SWITCH 在端口25001 处进行网络控制命令的监听。2. 通讯采用UDP 的方式，最大数据包为255Bytes。五、中心PC端SDK调用说明5.1 文件说明：1、 AVSwitch.dll，主库文件，封装了音视频编解码、视频显示。2、 Olivecore.dll，视频解码库文件（用户无须调用）。3、 OliveSwitch.h，调用头文件。5.2 调用说明AVSwitch.dll 封装类(接口函数说明)1 初始化库int InitDll(void)输入参数: 无返回值: 1成功，-1失败，-2UDP端口25003无法打开，-3UDP端口25002无法打开 UDP25003: 音频端口 UDP25002：视频端口函数功能: 初始化库2 释放库int UnInitDll(void)输入参数: 无返回值: 1成功，-1失败函数功能: 释放库3开始捕获音频和编码发送int Talk_BeginAudioCaptureAndSend(char *DestIP)输入参数: DestIP目标转换器IP地址（例如：“192.168.0。81”）返回值: 1函数调用成功，-1函数调用失败函数功能: 开始捕获音频和编码发送4停止捕获音频和编码发送int *Talk_EndAudi