MindSphere SDK for Node.js¶
Introduction¶
The MindSphere SDK for Node.js enables developers to work with MindSphere easily. It is divided into core module and several service modules, which allows developers to include only those parts of the SDK required for their use case.
The core module provides features like client configuration, authentication, token handling, logging, and a common API client implementation to access the RESTful MindSphere APIs. All service modules have a dependency on the core module.
The MindSphere SDK for Node.js provides client implementations for the following APIs:
| Name | API Version |
|---|---|
| SDK Core | 1.0.0 |
| Asset Management | 3.9 |
| IoT Time Series | 3.2 |
| IoT TS Aggregates | 4.2.0 |
| IoT File | 3.1 |
| Event Analytics | 3.1 |
Refer to the Getting Started for installation and configuration of an API client.
Get the SDK¶
The MindSphere SDK for Node.js is available for download on the Siemens Industry Online Support (SIOS) Portal. The SDK core and service specific modules are in TGZ format and bundled into a ZIP file.
Download for region China 1
For region China 1, download the zip file with Region China special label version from the Siemens Industry Online Support (SIOS) Portal.
Features¶
MindSphere SDK Core¶
The core module of the MindSphere SDK for Node.js provides features like client configuration, authentication, token handling, logging, and a common API client to access all RESTful MindSphere APIs. All the service modules have a dependency on the core module.
Client Configuration¶
The ClientConfig model provides an interface to configure proxy settings, MindSphere region and connection time-outs.
Token Handling Mechanism¶
The MindSphere SDK for Node.js provides an easy mechanism for configuring user authorization tokens or service credentials for fetching technical tokens. It handles technical token fetching, token caching, validation and re-fetching.
Refer to Token Handling for more information.
Logging¶
Logging is configured using the debug module. It can be enabled or disabled.
Refer to Logging for more information.
Error Handling¶
The MindSphere SDK for Node.js provides simple and readable exceptions in JSON format. Exceptions contain the error code and description of the error for easy parsing and processing.
Any questions left?
Except where otherwise noted, content on this site is licensed under the Development License Agreement.