Thingsboardgatewaypython版本的安裝、配置和使用說明

1、TB-Gateway 版本安裝及使用說明python 版本從源代碼安裝ThingsBoard Gateway ，遵循以下步驟：Windows 上安裝 python3 ，然后配置環(huán)境變量：從 Github 下載存儲庫：git clone HYPERLINK /thingsboard/thingsboard-gateway.git /thingsboard/thingsboard-gateway.git移至下載目錄：cd thingsboard-gateway使用 setup.py 腳本安裝python 模塊：python3 setup.py install5. 創(chuàng)建“日志”文件夾：mkdir l

2、ogs配置網(wǎng)關(guān)使其與ThingsBoard 平臺實例一起使用，接下來會介紹配置文件。運行網(wǎng)關(guān)，檢查安裝結(jié)果： python3 ./thingsboard_gateway/tb_gateway.py配置文件的目錄 /etc/thingsboard-gateway/config-網(wǎng)關(guān)主配置文件- 日志配置文件MODBUS 配置文檔MQTT 配置文檔BLE 配置文檔OPC-UA 配置文檔tb_gateway.yamllogs.confmodbus.jsonmqtt.jsonble.jsonopcua.json主配置文件結(jié)構(gòu)用于連接到ThingsBoard 平臺實例和啟用/禁用連接器的主要配置文件。此

3、配置指向ThingsBoard 實例 demo.thingsboard.io 并使用配置為最多存儲100,000 條記錄的內(nèi)存文件存儲。有4 個不同的活動連接器。如果您只想使用其中之一- 只需移除所有其他連接器即可。thingsboard:host: demo.thingsboard.io/ mqtt brokeIP 地址port: 1883/ mqtt broker端口號security:accessToken: PUT_YOUR_ACCESS_TOKEN_HERE / tb 平臺一個網(wǎng)關(guān)設(shè)備的tokenstorage:type: memoryread_records_count: 100m

4、ax_records_count: 100000connectors:-name: MQTT Broker Connectortype: mqttconfiguration: mqtt.json-name: Modbus Connectortype: modbusconfiguration: modbus.jsonname: OPC-UA Connectortype: opcuaconfiguration: opcua.json-name: BLE Connectortype: bleconfiguration: ble.jsonMQTT 連接器配置連接器配置：mqtt.json連接器配置是一

5、個JSON 文件，其中包含有關(guān)如何連接到外部MQTT 代理，訂閱數(shù)據(jù)饋送時使用哪些主題以及如何處理數(shù)據(jù)的信息。讓我們使用以下示例來查看配置文件的格式。MQTT 連接器配置文件示例。下面列出的示例將連接到IP 00 服務(wù)器上部署的本地網(wǎng)絡(luò)中的MQTT 代理。連接器將使用用戶名和密碼使用基本的MQTT 身份驗證。然后，連接器將使用“映射”部分中的主題過濾器訂閱主題列表。在下面的說明中查看更多信息。broker: name:Default Local Broker,host:00,port:1883,security: type: basic,username: user,password: pas

6、sword,mapping: topicFilter: /sensor/data,converter: type: json,deviceNameJsonExpression: $serialNumber,deviceTypeJsonExpression: $sensorType,timeout: 60000,attributes: type: string,key: model,value: $sensorModel,timeseries: type: double,key: temperature,value: $temp,type: double,key: humidity,value:

7、 $hum,topicFilter: /sensor/+/data,converter: type: json,deviceNameTopicExpression: (?=sensor/)(.*?)(?=/data),deviceTypeTopicExpression: Thermometer,timeout: 60000,attributes: type: string,key: model,value: $sensorModel,timeseries: type: double,key: temperature,value: $temp,type: double,key: humidity

8、,value: $hum,topicFilter: /custom/sensors/+,converter: type: custom,extension: CustomMqttUplinkConverter, extension-config: temperatureBytes : 2,humidityBytes :2,batteryLevelBytes : 1,connectRequests: topicFilter: sensor/connect,deviceNameJsonExpression: $SerialNumber,topicFilter: sensor/+/connect,d

9、eviceNameTopicExpression: (?=sensor/)(.*?)(?=/connect) , disconnectRequests: topicFilter: sensor/disconnect,deviceNameJsonExpression: $SerialNumber,topicFilter: sensor/+/disconnect,deviceNameTopicExpression: (?=sensor/)(.*?)(?=/disconnect) ,attributeUpdates: deviceNameFilter: SmartMeter.*,attributeF

10、ilter: uploadFrequency,topicExpression: sensor/$deviceName/$attributeKey,valueExpression: $attributeKey:$attributeValue ,serverSideRpc: deviceNameFilter: .*,methodFilter: echo,requestTopicExpression:sensor/$deviceName/request/$methodName/$requestId, responseTopicExpression:sensor/$deviceName/respons

11、e/$methodName/$requestId,responseTimeout: 10000,valueExpression: $params,deviceNameFilter: .*,methodFilter: no-reply,requestTopicExpression:sensor/$deviceName/request/$methodName/$requestId, valueExpression: $paramsBroker 部分參數(shù)默認值描述nameDefault Broker自定義名稱hostlocalhostMqtt broker 域名或IP.port1883Mqtt po

12、rt 端口號.安全部分，一般選擇Basic 模式參數(shù)默認值描述typebasic授權(quán)類型.usernameusername用戶名.passwordpassword密碼 .“映射”部分主題還支持特殊的符號如“# ”+ ”,這樣可以訂閱更多的主題參數(shù)默認值描述主題過濾/sensor/data網(wǎng)關(guān)訂閱的主題推送的數(shù)據(jù)結(jié)構(gòu)例子名稱主題主題過濾器數(shù)據(jù)包備注“ serialNumber ”: “ SN-001 ” ,Example 1/sensor/data/sensor/data“ sensorType ” : “ sensorModel ” :Thermometer ” ,“ T1000 ” , “

13、temp ” :設(shè)備名稱作為數(shù)據(jù) 包的一部分42, “ hum ” : 58Example 2/sensor/SN-001/data/sensor/+/data “ sensorType ” : “ sensorModel ” : 42, “ hum ” : 58“ Thermometer ” ,“ T1000 ” , “ temp ” :設(shè)備名稱作為主題 一部分數(shù)據(jù)轉(zhuǎn)化器參數(shù)默認值描述typejson提供給轉(zhuǎn)換器的數(shù)據(jù)格式deviceNameJsonExpression$serialNumber從 json 數(shù)據(jù)包中提取key 為 serialNumber 的值，作為設(shè)備名稱deviceTy

14、peJsonExpression$sensorType從 json 數(shù)據(jù)包中提取key 為 sensorType 的值，作為設(shè)備類型timeout60000“設(shè)備斷開連接”事件超時時間attributes設(shè)備屬性 typestring屬性數(shù)據(jù)類型 keymodel屬性名稱 value$sensorModel從 json 數(shù)據(jù)包中提取key 為 sensorModel 的值，作為屬性值timeseries時序數(shù)據(jù) typedouble時序數(shù)據(jù)的數(shù)據(jù)類型 keytemperature時序數(shù)據(jù)的key value$temp從 json 數(shù)據(jù)包中提取key 為 temp 的值，作為時序值服務(wù)端發(fā)送rp

15、c 到設(shè)備端參數(shù)默認值描述設(shè)備名稱過濾表達式.*方法名過濾器echo請求主題表達式sensor/$deviceName/request/$methodName/$requestId響應(yīng)主題表達式sensor/$deviceName/response/$methodName/$requestIdresponseTimeout10000valueExpression$params正則表達式，用于標識設(shè)備名稱正則表達式方法名篩選器，用于確定要執(zhí)行的函數(shù)。JSON-PATH 表達式，用于創(chuàng)建主題用以發(fā)送RPC 請求。JSON-PATH 表達式，用于創(chuàng)建主題用以訂閱響應(yīng)消息。響應(yīng)延時時間（以毫秒為單位）

16、，如果發(fā)送請求后在此期間內(nèi)沒有響應(yīng)， 則網(wǎng)關(guān)將從響應(yīng)主題中取消訂閱。JSON-PATH 表達式，用于創(chuàng)建發(fā)送到代理的數(shù)據(jù)。您可以使用deviceNameFilter 和 methodFilter 為不同的設(shè)備/方法應(yīng)用不同的映射規(guī)則。一旦網(wǎng)關(guān)從服務(wù)器接收到設(shè)備的RPC 請求，它將基于requestTopicExpression 和valueExpression 發(fā)布相應(yīng)的消息。如果希望設(shè)備回復(fù)請求，還應(yīng)指定responseTopicExpression 和 responseTimeout 。網(wǎng)關(guān)將訂閱“響應(yīng)”主題并等待設(shè)備回復(fù)，直到檢測到“響應(yīng)超時”（以毫秒為單位）。例如：需要從服務(wù)器發(fā)送的R

17、PC 請求（ RPC request.json ）示例：method: echo ,params: message: Hello!MODBUS 連接器配置本指南將幫助您熟悉用于ThingsBoard 物聯(lián)網(wǎng)網(wǎng)關(guān)的Modbus 連接器配置。使用常規(guī)配置啟用此連接器。我們將在下面描述連接器配置文件。Modbus Connector config fileserver: name: Modbus Default Server ,type: tcp ,host: ,port: 5020 ,timeout: 35,method: rtu , devices: unitId: 1,deviceName:

18、Temp Sensor , attributesPollPeriod:5000 ,timeseriesPollPeriod:5000 ,sendDataOnlyOnChange:true,attributes: byteOrder: BIG , tag: test , type: long , functionCode: 4, registerCount: 1 , address: 0 , timeseries: byteOrder: BIG , tag: test , type: long , functionCode: 4, registerCount: 1 , address: 0 ,

19、rpc: turnLightOn: address: 4, bit: 2, value: true , turnLightOff: address: 4, bit: 2, value: false,getCPULoad: tag: Integer , value: 42 , functionCode: 16 , address: 0, unitId: 1, byteOrder: BIG , registerCount: 1Server 部分說明TCP/UDP 協(xié)議參數(shù)默認值描述nameModbus Default Server連接器名稱typetcp連接類型，可以是：tcp , udp or

20、serial .hostModbus server的 IPport5020Modbus server的端口號參數(shù)默認值描述timeout35連接到Modbus 服務(wù)器超時（秒）時間methodsocket連接形式socket or rtu參數(shù)默認值描述nameModbus Default Server連接器名稱typeserial連接類型，可以是：tcp , udp orport/dev/ttyUSB0設(shè)備串口名稱timeout35連接到Modbus 服務(wù)器超時（秒）時間methodrtu數(shù)據(jù)單元類型rtu or asciiserial設(shè)備參數(shù)此配置部分提供設(shè)備連接和數(shù)據(jù)處理的配置。參數(shù)默認值

21、描述unitId1Modbus 當前設(shè)備的IddeviceNameTemp Sensor設(shè)備名稱參數(shù)默認值描述attributesPollPeriod5000檢查設(shè)備上屬性的時間（毫秒）timeseriesPollPeriod5000檢查設(shè)備上的遙測的時間（毫秒）。sendDataOnlyOnChangetrue僅在上次檢查數(shù)據(jù)更改時發(fā)送設(shè)備屬性本小節(jié)中的配置提供了在Modbus 服務(wù)器上處理數(shù)據(jù)的設(shè)置，這些設(shè)置將在ThingsBoard平臺實例中解釋為設(shè)備的屬性參數(shù)默認值描述byteOrderBIG要讀取的字節(jié)順序tagtestTb 平臺設(shè)備的標簽域typelong屬性數(shù)據(jù)類型(long , integer , string , double , bit )functionCode4Modbus 的功能碼registerCount1要讀取的寄存器計數(shù)address0寄存器起始地址。設(shè)備時序本小節(jié)中的配置提供了在Modbus 服務(wù)器上處理數(shù)據(jù)的設(shè)置，該設(shè)置將在ThingsBoard 平臺實例中解釋為設(shè)備遙測。參數(shù)默認值描述byteOrderBIG要讀取的字節(jié)順