開發(fā)一款支持主機(jī)模式的FreeModbus協(xié)議棧

簡介

這是 armink 大神移植的 Freemodbus 協(xié)議棧。同時(shí)支持主機(jī)和從機(jī)的功能。

FreeModbus 是一款開源的 Modbus 協(xié)議棧，但是只有從機(jī)開源，主機(jī)源碼是需要收費(fèi)的。同時(shí)網(wǎng)上也沒有發(fā)現(xiàn)比較好的開源的 Modbus 主機(jī)協(xié)議棧，所以才開發(fā)這款支持主機(jī)模式的 FreeModbus 協(xié)議棧。本版 FreeModbus版本號更改為V1.6，特性如下：

新增加的主機(jī)源碼與原有從機(jī)的風(fēng)格及接口保持一致；
支持主機(jī)與從機(jī)在同一協(xié)議棧運(yùn)行；
支持實(shí)時(shí)操作系統(tǒng)及裸機(jī)移植；
為應(yīng)用提供多種請求模式，用戶可以選擇阻塞還是非阻塞模式，自定義超時(shí)時(shí)間等，方便應(yīng)用層靈活調(diào)用；
支持所有常用的Modbus方法。

文件結(jié)構(gòu)

注：所有帶_m后綴的文件為主機(jī)模式下必須使用的文件，如使用從機(jī)模式則無需這些文件。

許可證

Freemodbus 軟件包遵循 BSD 許可，詳見 LICENSE 文件。

依賴

RT_Thread UART 設(shè)備

獲取方式

使用 Freemodbus 軟件包需要在 RT-Thread 的包管理器中選擇它，具體路徑如下：

最后讓 RT-Thread 的包管理器自動(dòng)更新，或者使用 pkgs --update 命令更新包到 BSP 中。

使用方法

數(shù)據(jù)緩沖區(qū)

數(shù)據(jù)緩沖區(qū)定義的位置位于 FreeModbus\port\user_mb_app_m.c 文件頂部，共計(jì) 4種數(shù)據(jù)類型。 FreeModbus從機(jī)默認(rèn)使用 一維數(shù)組 作為緩存區(qū)數(shù)據(jù)結(jié)構(gòu)，主機(jī)可以存儲所有網(wǎng)內(nèi)從機(jī)的數(shù)據(jù)，所以主機(jī)采用 二維數(shù)組 對所有從機(jī)節(jié)點(diǎn)數(shù)據(jù)進(jìn)行存儲。二維數(shù)組的列號代表寄存器、線圈及離散量地址，行號代表從機(jī)節(jié)點(diǎn)ID，但需要做減一處理，例如usMRegHoldBuf[2][1]代表從機(jī)ID為 3，保持寄存器地址為 1 的從機(jī)數(shù)據(jù)。

Modbus 數(shù)據(jù)處理回調(diào)接口

Modbus 一共有4種不同的數(shù)據(jù)類型，所有的 Modbus 功能都圍繞這些數(shù)據(jù)類型進(jìn)行操作。由于不同的用戶數(shù)據(jù)緩沖區(qū)結(jié)構(gòu)可能有所不同，那么對應(yīng)的 Modbus 數(shù)據(jù)處理方式也就存在差異，所以用戶需要把每種數(shù)據(jù)類型對應(yīng)的操作，按照自己的數(shù)據(jù)緩沖區(qū)結(jié)構(gòu)進(jìn)行定制實(shí)現(xiàn)。所有的 Modbus 數(shù)據(jù)處理回調(diào)接口如下：

對于數(shù)組形式的數(shù)據(jù)緩沖區(qū)結(jié)構(gòu)，源碼中已經(jīng)做好了移植，直接使用即可。

初始化配置流程

本協(xié)議棧所有配置參數(shù)都位于FreeModbus\modbus\include\mbconfig.h，目前協(xié)議棧支持主機(jī)及從機(jī)兩種模式，并且支持兩種模式同時(shí)開啟。從機(jī)支持Modbus RTU 、Modbus ASCII 及Modbus TCP 3種模式，主機(jī)現(xiàn)在只支持常用的Modbus RTU模式。在使用主機(jī)的過程中，用戶需要對廣播的轉(zhuǎn)換延時(shí)時(shí)間、命令響應(yīng)超時(shí)時(shí)間及從機(jī)數(shù)量做以配置。需要注意的是，目前協(xié)議棧只支持從機(jī)地址連續(xù)，并且起始地址從1開始。

正常使用流程

調(diào)用eMBMasterInit方法初始化Modbus主機(jī)協(xié)議棧，主機(jī)涉及到的一些硬件就在這個(gè)時(shí)候做了初始化
調(diào)用eMBMasterEnable方法啟動(dòng)Modbus主機(jī)
通過在線程或者定時(shí)器輪詢調(diào)用eMBMasterPoll方法，輪詢周期決定了命令的響應(yīng)時(shí)間。
調(diào)用主機(jī)請求API方法，設(shè)定一定的請求超時(shí)時(shí)間，直到方法有結(jié)果后才會返回。如果方法執(zhí)行成功并且命令是讀命令，可以通過查看Modbus主機(jī)的數(shù)據(jù)緩沖區(qū)，獲取最新從機(jī)數(shù)據(jù)。

具體的使用方法，可以參考 /samples 目錄下的示例代碼。調(diào)試 Modbus 的主從機(jī)程序可以在 PC 上使用 Modbus Poll 和 Modbus slave 軟件配合調(diào)試。

異常處理流程

異常處理主要出現(xiàn)在主機(jī)正常使用過程中，所有的主機(jī)請求API的錯(cuò)誤碼都在第三章開頭已經(jīng)做以描述，針對的這些錯(cuò)誤碼，用戶需要根據(jù)自己的產(chǎn)品特征去完成不同的動(dòng)作。建議用戶自己封裝實(shí)現(xiàn)主機(jī)請求方法的重發(fā)機(jī)制，這樣實(shí)現(xiàn)方式比較靈活，一般是在接收到幀數(shù)據(jù)出錯(cuò)及命令響應(yīng)超時(shí)的錯(cuò)誤碼時(shí)需要重發(fā)，重發(fā)次數(shù)自動(dòng)加一，如果重發(fā)次數(shù)超過設(shè)定值則認(rèn)為從機(jī)掉線，以后所有只要是發(fā)給這個(gè)從機(jī)命令都被提前攔截掉；如果第二次重發(fā)命令響應(yīng)成功，則自動(dòng)清零該從機(jī)重發(fā)次數(shù)。上述所有功能可以利用主機(jī)請求方法或者使用FreeModbus\port\portevent_m.c中的回調(diào)接口來實(shí)現(xiàn)，用戶可以根據(jù)自己的需求靈活選擇。

API 詳解

Modbus 主機(jī)使用過程中與從機(jī)有很大不同，從機(jī)是需要被動(dòng)等待主機(jī)請求，而主機(jī)則是主動(dòng)發(fā)出請求，并接收處理從機(jī)響應(yīng)。在主機(jī)發(fā)送廣播請求的時(shí)候，從機(jī)不需要返回響應(yīng)，所以廣播請求適合主機(jī)的寫從機(jī)數(shù)據(jù)命令，不適合讀從機(jī)數(shù)據(jù)命令。主機(jī)請求API中的所有方法的返回值格式都相同，返回值意義如下。

所有的主機(jī)請求方法都是 線程安全 的也是 阻塞模式 的。在使用過程中，只要在設(shè)定的超時(shí)時(shí)間內(nèi)沒有得到主機(jī)資源，就會返回主機(jī)忙；如果在設(shè)定的超時(shí)時(shí)間內(nèi)得到主機(jī)資源，那么必須等待得到請求結(jié)果后才會返回。