Skip to content

Commit bf5ddb1

Browse files
committed
edited coap api page
1 parent a50d3cc commit bf5ddb1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

_includes/docs/reference/coap-api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
[CoAP](https://en.wikipedia.org/wiki/Constrained_Application_Protocol) is a light-weight IoT protocol for constrained devices. You can find more information about CoAP [here](https://tools.ietf.org/html/rfc7252).
99
CoAP protocol is UDP based, but similar to HTTP it uses request-response model.
10-
CoAP observes [option](https://tools.ietf.org/html/rfc7641) allows to subscribe to resources and receive notifications on resource change.
10+
CoAP Observe [Option](https://tools.ietf.org/html/rfc7641) allows subscription to resources and receiving notifications on resource change.
1111

1212
ThingsBoard server nodes act as a CoAP Server that supports both regular and observe requests.
1313

1414
### Client libraries setup
1515

16-
You can find CoAP client libraries for different programming languages on the web. Examples in this article will be based on [CoAP cli](https://www.npmjs.com/package/coap-cli).
16+
You can find CoAP client libraries for different programming languages on the web. The examples in this article will be based on [CoAP cli](https://www.npmjs.com/package/coap-cli).
1717
In order to setup this tool on Linux or macOS, you can use the following command:
1818

1919
```bash
@@ -33,7 +33,7 @@ CoAP cli does not support query parameters. If you require to use query paramete
3333

3434
### CoAP Authentication and error codes
3535

36-
We will use *access token* device credentials in this article and they will be referred to later as **$ACCESS_TOKEN**.
36+
In this article, we will use *access token* device credentials in this article and they will be referred to later as **$ACCESS_TOKEN**.
3737
The application needs to include **$ACCESS_TOKEN** as a path parameter into each CoAP request.
3838
Possible error codes and their reasons:
3939

@@ -115,16 +115,16 @@ Where **1451649600512** is a [unix timestamp](https://en.wikipedia.org/wiki/Unix
115115
Below are examples of commands for publishing different types of telemetry data.
116116

117117
{% if docsPrefix == null %}
118-
Don't forget replace <code>demo.thingsboard.io</code> with your host and <code>$ACCESS_TOKEN</code> with your device's access token. In this example, hostname reference live demo server.
118+
Don't forget to replace <code>demo.thingsboard.io</code> with your host and <code>$ACCESS_TOKEN</code> with your device's access token. In this example, the hostname references live demo server.
119119
{% endif %}
120120
{% if docsPrefix == "pe/" %}
121-
Don't forget replace <code>$THINGSBOARD_HOST_NAME</code> with your host and <code>$ACCESS_TOKEN</code> with your device's access token. In this example, hostname reference your local installation.
121+
Don't forget to replace <code>$THINGSBOARD_HOST_NAME</code> with your host and <code>$ACCESS_TOKEN</code> with your device's access token. In this example, the hostname references your local installation.
122122
{% endif %}
123123
{% if docsPrefix == "paas/" %}
124-
Don't forget replace <code>$ACCESS_TOKEN</code> with your device's access token.
124+
Don't forget to replace <code>$ACCESS_TOKEN</code> with your device's access token.
125125
{% endif %}
126126
{% if docsPrefix == "edge/" %}
127-
Don't forget replace <code>$THINGSBOARD_EDGE_HOST_NAME</code> with your host and <code>$ACCESS_TOKEN</code> with your device's access token. In this example, hostname reference your local installation.
127+
Don't forget to replace <code>$THINGSBOARD_EDGE_HOST_NAME</code> with your host and <code>$ACCESS_TOKEN</code> with your device's access token. In this example, the hostname references your local installation.
128128
{% endif %}
129129

130130
**Example 1**. Publish data as an object without timestamp (server-side timestamp will be used) using data from [**telemetry-data-as-object.json**](/docs/reference/resources/telemetry-data-as-object.json) file.
@@ -481,7 +481,7 @@ The "`B`" options stands for break (the operation will be break after desired ti
481481

482482
- Save the "[rpc-response.json](/docs/reference/resources/rpc-response.json)" file to your PC;
483483

484-
- In the second terminal window simulate send a response from the device to the server:
484+
- In the second terminal window simulate sending a response from the device to the server:
485485

486486
{% if docsPrefix == null or docsPrefix == "pe/" %}
487487
```shell

0 commit comments

Comments
 (0)