Skip to content

Commit

Permalink
Update dependencies - switch to WSL
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-fox committed Jun 4, 2024
1 parent 698d6d3 commit 5af9fbc
Show file tree
Hide file tree
Showing 7 changed files with 112 additions and 114 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ directly or programmatically.
<br/>

> [!NOTE]
>
> **Should I use NGSI-v2 or NGSI-LD?**
>
> FIWARE offers two flavours of the NGSI interfaces:
Expand All @@ -37,8 +38,6 @@ directly or programmatically.
>
> More information about NGSI-LD can be found [here](https://ngsi-ld-tutorials.readthedocs.io)


<h3>Data models</h3>

The following NGSI-v2 and NGSI-LD Data models are used within the tutorials:
Expand Down Expand Up @@ -108,6 +107,12 @@ the concept of a project object model (POM), Maven can manage a project's build,
central piece of information. Maven can be used to define and download our dependencies and to build and package Java or
Scala code into a JAR file.

### Windows Subsystem for Linux

We will start up our services using a simple bash script. Windows users should download the
[Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) to provide a command-line
functionality similar to a Linux distribution on Windows.

## Tutorials List [<img src="https://img.shields.io/badge/NGSI-v2-5dc0cf.svg" width="90" align="left" />]("https://fiware-ges.github.io/orion/api/v2/stable/)

### Core Context Management: NGSI-v2 Fundamentals
Expand Down
23 changes: 13 additions & 10 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,17 +207,20 @@ creating two new entities (stores in **Berlin**). Any entity must have a `id` an
attributes are optional and will depend on the system being described. Each additional attribute should also have a
defined `type` and a `value` attribute.
> The `type` attribute should be used to describe the **Datatype** of the Entity and its Properties
> The `type` attribute should be used to describe the **Datatype** of the Entity and its Properties
>
> - For Native JSON Properties, the `type` can align with a well-known **Datatype** schema, such as [schema.org](https://schema.org/DataType) or
> [XML Schema](https://www.w3.org/TR/2004/REC-xmlschema-2-20041028/) - typically values such as: `Time`, `Boolean`, `DateTime`, `Number`,
> `Text`, `Date`, `Float`, `Integer` etc.
> - For other JSON Objects, where possible use a datatype from an existing ontology - for example `PostalAddress` aligns with `https://schema.org/PostalAddress`.
> - `"type": "Property"` can also be used if maintenance of a detailed datatype is not important.
> - For GeoProperties, define the position using [GeoJSON](https://geojson.org/) and use the attribute type: `"type": "geo:json"`
> - Use of [NGSI-LD](https://ngsi-ld-tutorials.readthedocs.io/) Property sub-classes such `LanguageProperty`, `VocabularyProperty`, `JsonProperty` and `ListProperty`
> can be useful if it is enviaged that an NGSI-v2 system is expected to later connect with NGSI-LD systems for Federations and Data Spaces
> - By convention `"type": "Relationship"` is used for [Relationships](entity-relationships.md)
> - For Native JSON Properties, the `type` can align with a well-known **Datatype** schema, such as
> [schema.org](https://schema.org/DataType) or [XML Schema](https://www.w3.org/TR/2004/REC-xmlschema-2-20041028/) -
> typically values such as: `Time`, `Boolean`, `DateTime`, `Number`, `Text`, `Date`, `Float`, `Integer` etc.
> - For other JSON Objects, where possible use a datatype from an existing ontology - for example `PostalAddress`
> aligns with `https://schema.org/PostalAddress`.
> - `"type": "Property"` can also be used if maintenance of a detailed datatype is not important.
> - For GeoProperties, define the position using [GeoJSON](https://geojson.org/) and use the attribute type:
> `"type": "geo:json"`
> - Use of [NGSI-LD](https://ngsi-ld-tutorials.readthedocs.io/) Property sub-classes such `LanguageProperty`,
> `VocabularyProperty`, `JsonProperty` and `ListProperty` can be useful if it is enviaged that an NGSI-v2 system is
> expected to later connect with NGSI-LD systems for Federations and Data Spaces
> - By convention `"type": "Relationship"` is used for [Relationships](entity-relationships.md)
#### 2 Request:
Expand Down
16 changes: 12 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ demonstrate the correct use of individual FIWARE components and shows the flow o
Solution either by connecting to a series of dummy IoT devices or manipulating the context directly or programmatically.

<!--- GLOBAL SUMMIT BANNER AD -->
<a href="https://www.fiware.org/global-summit/"><img src="https://fiware.github.io//catalogue/img/Summit24.png" width="240" height="70" /></a>

<a href="https://www.fiware.org/global-summit/"><img src="https://fiware.github.io//catalogue/img/Summit24.png" width="240" height="70" /></a>

<!--- GLOBAL SUMMIT BANNER AD
<a href="https://www.fiware.org/global-summit/"><img src="https://fiware.github.io//catalogue/img/Summit23.png" width="240" height="70" /></a> <a href="https://www.eventbrite.com/e/fiware-on-site-training-tickets-591474775977"><img src="https://fiware.github.io//catalogue/img/Training23.png" width="240" height="70" /></a>
Expand Down Expand Up @@ -101,8 +102,8 @@ FIWARE Postman collections can be downloaded directly from the

[Gitpod](https://github.com/gitpod-io/gitpod) is an open-source Kubernetes application for ready-to-code cloud
development environments that spins up an automated dev environment for each task, in the cloud. It enables you to run
the tutorials in a cloud development environment directly from your browser or your Desktop IDE.
The default environment is based on Ubuntu and includes Java `11.0.16` and Maven `3.8.6`.
the tutorials in a cloud development environment directly from your browser or your Desktop IDE. The default environment
is based on Ubuntu and includes Java `11.0.16` and Maven `3.8.6`.

### Apache Maven <img src="https://maven.apache.org/favicon.ico" align="left" height="30" width="30" style="border-right-style:solid; border-right-width:10px; border-color:transparent; background: transparent">

Expand All @@ -115,7 +116,14 @@ Scala code into a JAR file. Apache Maven `3.8.6` or higher is recommended.

[jq](https://jqlang.github.io/jq/) is a lightweight and flexible command-line JSON processor which can be used to format
the JSON responses received from the context broker and other FIWARE components. More information about how to use jq
can be found [here](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq). `jq-1.6` is recommended.
can be found [here](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq). `jq-1.6` is
recommended.

### Windows Subsystem for Linux

We will start up our services using a simple bash script. Windows users should download the
[Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) to provide a command-line
functionality similar to a Linux distribution on Windows.

## Data models

Expand Down
7 changes: 3 additions & 4 deletions docs/iot-agent-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -814,10 +814,9 @@ Effectively the IoT Agent is offering a simplified facade pattern of well-known
Therefore, this section of registering and invoking commands **duplicates** the instructions found in the
[previous tutorial](iot-agent.md)

> **Note:** If the device is provisioned, but no data concerning the Entity is present in the context broker yet, the invocation must
> include the `type` of the Entity to succeed. However if the Entity `type` is already known
> to the broker, this hint
> is not necessary. This is because the registration is matched on both `id` and `type`.
> **Note:** If the device is provisioned, but no data concerning the Entity is present in the context broker yet, the
> invocation must include the `type` of the Entity to succeed. However if the Entity `type` is already known to the
> broker, this hint is not necessary. This is because the registration is matched on both `id` and `type`.

### Ringing the Bell

Expand Down
7 changes: 3 additions & 4 deletions docs/iot-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -843,10 +843,9 @@ Once the commands have been registered it will be possible to ring the **Bell**,
switch the **Smart Lamp** on and off by sending requests to the Orion Context Broker, rather than sending UltraLight 2.0
requests directly the IoT devices as we did in the [previous tutorial](iot-sensors.md).

> **Note:** If the device is provisioned, but no data concerning the Entity is present in the context broker yet, the invocation must
> include the `type` of the Entity to succeed. However if the Entity `type` is already known
> to the broker, this hint
> is not necessary. This is because the registration is matched on both `id` and `type`.
> **Note:** If the device is provisioned, but no data concerning the Entity is present in the context broker yet, the
> invocation must include the `type` of the Entity to succeed. However if the Entity `type` is already known to the
> broker, this hint is not necessary. This is because the registration is matched on both `id` and `type`.

### Ringing the Bell

Expand Down
Loading

0 comments on commit 5af9fbc

Please sign in to comment.