本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
Modbus-RTU 通訊協定轉接器
Modbus-RTU 通訊協定轉接器元件 (aws.greengrass.Modbus
) 會從本機 Modbus RTU 裝置輪詢資訊。
若要向具有此元件的本機 Modbus RTU 裝置請求資訊,請將訊息發佈至此元件訂閱的主題。在訊息中,指定要傳送至裝置的 Modbus RTU 請求。然後,此元件會發佈包含 Modbus RTU 請求結果的回應。
注意
此元件提供與 Modbus RTU 通訊協定轉接器連接器 in AWS IoT Greengrass V1 類似的功能。如需詳細資訊,請參閱《AWS IoT Greengrass V1 開發人員指南》中的 Modbus RTU 通訊協定轉接器連接器。
版本
此元件具有下列版本:
-
2.1.x
-
2.0.x
Type
此元件是 Lambda 元件 (aws.greengrass.lambda
)。Greengrass 核會使用 Lambda 啟動器元件執行此元件的 Lambda 函數。
如需詳細資訊,請參閱元件類型。
作業系統
此元件只能在 Linux 核心裝置上安裝。
要求
此元件有下列需求:
-
您的核心裝置必須符合執行 Lambda 函數的要求。如果您希望核心裝置執行容器化 Lambda 函數,則裝置必須符合執行此作業的要求。如需詳細資訊,請參閱Lambda 函數需求。
-
安裝在核心裝置上並新增至 PATH 環境變數的 Python
3.7 版。 -
AWS IoT Greengrass 核心裝置與 Modbus 裝置之間的實體連線。核心裝置必須透過序列連接埠實際連接至 Modbus RTU 網路,例如 USB 連接埠。
-
若要從此元件接收輸出資料,您必須在部署此元件時合併舊版訂閱路由器元件 (
aws.greengrass.LegacySubscriptionRouter
) 的下列組態更新。此組態會指定此元件發佈回應的主題。如需詳細資訊,請參閱建立部署。
-
支援 Modbus-RTU 通訊協定轉接器在 VPC 中執行。
相依性
當您部署元件時, AWS IoT Greengrass 也會部署其相依性的相容版本。這表示您必須符合元件及其所有相依性的要求,才能成功部署元件。本節列出此元件發行版本的相依性,以及為每個相依性定義元件版本的語意版本限制。您也可以在 AWS IoT Greengrass 主控台
如需元件相依性的詳細資訊,請參閱元件配方參考。
組態
此元件提供下列組態參數,您可以在部署元件時自訂這些參數。
注意
此元件的預設組態包含 Lambda 函數參數。建議您只編輯下列參數,以在裝置上設定此元件。
輸入資料
此元件接受下列主題的 Modbus RTU 請求參數,並將 Modbus RTU 請求傳送至裝置。根據預設,此元件會訂閱本機發佈/訂閱訊息。如需如何從自訂元件發佈訊息至此元件的詳細資訊,請參閱 發佈/訂閱本機訊息。
預設主題 (本機發佈/訂閱): modbus/adapter/request
訊息接受下列屬性。輸入訊息必須是 JSON 格式。
request
-
要傳送之 Modbus RTU 請求的參數。
請求訊息的形狀取決於其代表的 Modbus RTU 請求類型。所有請求都需要下列屬性。
類型:
object
包含下列資訊:operation
-
要執行的操作名稱。例如,指定
ReadCoilsRequest
讀取 Modbus RTU 裝置上的線圈。如需支援操作的詳細資訊,請參閱 Modbus RTU 請求和回應。類型:
string
device
-
請求的目標裝置。
此值必須是介於
0
和 之間的整數247
。類型:
integer
要包含在請求中的其他參數取決於操作。此元件會處理循環備援檢查 (CRC)
,以驗證資料請求。 注意
如果您請求包含
address
屬性,則必須將其值指定為整數。例如"address": 1
。 id
-
請求的任意 ID。使用此屬性將輸入請求映射至輸出回應。當您指定此屬性時,元件會將回應物件中的
id
屬性設定為此值。類型:
string
範例輸入:讀取線圈請求
{ "request": { "operation": "ReadCoilsRequest", "device": 1, "address": 1, "count": 1 }, "id": "MyRequest" }
輸出資料
此元件預設會將回應發佈為下列 MQTT 主題的輸出資料。您必須在舊版訂閱路由器元件的組態subject
中,將此主題指定為 。如需如何在自訂元件中訂閱此主題訊息的詳細資訊,請參閱 發佈/訂閱 AWS IoT Core MQTT 訊息。
預設主題 (AWS IoT Core MQTT): modbus/adapter/response
回應訊息的形狀取決於請求操作和回應狀態。如需範例,請參閱 範例請求和回應。
每個回應含有以下屬性:
response
-
Modbus RTU 裝置的回應。
類型:
object
包含下列資訊:status
-
請求的狀態。狀態可以是下列其中一個值:
operation
-
元件請求的操作。
device
-
元件傳送請求的裝置。
payload
-
Modbus RTU 裝置的回應。如果
status
是No Response
,此物件只會包含描述錯誤 (例如[Input/Output] No Response received from the remote unit
) 的error
屬性。
id
-
請求的 ID,您可以用來識別哪些回應對應到哪個請求。
注意
寫入操作的回應只是請求的回響。雖然寫入回應不包含有意義的資訊,但最好檢查回應的狀態,以查看請求是否成功。
範例輸出:成功
{ "response" : { "status" : "success", "device": 1, "operation": "ReadCoilsRequest", "payload": { "function_code": 1, "bits": [1] } }, "id" : "MyRequest" }
範例輸出:失敗
{ "response" : { "status" : "fail", "error_message": "Internal Error", "error": "Exception", "device": 1, "operation": "ReadCoilsRequest", "payload": { "function_code": 129, "exception_code": 2 } }, "id" : "MyRequest" }
如需更多範例,請參閱範例請求和回應。
Modbus RTU 請求和回應
此連接器接受 Modbus RTU 請求參數做為輸入資料,並發佈回應做為輸出資料。
以下是支援的常見操作。
請求中的作業名稱 | 回應中的函數代碼 |
---|---|
ReadCoilsRequest | 01 |
ReadDiscreteInputsRequest | 02 |
ReadHoldingRegistersRequest | 03 |
ReadInputRegistersRequest | 04 |
WriteSingleCoilRequest | 05 |
WriteSingleRegisterRequest | 06 |
WriteMultipleCoilsRequest | 15 |
WriteMultipleRegistersRequest | 16 |
MaskWriteRegisterRequest | 22 |
ReadWriteMultipleRegistersRequest | 23 |
以下是受支援操作的範例請求和回應。
- 讀取線圈
-
請求範例:
{ "request": { "operation": "ReadCoilsRequest", "device": 1, "address": 1, "count": 1 }, "id": "TestRequest" }
回應範例:
{ "response": { "status": "success", "device": 1, "operation": "ReadCoilsRequest", "payload": { "function_code": 1, "bits": [1] } }, "id" : "TestRequest" }
- 讀取離散輸入
-
請求範例:
{ "request": { "operation": "ReadDiscreteInputsRequest", "device": 1, "address": 1, "count": 1 }, "id": "TestRequest" }
回應範例:
{ "response": { "status": "success", "device": 1, "operation": "ReadDiscreteInputsRequest", "payload": { "function_code": 2, "bits": [1] } }, "id" : "TestRequest" }
- 讀取保留註冊
-
請求範例:
{ "request": { "operation": "ReadHoldingRegistersRequest", "device": 1, "address": 1, "count": 1 }, "id": "TestRequest" }
回應範例:
{ "response": { "status": "success", "device": 1, "operation": "ReadHoldingRegistersRequest", "payload": { "function_code": 3, "registers": [20,30] } }, "id" : "TestRequest" }
- 讀取輸入登錄
-
請求範例:
{ "request": { "operation": "ReadInputRegistersRequest", "device": 1, "address": 1, "count": 1 }, "id": "TestRequest" }
- 寫入單一線圈
-
請求範例:
{ "request": { "operation": "WriteSingleCoilRequest", "device": 1, "address": 1, "value": 1 }, "id": "TestRequest" }
回應範例:
{ "response": { "status": "success", "device": 1, "operation": "WriteSingleCoilRequest", "payload": { "function_code": 5, "address": 1, "value": true } }, "id" : "TestRequest" }
- 寫入單一登錄
-
請求範例:
{ "request": { "operation": "WriteSingleRegisterRequest", "device": 1, "address": 1, "value": 1 }, "id": "TestRequest" }
- 寫入多個線圈
-
請求範例:
{ "request": { "operation": "WriteMultipleCoilsRequest", "device": 1, "address": 1, "values": [1,0,0,1] }, "id": "TestRequest" }
回應範例:
{ "response": { "status": "success", "device": 1, "operation": "WriteMultipleCoilsRequest", "payload": { "function_code": 15, "address": 1, "count": 4 } }, "id" : "TestRequest" }
- 寫入多個登錄
-
請求範例:
{ "request": { "operation": "WriteMultipleRegistersRequest", "device": 1, "address": 1, "values": [20,30,10] }, "id": "TestRequest" }
回應範例:
{ "response": { "status": "success", "device": 1, "operation": "WriteMultipleRegistersRequest", "payload": { "function_code": 23, "address": 1, "count": 3 } }, "id" : "TestRequest" }
- 遮罩寫入註冊
-
請求範例:
{ "request": { "operation": "MaskWriteRegisterRequest", "device": 1, "address": 1, "and_mask": 175, "or_mask": 1 }, "id": "TestRequest" }
回應範例:
{ "response": { "status": "success", "device": 1, "operation": "MaskWriteRegisterRequest", "payload": { "function_code": 22, "and_mask": 0, "or_mask": 8 } }, "id" : "TestRequest" }
- 讀取寫入多個登錄
-
請求範例:
{ "request": { "operation": "ReadWriteMultipleRegistersRequest", "device": 1, "read_address": 1, "read_count": 2, "write_address": 3, "write_registers": [20,30,40] }, "id": "TestRequest" }
回應範例:
{ "response": { "status": "success", "device": 1, "operation": "ReadWriteMultipleRegistersRequest", "payload": { "function_code": 23, "registers": [10,20,10,20] } }, "id" : "TestRequest" }
注意
回應包含元件讀取的註冊。
當請求格式有效但請求未順利完成時會發生例外。在此情況下,回應包含下列資訊:
-
status
設定為Exception
。 -
function_code
等於請求的函數碼 + 128。 -
exception_code
包含例外碼。如需詳細資訊,請參閱 Modbus 例外碼。
範例:
{ "response": { "status": "fail", "error_message": "Internal Error", "error": "Exception", "device": 1, "operation": "ReadCoilsRequest", "payload": { "function_code": 129, "exception_code": 2 } }, "id": "TestRequest" }
此連接器會在 Modbus 請求上執行驗證檢查。例如,它檢查是否格式無效和遺漏欄位。如果驗證失敗,連接器不會傳送請求。而是傳回包含以下資訊的回應:
-
status
設定為No Response
。 -
error
包含錯誤原因。 -
error_message
包含錯誤訊息。
範例:
{ "response": { "status": "fail", "error_message": "Invalid address field. Expected <type 'int'>, got <type 'str'>", "error": "No Response", "device": 1, "operation": "ReadCoilsRequest", "payload": { "error": "Invalid address field. Expected Expected <type 'int'>, got <type 'str'>" } }, "id": "TestRequest" }
如果請求的目標是不存在的裝置,或 Modbus RTU 網路沒有作用,您可能會收到 ModbusIOException
(使用「沒有回應」格式)。
{ "response": { "status": "fail", "error_message": "[Input/Output] No Response received from the remote unit", "error": "No Response", "device": 1, "operation": "ReadCoilsRequest", "payload": { "error": "[Input/Output] No Response received from the remote unit" } }, "id": "TestRequest" }
本機日誌檔案
此元件使用以下日誌檔案。
/logs/aws.greengrass.Modbus.log
/greengrass/v2
檢視此元件的日誌
-
在核心裝置上執行下列命令,以即時檢視此元件的日誌檔案。
將 取代為 AWS IoT Greengrass 根資料夾的路徑。/greengrass/v2
sudo tail -f
/logs/aws.greengrass.Modbus.log/greengrass/v2
授權
此元件包含下列第三方軟體/授權:
此元件根據 Greengrass 核心軟體授權合約
變更記錄
下表說明每個版本元件的變更。
版本 |
變更 |
---|---|
2.1.11 |
針對 Greengrass nucleus 2.15.0 版更新版本。 |
2.1.10 |
針對 Greengrass nucleus 2.14.0 版更新版本。 |
2.1.9 |
針對 Greengrass nucleus 2.13.0 版更新版本。 |
2.1.8 |
針對 Greengrass nucleus 2.12.0 版更新版本。 |
2.1.7 |
針對 Greengrass nucleus 2.11.0 版更新版本。 |
2.1.6 |
針對 Greengrass nucleus 2.10.0 版更新版本。 |
2.1.5 |
|
2.1.4 |
針對 Greengrass nucleus 2.9.0 版更新版本。 |
2.1.3 |
針對 Greengrass nucleus 2.8.0 版更新版本。 |
2.1.2 |
針對 Greengrass nucleus 2.7.0 版更新版本。 |
2.1.1 |
針對 Greengrass nucleus 2.6.0 版更新版本。 |
2.1.0 |
|
2.0.8 |
針對 Greengrass nucleus 2.5.0 版更新版本。 |
2.0.7 |
針對 Greengrass nucleus 2.4.0 版更新版本。 |
2.0.6 |
針對 Greengrass nucleus 2.3.0 版更新版本。 |
2.0.5 |
針對 Greengrass nucleus 2.2.0 版更新版本。 |
2.0.4 |
針對 Greengrass nucleus 2.1.0 版更新版本。 |
2.0.3 |
初始版本。 |