From e51274813e0f94a0f2f483cf52aaeed8165038ec Mon Sep 17 00:00:00 2001 From: Luca Marchesini Date: Thu, 15 Apr 2021 11:10:13 +0200 Subject: [PATCH 1/2] Smoll wording improvements --- doc/1/guides/decoders/index.md | 8 ++++---- doc/1/guides/devices/index.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/1/guides/decoders/index.md b/doc/1/guides/decoders/index.md index 197cf981..646c4b0c 100644 --- a/doc/1/guides/decoders/index.md +++ b/doc/1/guides/decoders/index.md @@ -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 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"_ diff --git a/doc/1/guides/devices/index.md b/doc/1/guides/devices/index.md index 4ca3621b..7f083efe 100644 --- a/doc/1/guides/devices/index.md +++ b/doc/1/guides/devices/index.md @@ -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.`. From 0bbba8be1822e4ad8ca3d546809369b8e505a9b2 Mon Sep 17 00:00:00 2001 From: Luca Marchesini Date: Fri, 16 Apr 2021 09:52:49 +0200 Subject: [PATCH 2/2] Update doc/1/guides/decoders/index.md Co-authored-by: Adrien Maret --- doc/1/guides/decoders/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/1/guides/decoders/index.md b/doc/1/guides/decoders/index.md index 646c4b0c..ed71bc6a 100644 --- a/doc/1/guides/decoders/index.md +++ b/doc/1/guides/decoders/index.md @@ -8,7 +8,7 @@ order: 200 # Decoders -Since payload formats can differ among device models, it is necessary to decode each payload in order to retrieve the necessary information store it correctly 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)