sap-archive / sap-iot-samples

Basic Node.js and JavaScript examples for typical usage of SAP IoT APIs that help you get started with development.

Important Notice

This public repository is read-only and no longer maintained. For the latest sample code repositories, visit the SAP Samples organization.

Overview

With SAP Internet of Things you can receive measurement data from any device, match it to a business process context in SAP IoT and trigger and automate business processes in SAP ERP with Smart Sensing, rules and actions.

Integrate and extend the computing capabilities with the IoT Edge, the Intelligent Edge Computing software that provides "microservices at the edge" for Internet of Things (IoT).

Use this sample collection to learn and speed up the use of the different SAP IoT APIs and services.

The context of most of the included examples is to build a solution, that allows deliveries coming from the sales order processing in ERP to be tracked with sensors. This allows to find out, if a product that should have been cooled (or not exposed to too much light or any other condition), was actually cooled all the way from shipment to receiving. This is called in the IoT-World a "cold chain tracking" scenario.

Prerequisites

1. An SAP Business Technology Platform global account with entitlements for SAP IoT, see the Discovery Center for different pricing solutions.

2. Other prerequisites are listed in each sample.

Download, Installation, Configuration, and Use

Clone or download the repo to your computer and then follow more detailed installation instructions below per folder in the repo:

Feature	Description	Link
SAP IoT APIs	These scripts allow you to create device and thing/application model based on a definition language for digital twins in json files. You can use these scripts for a first prototype where you want to have the device model and the thing/application model mostly in sync and where you have only one set of measurements and one set of master data. To use these scripts please refer to the tutorials at https://developers.sap.com/tutorials/iot-model-create.html and https://developers.sap.com/tutorials/iot-onboard-device.html to learn how to apply them to your tenant/system.	SAP IoT APIs
SAP IoT Edge	Extension Service samples for the IoT Edge.	IoT Edge Extensions
Smart Sensing	This folder contains Sample codes and utilities for the SAP Internet of Things Smart Sensing.	Smart Sensing Folder
Location Services	The postman collection and environment in here allow you to make calls to the location services APIs of SAP IoT. Instructions for how to use them are provided in the tutorials at http://developers.sap.com/tutorials/iot-locations-geofence.html.	Location Services Samples
Analytics	The postman collection and environment in here allow you to create a small sample application model from scratch, put some measurement data into it. Then it provides the apis in SAP IoT that allow you to hook up to and share the aggregated data with SAP Analytics Cloud. Instructions how to use the collection are provided in the tutorial at http://developers.sap.com/tutorials/iot-sac-integration-ext.html.	SAP Analytics Cloud Integration
Streaming Access	Samples to deploy a Cloud Foundry java application to start consuming the streaming data from SAP IoT topics (both raw sensor data and processed data with business semantics). Please note that the feature can only be used with Early Adopter Access. The provided samples implement a simple pure Java consumer and a Spring Boot application to consume from the streaming access Kafka and forward the data to a specific hdi-container of your SAP HANA Cloud instance.	Streaming Access Folder
Various and tools	A folder collecting various tools.	Tools

References

To find all developer oriented material please refer to Internet of Things community topic.

Product documentation

For any further information please refer to the product documentation of SAP IoT

Limitations and Known Issues

The included samples do not cover all SAP IoT APIs and functionalities.

Support and Contributing

These samples are provided "as-is" basis with detailed documentation on how to use them.

Please use our community for questions and answers on the sample code.

If you have found a material issue with the example please create an issue in this GitHub repo.

Please feel free to put in a pull request and give us some time to review and respond.

License

Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE in this repository.

sap-iot-samples's Issues

[rl-assigned_teams-2] Violation against OSS Rules of Play

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-2
Explanation: Does it have an admin team on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

How come we are requiring such an old node version?

When trying to install the bootstrap scripts I get the messages:

npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE package: '[email protected]',
npm WARN EBADENGINE required: { node: '^12.0.0' },
npm WARN EBADENGINE current: { node: 'v15.11.0', npm: '7.6.0' }
npm WARN EBADENGINE }
npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE package: '@sap/[email protected]',
npm WARN EBADENGINE required: { node: '^6.0.0 || ^8.0.0 || ^10.0.0 || ^12.0.0' },
npm WARN EBADENGINE current: { node: 'v15.11.0', npm: '7.6.0' }
npm WARN EBADENGINE }

IMO we should update to a non-deprecated node version!

https://github.com/SAP-samples/sap-iot-samples/blob/02400016bc2d006ecf53e8999553b2538ba8e0f5/iot-bootstrap-scripts/package.json#L11

Fix code scanning alert - Log entries created from user input

Tracking issue for:

• https://github.com/SAP-samples/sap-iot-samples/security/code-scanning/1

[rl-vulnerability_alerts-1] Violation against OSS Rules of Play

The OSPO bot created this issue by mistake - It did not have enough priviledge to check the vulnerability alerts, So I am closing this issue now. Sorry for any inconvenience.

[rl-assigned_teams-3] Violation against OSS Rules of Play

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-3
Explanation: Does it have enough admins on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

[rl-assigned_teams-1] Violation against OSS Rules of Play

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-1
Explanation: Does it have enough teams on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

Links available in iot-location-services-samples not working

The links provided within the second use case - geo services are not working

https://developers.sap.com/tutorials/iot-locations-geofence - 404 Error Page Not Found. Pl check.