Modbus协议栈应用实例之四：ModbusTCP服务器应用

自从开源了我们自己开发的Modbus协议栈之后，有很多朋友建议我针对性的做几个示例。所以我们就基于平时我们的应用整理了几个简单但可以说明基本的应用方法的示例，这一篇中我们来简述如何使用协议栈实现一个Modbus TCP服务器应用。

1、何为TCP服务器

Modbus协议是一个主从协议，那肯定就有主站和从站之分，在Modbus TCP中亦称之为客户端与服务器。所谓TCP客户端其功能基本与RTU主站一样，RTU主站会向从站发起数据请求，同样的TCP客户端也会向服务器发起请求。也就是说在Modbus TCP模式下客户端亦是发起通讯的一方。

对于TCP客户端来说，自己并不会产生数据，它的数据均是从服务器获取，为了得到数据就必须向服务器发起数据请求。在Modbus TCP协议中，服务器一般也不会主动向外发送数据，服务器需要根据客户端的数据请求来决定是否发送数据、发送哪些数据。这一过程如下图所示：

从上图我们不难看出，首先客户端要主动发起数据请求，客户端发起的数据请求需要告诉服务器它请求的数据有哪些。服务器收到这个数据请求后，服务器解析客户端的请求并按照客户端的请求返回数据。客户端收到数据响应后解析数据，这样就完成了客户端与服务器之间的一次数据通讯。

需要注意的是，Modbus TCP与Modbus RTU不同的是有一个专用的MBAP报文头来识别Modbus应用数据单元。这一报文头由7个字节组成：

这种MBAP报文头虽然也是用来识别Modbus数据域，但还是与串行链路上使用的MODBUS RTU应用数据单元有一些差别，具体如下：

（1）、用MBAP报文头中的单个字节单元标识符取代MODBUS串行链路上通常使用的MODBUS从地址域。这个单元标识符用于设备的通信，这些设备使用单个 IP 地址支持多个独立MODBUS 终端单元，例如：网桥、路由器和网关。

（2）、使用接收者可以验证的方式来构造所有MODBUS请求和响应。对于MODBUS PDU有固定长度的功能码来说，仅功能码就足够了。对于在请求或响应中携带一个可变数据的功能码来说，数据域包括字节数。

（3）、使用TCP上传送MODBUS数据域时，即使将报文分成多个信息包来传输，可在MBAP报文头上携带附加长度信息，这样接收者就能够识别报文的完整性。

2、如何实现TCP服务器

我们已经简单的描述了基于TCP/IP的Modbus数据通讯，在此基础上我们将进一步描述基于协议栈的Modbus TCP服务器的实现。

在协议栈中，我们已经实现了Modbus TCP服务器的基本功能，如数据的管理及响应客户端的请求等。Modbus TCP服务器作为数据的生产者，管理者四类数据：线圈量、状态量、输入寄存器和保持寄存器。所以在Modbus TCP服务器中我们要为这四种数据定义相应的地址，以便客户端能够对应的访问。所以设计一个Modbus TCP服务器我们先来设计它的数据地址。在我们的例子中，出于操作方便，我们规定了每类数据类型的数量为10，我们以用的最多的保持寄存器为例，定义寄存器地址为40001到40010。

在我们的协议栈中实现了0x01、0x02、0x03、0x04、0x05、0x06、0x0F以及0x10等功能码。也就是说客户端对象会生成面向这些功能码的Modbus TCP服务器数据请求。Modbus TCP服务器收到请求后，解析请求并根据请求生成响应的数据响应。可以表示为下图所示：

从上图我们明白协议栈中已经实现了对收到的主站数据请求进行解析以及根据解析生成对应的响应的函数。我们使用协议栈时，主要需要做两个方面的事情：解析数据请求和生成数据响应。

在协议栈中定义了一个解析函数，该函数将收到的数据请求消息解析，并根据解析的结果生成返回的数据响应。该函数的原型如下：

/*解析接收到的信息，返回响应命令的长度*/

uint16_t ParsingClientAccessCommand(uint8_t *receivedMessage,uint8_t *respondBytes)

这个函数有2个参数：uint8_t *receivedMessage是收到的数据请求消息； uint8_t *respondBytes是返回的数据响应消息，也是函数需要生成的；而函数的返回值则是生成的数据响应详细的长度。

在解析的过程中，该函数判断消息的完整性，并根据不同的功能码调用不同的回调函数来实现，包括设置本地数据和获取本地数据的相关回调函数，在后续将讨论它们的实现。

3、TCP服务器编码

到这里其实我们已经很清楚，使用协议栈实现Modbus TCP服务器只需要在TCP/IP收到客户端请求后调用sendLen = ParsingClientAccessCommand(buffer, sendBuf);函数解析收到的请求命令。并根据请求执行相应的操作就可以了。那需要实现哪些操作呢？在协议栈中定义了8个回调函数，分别是获取线圈量、获取状态量、获取输入寄存器和获取保持寄存器，以及预置单个线圈量、预置多个线圈量、预置单个保持寄存器和预置多个保持寄存器。函数原型定义如下：

/*获取想要读取的Coil量的值*/
__weak void GetCoilStatus(uint16_t startAddress,uint16_t quantity,bool *statusList)
{//如果需要Modbus TCP Server/RTU Slave应用中实现具体内容
}/*获取想要读取的InputStatus量的值*/
__weak void GetInputStatus(uint16_t startAddress,uint16_t quantity,bool *statusValue)
{//如果需要Modbus TCP Server/RTU Slave应用中实现具体内容
}/*获取想要读取的保持寄存器的值*/
__weak void GetHoldingRegister(uint16_t startAddress,uint16_t quantity,uint16_t *registerValue)
{//如果需要Modbus TCP Server/RTU Slave应用中实现具体内容
}/*获取想要读取的输入寄存器的值*/
__weak void GetInputRegister(uint16_t startAddress,uint16_t quantity,uint16_t *registerValue)
{//如果需要Modbus TCP Server/RTU Slave应用中实现具体内容
}/*设置单个线圈的值*/
__weak void SetSingleCoil(uint16_t coilAddress,bool coilValue)
{//如果需要Modbus TCP Server/RTU Slave应用中实现具体内容
}/*设置单个寄存器的值*/
__weak void SetSingleRegister(uint16_t registerAddress,uint16_t registerValue)
{//如果需要Modbus TCP Server/RTU Slave应用中实现具体内容
}/*设置多个线圈的值*/
__weak void SetMultipleCoil(uint16_t startAddress,uint16_t quantity,bool *statusValue)
{//如果需要Modbus TCP Server/RTU Slave应用中实现具体内容
}/*设置多个寄存器的值*/
__weak void SetMultipleRegister(uint16_t startAddress,uint16_t quantity,uint16_t *registerValue)
{//如果需要Modbus TCP Server/RTU Slave应用中实现具体内容
}

这些函数就是我们要根据我们的Modbus TCP服务器功能设计实现的。对于我们这个测试例子我们只需要实现读取保持寄存器就可以了。具体实现如下：

/*获取想要读取的保持寄存器的值*/
void GetHoldingRegister(uint16_t startAddress, uint16_t quantity, uint16_t* registerValue)
{uint16_t start;uint16_t count;/*先判断地址是否处于合法范围*/start = (startAddress > 0) ? ((startAddress <= 9) ? startAddress : 9) : 0;count = ((start + quantity - 1) <= 9) ? quantity : (9 - start);for (int i = 0; i < count; i++){registerValue[i] = holdingRegister[start + i];}
}

这个例子中我们实现了读取40001到40010保持寄存器的值。

4、TCP服务器小结

我们在TCP服务器的基础上使用我们的协议栈实现一个Modbus TCP服务器应用。其实使用协议栈实现Modbus TCP服务器应用是很简单的，我们需要使用如ModPoll这样的软件来测试一下它。

我们读取10个保持寄存器，值分别为对应位固定的1到10，如上图读出的结果与预期一致。我们还可以采用TCP&UDP测试工具来看一下报文，具体如下：

同样的，在同一台设备上只需实现一个Modbus TCP服务器，哪怕是通过不同的网络端口来访问。这一点与客户端是不一样的，原因是Modbus TCP服务器的数据是自己产生，而且只需被动响应客户端的数据请求。

接下来我们来总结一下使用协议栈实现Modbus TCP服务器的工作流程，或者说实现的步骤。首先Modbus TCP服务器要解析从客户端送来的数据请求。在协议栈中已经封装了数据请求的解析函数、所以我们实现Modbus TCP服务器时首先就是调用这一函数来解析接收到的数据请求消息。

然后将解析函数返回的数据响应消息发送到客户端就可以了。也就是说使用协议栈，只需要调用一下这个函数Modbus TCP服务器功能就实现了。这是因为这个函数实现了整个Modbus TCP服务器的响应过程，大致分三个步骤：第一步，解析收到的客户端数据请求消息；第二步，根据解析的结果预置数据或者获取数据，预置和获取数据由8个回调函数实现；第三步，生成Modbus TCP服务器数据响应消息。说到这里我们已经清楚，Modbus TCP服务器必须实现这些回调函数，其它工作则全由协议栈完成。