Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify getting started to use IoTA JSON #1646

Merged
merged 7 commits into from
Aug 23, 2024
Merged

Modify getting started to use IoTA JSON #1646

merged 7 commits into from
Aug 23, 2024

Conversation

mapedraza
Copy link
Collaborator

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

@mapedraza mapedraza mentioned this pull request Aug 16, 2024
25 tasks
doc/getting-started.md Outdated Show resolved Hide resolved
doc/getting-started.md Outdated Show resolved Hide resolved
mapedraza and others added 3 commits August 20, 2024 15:07
Co-authored-by: Fermín Galán Márquez <[email protected]>
Co-authored-by: Fermín Galán Márquez <[email protected]>
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here: 3c6e239

},
deviceRegistry: {
type: "memory",
type: 'memory'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Memory registry is deprecated (#1429) so better to show the configuration to use MongoDB registry.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here: 3c6e239

};
```

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be in MongoDB (see my previous comment).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest to not using /iot/services / "services", but the new URL and field defined in PR #1637 (when it comes)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to merge this to master. Then, sync #1637 and approach it there

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NTC

@@ -58,20 +78,29 @@ curl -iX POST \
"apikey": "4jggokgpepnvsb2uv4s40d59ov",
"cbHost": "http://orion:1026",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cbHost is not commonly used, so I'd suggest not including it in examples.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here: 3c6e239

`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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here: 3c6e239 (no need to include the suggested sections)

doc/getting-started.md Outdated Show resolved Hide resolved
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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try to avoid the rename term here, as suggested in other comments above.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here: 3c6e239

doc/getting-started.md Outdated Show resolved Hide resolved
### 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".
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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])

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added here: 3c6e239

doc/getting-started.md Outdated Show resolved Hide resolved
Co-authored-by: Fermín Galán Márquez <[email protected]>
Copy link
Member

@fgalan fgalan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fgalan fgalan merged commit 7d1b29e into master Aug 23, 2024
7 checks passed
@fgalan fgalan deleted the task/more-doc-rework branch August 23, 2024 07:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants