Modify getting started to use IoTA JSON #1646
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fgalan
reviewed
Aug 20, 2024
fgalan
reviewed
Aug 20, 2024
Co-authored-by: Fermín Galán Márquez <fgalan@users.noreply.github.com>
Co-authored-by: Fermín Galán Márquez <fgalan@users.noreply.github.com>
fgalan
requested changes
Aug 21, 2024
doc/getting-started.md
Outdated
| the same regardless of protocol. | ||
|
|
||
| The IoT Agent JSON is a simple IoT Agent which uses JSON payloads to send and receive data. It is a good starting point | ||
| for understanding the how an IoT Agent works since it uses JSON payloads to send and receive data. |
There was a problem hiding this comment.
Suggested change
| for understanding the how an IoT Agent works since it uses JSON payloads to send and receive data. | |
| for understanding how an IoT Agent works since it uses JSON payloads to send and receive data. |
There was a problem hiding this comment.
Fixed here: 3c6e239
doc/getting-started.md
Outdated
doc/getting-started.md
Outdated
| }; | ||
| ``` | ||
|
|
||
| In this case the context broker is called `orion` and is listening on port `1026`, the IoT Agent can be provisioned by | ||
| In this case the context broker hostname is `orion` and is listening on port `1026`, the IoT Agent can be provisioned by | ||
| sending requests to port `4041` which is also the port used to receive NGSI requests. The IoT Agent is holding the | ||
| device mappings in memory. |
There was a problem hiding this comment.
Should be in MongoDB (see my previous comment).
There was a problem hiding this comment.
Fixed here: 3c6e239
| group may override values previously defined in the global configuration if necessary. When using the config group API, | ||
| the `fiware-service` and `fiware-servicepath` headers will define the service and subservice to which the configuration | ||
| will be applied. Additionally, the `apikey` field is used to identify the configuration group. An example of a basic | ||
| config group is shown below: | ||
|
|
||
| ```bash | ||
| curl -iX POST \ |
doc/getting-started.md
Outdated
| @@ -58,20 +78,29 @@ curl -iX POST \ | |||
| "apikey": "4jggokgpepnvsb2uv4s40d59ov", | |||
| "cbHost": "http://orion:1026", | |||
There was a problem hiding this comment.
The cbHost is not commonly used, so I'd suggest not including it in examples.
There was a problem hiding this comment.
Fixed here: 3c6e239
doc/getting-started.md
Outdated
| `urn:ngsi-ld:Motion:001`. The device has a single attribute mapping for a measurement `c` to be renamed to `count`, | ||
| additionally to one defined in the group mapping (`temperature`). The device also has a static attribute `refStore` | ||
| which is a relationship to the entity `urn:ngsi-ld:Store:001`. | ||
|
|
||
| This information is combined with the common config group information whenever a request is received at the South port |
There was a problem hiding this comment.
This is the first mention to the "South" in the document. It may sound weird for people not used to this terminology (and people reading a getting started guide probably are that :)
I'd suggest to explain the "South" and "North" concepts in the "Introduction" section of this document.
There was a problem hiding this comment.
Fixed here: 3c6e239 (no need to include the suggested sections)
doc/getting-started.md
Outdated
Comment on lines
162
to
163
| Mapping has been found to rename the `c` measurement to `count` and the `t` measurement to `temperature`. The following | ||
| context entity is created in the context broker: |
There was a problem hiding this comment.
Try to avoid the rename term here, as suggested in other comments above.
There was a problem hiding this comment.
Fixed here: 3c6e239
doc/getting-started.md
Outdated
| ### Receiving a measure from an anonymous Device | ||
|
|
||
| When receiving a measure, it is not necessary to have the device provisioned. In this case, the IoT Agent will use the | ||
| config group configuration to create the device and the entity. This process is called "autoprovision". |
There was a problem hiding this comment.
Suggested change
| config group configuration to create the device and the entity. This process is called "autoprovision". | |
| config group configuration to create the device and the entity. This process is called "autoprovision" and it is enabled by default in provisioned groups (in order to disable it check [include a reference here]) |
There was a problem hiding this comment.
Added here: 3c6e239
Co-authored-by: Fermín Galán Márquez <fgalan@users.noreply.github.com>
fgalan
reviewed
Aug 23, 2024
Co-authored-by: Fermín Galán Márquez <fgalan@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR modifies getting started document using IoTA JSON and completing the documentation. Commands are pending but probably is not needed in this document
#1645