Skip to content

Commit

Permalink
Smoll wording improvements (#71)
Browse files Browse the repository at this point in the history
  • Loading branch information
xbill82 authored Apr 16, 2021
1 parent 9941b30 commit c7dc7af
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions doc/1/guides/decoders/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ order: 200

# Decoders

Each device model can receive a different payload, it is then necessary to decode this payload in order to retrieve the necessary information and put it in the right place in the document of the associated device.
Since payload formats can differ among device models, it is necessary to decode each payload in order to retrieve the necessary information and store it correctly in the document of the associated device.

![devices payloads collect and decode schema](./devices-payload-collect-and-decode.png)

To do this, it is necessary to implement a decoder by implementing the `Decoder` class.
To do this, you can create a decoder by implementing the `Decoder` class.

This class must at least implement the `decode` method in order to retrieve at the right place the payload data.
This class must at least implement the `decode` method, which contains the logic allowing to process the payload data and format it in a way that suits your business needs.

A decoder is linked to a device model. Its registration triggers the creation of a specific API action to receive payloads from this device model. Each payload will be decoded by the decoder provided.
Each decoder is linked to its corresponding device model. Its registration triggers the creation of a specific API action to receive payloads from this device model. Each payload will be decoded by the decoder provided for its model.

**Example:** _Decoder for the device model "Karakoy"_

Expand Down
2 changes: 1 addition & 1 deletion doc/1/guides/devices/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ A device is uniquely identified by the pair `model` + `reference`.

## Measures

A device can receive several measurements in the same payload.
A device can send several measurements in the same payload.

Each measurement must be stored in the key corresponding to its type: `measures.<measureType>`.

Expand Down

0 comments on commit c7dc7af

Please sign in to comment.