Smart Supermarket Tutorials

This is a collection of tutorials for the FIWARE ecosystem designed for NGSI-v2 developers. Each tutorial consists of a series of exercises to demonstrate the correct use of individual FIWARE components and shows the flow of context data within a simple Smart Solution either by connecting to a series of dummy IoT devices or manipulating the context directly or programmatically.

📚 NGSI-v2 Documentation	Postman Collections		developer​.fiware.org

🇯🇵 このチュートリアルは日本語でもご覧いただけます。

Data models

The following NGSI-v2 and NGSI-LD Data models are used within the tutorials:

• Tutorial-specific Data Models
• Smart Data Models

Install

To download the full set of tutorials, simply clone this repository:

git clone https://github.com/FIWARE/tutorials.NGSI-v2.git
cd tutorials.NGSI-v2/
git submodule update --init --recursive

Docker and Docker Compose

Each tutorial runs all components using Docker. Docker is a container technology which allows to different components isolated into their respective environments.

• To install Docker on Windows follow the instructions here
• To install Docker on Mac follow the instructions here
• To install Docker on Linux follow the instructions here

Docker Compose is a tool for defining and running multi-container Docker applications. A series of *.yaml files are used configure the required services for the application. This means all container services can be brought up in a single command. Docker Compose is installed by default as part of Docker for Windows and Docker for Mac, however Linux users will need to follow the instructions found here

You can check your current Docker and Docker Compose versions using the following commands:

docker-compose -v
docker version

Please ensure that you are using Docker version 20.10 or higher and Docker Compose 1.29 or higher and upgrade if necessary.

Postman

The tutorials which use HTTP requests supply a collection for use with the Postman utility. Postman is a testing framework for REST APIs. The tool can be downloaded from www.postman.com. All the FIWARE Postman collections can be downloaded directly from the Postman API network

GitPod

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.

Cygwin for Windows

The tutorials start up their services using a simple Bash script. When working locally, Windows users should download cygwin to provide a command-line functionality similar to a Linux distribution on Windows.

Apache Maven

Apache Maven is a software project management and comprehension tool. Based on the concept of a project object model (POM), Maven can manage a project's build, reporting and documentation from a 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.

Tutorials List

Core Context Management: NGSI-v2 Fundamentals

  101. Getting Started
  102. Entity Relationships
  103. CRUD Operations
  104. Context Providers
  105. Altering the Context Programmatically
  106. Subscribing to Changes in Context

Internet of Things, Robots and third-party systems

  201. Introduction to IoT Sensors
  202. Provisioning an IoT Agent
  203. IoT over an MQTT Transport
  204. Using an alternative IoT Agent
  205. Creating a Custom IoT Agent
  206. IoT over an IOTA Tangle Transport

Core Context Management: Manipulating Context Data and Persisting Historic Data

  301. Persisting Context Data using Apache Flume - MongoDB, MySQL, PostgreSQL
  302. Persisting Context Data using Apache NIFI - MongoDB, MySQL, PostgreSQL
  303. Querying Time Series Data (MongoDB)
  304. Querying Time Series Data (CrateDB)
  305. Big Data Analysis (Flink)
  306. Big Data Analysis (Spark)

Security: Identity Management

  401. Managing Users and Organizations
  402. Roles and Permissions
  403. Securing Application Access
  404. Securing Microservices with a PEP Proxy
  405. XACML Rules-based Permissions
  406. Administrating XACML via a PAP
  407. Authenticating Identities (Open-ID Connect)

Processing, Analysis and Visualization

  501. Creating Application Mashups
  503. Introduction to Media Streams
  507. Cloud-Edge Computing

NGSI-LD for NGSI-v2 Developers

  601. Introduction to Linked Data
  602. Linked Data Relationships and Data Models
  603. Traversing Linked Data Programmatically
  604. Linked Data Subscriptions and Registrations

Usage

Most tutorials supply a services script to start the containers:

cd <tutorial-name>
./services start

Following the tutorial exercises via Postman

Each tutorial submodule contains one or more docker-compose.yml files, along with a Postman collection containing the necessary HTTP requests: import the collection into Postman and follow the instructions.

Following the tutorial exercises from the command-line

Each submodule contains full instructions in README which details the appropriate bash commands (cUrl and Docker Compose) to run.

Full instructions can be found within the documentation

---

License

MIT © 2018-2023 FIWARE Foundation e.V.