本页目录

• Directory structure
• General configuration file
  • Sections in config file
  • Connection to ThingsBoard
    • Subsection “statistics”
    • Subsection “checkingDeviceActivity”
    • Subsection “security”
  • Storage configuration
  • Connectors configuration

Directory structure

Please see default directory structure below for daemon installation.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/etc/thingsboard-gateway/config                   - Configuration folder.
    tb_gateway.yaml                               - Main configuration file for Gateway.
    logs.conf                                     - Configuration file for logging.
    modbus.json                                   - Modbus connector configuration.
    mqtt.json                                     - MQTT connector configuration.
    ble.json                                      - BLE connector configuration.
    opcua.json                                    - OPC-UA connector configuration.
    request.json                                  - Request connector configuration.
    can.json                                      - CAN connector configuration. 
    ... 

/var/lib/thingsboard_gateway/extensions           - Folder for custom connectors/converters.                      
    modbus                                        - Folder for Modbus custom connectors/converters.
    mqtt                                          - Folder for MQTT custom connectors/converters.
        __init__.py                               - Default python package file, needed for correct imports.
        custom_uplink_mqtt_converter.py           - Custom Mqtt converter example.
    ...
    opcua                                         - Folder for OPC-UA custom connectors/converters.
    ble                                           - Folder for BLE custom connectors/converters.
    request                                       - Folder for Request custom connectors/converters.
    can                                           - Folder for CAN custom connectors/converters.

/var/log/thingsboard-gateway                      - Logs folder
    connector.log                                 - Connector logs.
    service.log                                   - Main gateway service logs.
    storage.log                                   - Storage logs.
    tb_connection.log                             - Logs for connection to the ThingsBoard instance.

General configuration file

The main configuration file that is used for connection to ThingsBoard platform instance and enable/disable connectors. This configuration points to ThingsBoard instance thingsboard.cloud and uses memory file storage configured to store maximum of 100,000 records. There are 4 different connectors active. If you like to use only one of them - just remove all other connectors.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
thingsboard:

  host: thingsboard.cloud

  port: 1883

  remoteShell: false

  remoteConfiguration: false

  statistics:

    enable: true

    statsSendPeriodInSeconds: 3600

  minPackSendDelayMS: 0

  checkConnectorsConfigurationInSeconds: 60

  handleDeviceRenaming: true

  checkingDeviceActivity:

    checkDeviceInactivity: false

    inactivityTimeoutSeconds: 120

    inactivityCheckPeriodSeconds: 10

  security:

    accessToken: PUT_YOUR_ACCESS_TOKEN_HERE

  qos: 1

storage:

  type: memory

  read_records_count: 100

  max_records_count: 100000

grpc:

  enabled: false

  serverPort: 9595

  keepaliveTimeMs: 10000

  keepaliveTimeoutMs: 5000

  keepalivePermitWithoutCalls: true

  maxPingsWithoutData: 0

  minTimeBetweenPingsMs: 10000

  minPingIntervalWithoutDataMs: 5000

connectors:

  -

    name: MQTT Broker Connector

    type: mqtt

    configuration: mqtt.json


  -

    name: Modbus Connector

    type: modbus

    configuration: modbus.json


  -

    name: Modbus Connector

    type: modbus

    configuration: modbus_serial.json


  -

    name: OPC-UA Connector

    type: opcua

    configuration: opcua.json


  -

    name: BLE Connector

    type: ble

    configuration: ble.json


  -

    name: CAN Connector

    type: can

    configuration: can.json


  -

    name: Custom Serial Connector

    type: serial

    configuration: custom_serial.json

    class: CustomSerialConnector

Sections in config file

• thingsboard – Configuration for connecting to ThingsBoard platform.
  • security – Configuration for type of encryption and authorization.
• storage – Configuration for local storage of incoming data from devices.
• connectors – Array of Connectors and their configuration to use.

Connection to ThingsBoard

Subsection “statistics”

This subsection uses to configure collecting statistics data and sending them to ThingsBoard Gateway device attributes.

You can define additional parameter “configuration” and provide your own command for collecting some additional data. This configuration file can look like the example below:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
[
  {
    "timeout": 100,
    "command": ["/bin/sh", "-c", "ps -A -o cpu,%mem | awk '{cpu += $1}END{print cpu}'"],
    "attributeOnGateway": "CPU"
  },
  {
    "timeout": 100,
    "command": ["/bin/sh", "-c", "ps -A -o %cpu,%mem | awk '{mem += $2}END{print mem}'"],
    "attributeOnGateway": "Memory"
  },
  {
    "timeout": 100,
    "command": ["/bin/sh", "-c", "ipconfig getifaddr en0"],
    "attributeOnGateway": "IP address"
  },
  {
    "timeout": 100,
    "command": ["/bin/sh", "-c", "sw_vers -productName"],
    "attributeOnGateway": "OS"
  },
  {
    "timeout": 100,
    "command": ["/bin/sh", "-c", "uptime"],
    "attributeOnGateway": "Uptime"
  },
  {
    "timeout": 100,
    "command": ["/bin/sh", "-c", "system_profiler SPUSBDataType"],
    "attributeOnGateway": "USBs"
  }
]

Subsection “checkingDeviceActivity”

This subsection is optional and used to monitor the activity of each connected device.

If you define this section, the Gateway will check the activity of each device every n second that means, if the device is inactive for n seconds, it will disconnect it.

Subsection “security”

There are 3 variants of security subsection:

1
2
3
4
...
  security:
    accessToken: PUT_YOUR_GW_ACCESS_TOKEN_HERE
...

1
2
3
4
  security:
    clientId: YOUR_CLIENT_ID
    username: YOUR_USERNAME
    password: YOUR_PASSWORD

1
2
3
  security:
    accessToken: PUT_YOUR_GW_ACCESS_TOKEN_HERE
    caCert: /etc/thingsboard-gateway/mqttserver.pub.pem

1
2
3
4
5
6
  security:
    privateKey: /etc/thingsboard-gateway/privateKey.pem
    caCert: /etc/thingsboard-gateway/ca.pem
    cert: /etc/thingsboard-gateway/certificate.pem
    checkCertPeriod: 86400
    certificateDaysLeft: 3

Storage configuration

Configs in storage subsection provides configuration for saving incoming data before it will be send to ThingsBoard platform.

There are 2 variants for this section: memory or file.

1. Memory storage - Received data saving to the RAM memory.
2. File storage - Received data saving to the hard drive.
3. SQLite storage - Received data saving to the .db file.

1
2
3
4
storage:
  type: memory
  read_records_count: 10
  max_records_count: 1000

1
2
3
4
5
6
storage
  type: file
  data_folder_path: ./data/
  max_file_count: 5
  max_read_records_count: 6
  max_records_per_file: 14

1
2
3
4
5
storage
  type: sqlite
  data_file_path: ./data/data.db
  messages_ttl_check_in_hours: 1
  messages_ttl_in_days: 7

Connectors configuration

Configs in connectors section configuration for connecting to devices by implemented protocols. Config for every connector in this section must have parameters as in table below:

* – Folder with this configuration file.

Section connectors in your configuration file may differ from shown below, but they should have structure like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
connectors:

  -
    name: MQTT Broker Connector
    type: mqtt
    configuration: mqtt.json

  -
    name: Modbus Connector
    type: modbus
    configuration: modbus.json

  -
    name: Modbus Connector
    type: modbus
    configuration: modbus_serial.json

  -
    name: OPC-UA Connector
    type: opcua
    configuration: opcua.json

  -
    name: BLE Connector
    type: ble
    configuration: ble.json

  -
    name: CAN Connector
    type: can
    configuration: can.json

  -
    name: Custom Serial Connector
    type: serial
    configuration: custom_serial.json
    class: CustomSerialConnector

Note: You can use several similar connectors at same time, but you should provide different names and configuration files to them.

If you need different type of connector, you can implement it using customization guide or email us: info@thingsboard.io.