Skip to content

This example introduces the Data Service Device Kit and how to extract data from the Data Service using the avilable API calls

License

Notifications You must be signed in to change notification settings

SiemensIndustrialEdgeITA/data-service-development-kit-getting-started

 
 

Repository files navigation

Data Service Development Kit Getting Started

Using the Data Service Development Kit app you can develop your own apps based on the Data Service, test your app locally with simulated data to make sure your it behaves the same once you deploy your app to Industrial Edge. - Data Service Development Kit Getting Started

Description

Overview

This example introduces the Data Service Device Kit and how to extract data from the Data Service using the available API calls. The free Development Kit provides you with a Docker Image that launches the Data Service API on the developer's computer and makes it callable. With this tool, you can develop your customer's app entirely without Industrial Edge access on your development computer. Nor do you need to own a real device that provides you with data. With our simulation service, plant data can be simulated without further ado.

  • The Development Kit can be started with a few clicks on the development environment
  • Immediately testable of your API calls even without access to a real PLC

General task

The simulation tool - provided by the Development Kit - generates a Sinus Signal and stores the data in the Data Service container. The Flow of the Node-Red applications accesses the Data Service via available API calls and displays the data in a dashboard.

deploy VFC

Requirements

Prerequisites

  • Data Service Development Kit for Industrial Edge V.1.3.0

You can download the Data Service Development Kit Bundle to your computer from Siemens Industry Online Support (SIOS ID 109792717). The bundle includes the following components:

  • Docker app: docker-compose.yml
  • User documentation
  • OpenAPI specification
  • Application example
  • Docker image
  • Data simulator
  • MQTT Broker
  • Data Service (with external interface (REST API) for non-Siemens applications)

This GitHub-Repository contains:

Installation

The following services must be installed:

  • Docker for Linux

NOTE: Linux device is used for this application example

Usage

The Data Service Development Kit offers you the possibility to make your app fit for Industrial Edge. Using the integrated API interface, you save your app's data to the Data Service database structure and retrieve it when needed. This means that other apps, such as Performance Insight or Notifier, can easily access the data and use it for themselves.

After the development phase, your app can be handed over to your customer together with the Data Service. In a few steps, the customer connects the Data Service with the already available connectors and thus creates a quick link to his plant.

Documentation

You can find the further information about the following steps in the docs:

NOTE - additional Information: If you need more information, you can find them in the user documentation of the Data Service Development Kit Bundle.

Application Example

Some examples on how to extract data from Data Service application using the available API calls is provided in the examples:

  1. Read and Write Nodes for DataService

  2. Production data extraction and visualization in NodeRED

    • Production data extraction and visualization in NodeRED The guide above explains how to extract data from a PLC data source, save data into the Data Service version >= 1.4.0 database and retrieve them using NodeRED, with the aim of saving the values of the collected data points into a CSV file or exploiting them in other applications for specific purposes.

Contribution

Thank you for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section. Additionally everybody is free to propose any changes to this repository using Pull Requests.

If you are interested in contributing via Pull Request, please check the Contribution License Agreement and forward a signed copy to industrialedge.industry@siemens.com.

License and Legal Information

Please read the Legal information.

About

This example introduces the Data Service Device Kit and how to extract data from the Data Service using the avilable API calls

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published