Skip to content

Commit b3086ab

Browse files
samson0vsamson0v
committed
Corrected grammar for SNMP connector
1 parent d072245 commit b3086ab

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

‎docs/iot-gateway/config/snmp.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ description: SNMP monitoring support for ThingsBoard IoT Gateway
1010

1111
This guide will help you to get familiar with SNMP Connector configuration for ThingsBoard IoT Gateway.
1212
Use [general configuration guide](/docs/iot-gateway/configuration/) to enable this Connector.
13-
The purpose of this Connector is to get data from SNMP managers objects and write some data there.
13+
The purpose of this Connector is to get data from SNMP manager objects and write some data to them.
1414

15-
This connector is useful when you have SNMP manager in your network and you would like to push this data to the ThingsBoard.
15+
This connector is useful when you have SNMP manager in your network and you would like to push the data to the ThingsBoard.
1616

1717
We will describe connector configuration file below.
1818

1919
## Connector configuration: snmp.json
2020

2121
Connector configuration is a JSON file that contains information about SNMP managers and how to process the data.
22-
Let's review the format of the configuration file using example below.
22+
Let's review the format of the configuration file using the example below.
2323

2424
<b>Example of SNMP Connector config file.</b>
2525

2626
Example listed below will connect to a manager on **snmp.live.gambitcommunications.com**.
27-
Then, connector will try to read the data from objects using configuration from attributes, telemetry section. See more info in a description below.
27+
Then, connector will try to read the data from objects using configuration from attributes, and telemetry section. See more info in a description below.
2828

2929
{% capture snmpConf %}
3030
{
@@ -187,19 +187,18 @@ Main configuration for the device item should contain the following parameters:
187187

188188
#### Attributes section
189189

190-
This configuration section contains array of objects with configuration for data processing, objects configured there will be processed as device attributes.
191-
By default, the gateway uses uplink converter which sends received data from SNMP manager to the ThingsBoard, but it is possible to provide custom converter.
190+
This configuration section contains an array of objects with configuration for data processing. Objects configured here will be processed as device attributes.
191+
By default, the gateway uses an uplink converter to send received data from SNMP manager to ThingsBoard, but it is also possible to use a custom converter.
192192

193-
**Note**: Some configuration parameters in configuration objects depend on used method. You can read more about specific configuration parameters for methods [here](#supported-methods-and-their-configuration)
193+
**Note**: Some configuration parameters in the configuration objects depend on the method being used. You can read more about specific configuration parameters for methods [here](#supported-methods-and-their-configuration)
194194

195195
General configuration parameters are:
196196

197-
| **Parameter** | **Default value** | **Description** |
198-
|:-|:-|-
199-
200-
| key | **ReceivedFromGet** | Attribute key in device on ThingsBoard. |
201-
| method | **get** | Method for data processing. Supported methods are [here](#supported-methods-and-their-configuration). |
202-
| oid | **1.3.6.1.2.1.1.1.0** | Manager object identifier. |
197+
| **Parameter** | **Default value** | **Description** |
198+
|:-|:-------------------------------|-
199+
| key | **ReceivedFromGet** | Attribute key in device on ThingsBoard. |
200+
| method | **get** | Method for data processing. Supported methods are [here](#supported-methods-and-their-configuration). |
201+
| oid | **1.3.6.1.2.1.1.1.0** | Manager object identifier. |
203202
|---
204203

205204
Configuration section item example:
@@ -214,19 +213,18 @@ Configuration section item example:
214213

215214
#### Telemetry section
216215

217-
This configuration section contains array of objects with configuration for data processing, objects configured there will be processed as device telemetry.
218-
By default, the gateway uses uplink converter which sends received data from SNMP manager to the ThingsBoard, but it is possible to provide custom converter.
216+
This configuration section contains an array of objects with configuration for data processing. Objects configured here will be processed as device telemetry.
217+
By default, the gateway uses an uplink converter to send received data from SNMP manager to ThingsBoard, but it is also possible to use a custom converter.
219218

220219
**Note**: Some configuration parameters in configuration objects depend on used method. You can read more about specific configuration parameters for methods [here](#supported-methods-and-their-configuration)
221220

222221
General configuration parameters are:
223222

224-
| **Parameter** | **Default value** | **Description** |
225-
|:-|:-|-
226-
227-
| key | **ReceivedFromTable** | Telemetry key in device on ThingsBoard. |
228-
| method | **table** | Method for data processing. Supported methods are [here](#supported-methods-and-their-configuration). |
229-
| oid | **1.3.6.1.2.1.1** | Manager object identifier. |
223+
| **Parameter** | **Default value** | **Description** |
224+
|:-|:------------------------------|---------------------------------------------------------------------------------------------------------
225+
| key | **ReceivedFromTable** | Telemetry key in device on ThingsBoard. |
226+
| method | **table** | Method for data processing. Supported methods are [here](#supported-methods-and-their-configuration). |
227+
| oid | **1.3.6.1.2.1.1** | Manager object identifier. |
230228
|---
231229

232230
Configuration section item example:
@@ -242,8 +240,8 @@ Configuration section item example:
242240

243241
#### Attribute update requests section
244242

245-
Configuration in this section are optional.
246-
ThingsBoard allows to provision device attributes and fetch some of them from the device application.
243+
Configurations in this section are optional.
244+
ThingsBoard allows the provision of device attributes and fetches some of them from the device application.
247245
You can treat this as a remote configuration for devices. Your devices are able to request shared attributes from ThingsBoard.
248246
See [user guide](/docs/user-guide/attributes/) for more details.
249247

@@ -282,16 +280,16 @@ The **attributeUpdates** section will look like:
282280
#### Server side RPC section
283281

284282

285-
ThingsBoard allows sending [RPC commands](/docs/user-guide/rpc/) to the device that is connected to ThingsBoard directly or via Gateway.
283+
ThingsBoard allows sending [RPC commands](/docs/user-guide/rpc/) to the device connected to ThingsBoard directly or via Gateway.
286284

287-
Configuration, provided in this section uses for sending RPC requests from ThingsBoard to device through the gateway.
285+
Configuration, provided in this section is used for sending RPC requests from ThingsBoard to the device through the gateway.
288286

289287
{% capture rpc_variants %}
290288
**There are 2 types of the RPC calls:**
291-
1. With reply, after sending request the gateway will wait for response and send it to ThingsBoard.
292-
2. With no reply, after sending request the gateway will not wait for response.
289+
1. With reply, after sending request the gateway will wait for a response and send it to ThingsBoard.
290+
2. With no reply, after sending request the gateway will not wait for a response.
293291

294-
Examples for both methods provided below.
292+
Examples for both methods are provided below.
295293

296294
{% endcapture %}
297295
{% include templates/info-banner.md content=rpc_variants %}
@@ -493,7 +491,7 @@ Supported methods are:
493491
```
494492

495493
- **multiset**
496-
This method is used to write data into multiply object by their's identifiers.
494+
This method is used to write data into multiple objects by their identifiers.
497495

498496
Specific configuration parameters:
499497
**mapping** - Contains pair of **object identifier** and **value**.

0 commit comments

Comments
 (0)