MindConnect-NodeJS

Introduction

This is a nodejs library which can be used as a starting point for custom agent implementation in nodejs. The library also contains useful tooling like command line support, which enables the user to easily import (historical) timeseries data, files and events to MindSphere.

GitHub npm

Prerequisites

You will need Node.js which can be acquired from nodejs.org. The library can be installed everywhere where nodejs is running ( Windows, Linux, OSX , Raspbian…)

Getting and Installing the MindConnect-NodeJS Library

There are several ways to install the library. The most common one is via npm registry:

Installing the library via npm

# install the latest stable library from the npm registry
npm install @mindconnect/mindconnect-nodejs

# install the latest alpha version from the npm registry
npm install @mindconnect/mindconnect-nodejs@alpha

As an alternative you can also clone the GitHub repository and install the file from the local file.

# clone the repository and run in the library directory
npm install
npm pack

# in your project directory run
npm install mindconnect-...tgz --save

The release files are also available for download at

https://github.com/mindsphere/mindconnect-nodejs/releases

This project has been released under an Open Source license. The release may include and/or use APIs to Siemens’ or third parties’ products or services. In no event shall the project’s Open Source license grant any rights in or to these APIs, products or services that would alter, expand, be inconsistent with, or supersede any terms of separate license agreements applicable to those APIs. “API” means application programming interfaces and their specifications and implementing code that allows other software to communicate with or call on Siemens’ or third parties’ products or services and may be made available through Siemens’ or third parties’ products, documentations or otherwise.

The content of the community tools and libraries documentation pages is licensed under the MIT License.
Siemens API Notice applies.
Back to top