Cancel
Showing results for 
Search instead for 
Did you mean: 

[Announcement] Open Source Release of MindConnect-NodeJS and Node-RED Library

Full Documentation:

 

https://opensource.mindsphere.io

 

Current announcements:

 

mindconnect-nodejs 3.6.0

node-red-contrib-mindconnect 3.6.1

 

The MindConnect-NodeJS and MindConnect Node-RED packages which were until recently only available within Siemens are now released as community driven projects under MIT license. 

 

GitHub Repositories and NPM packages:

 

NodeJS Library:

- npm: https://www.npmjs.com/package/@mindconnect/mindconnect-nodejs
GitHub: https://github.com/mindsphere/mindconnect-nodejs

 

# install latest stable version

npm install @mindconnect/mindconnect-nodejs

# install latest alpha version

npm install @mindconnect/mindconnect-nodejs@alpha

 

Node-RED node:

- npm: https://www.npmjs.com/package/@mindconnect/node-red-contrib-mindconnect
- GitHub: https://github.com/mindsphere/node-red-contrib-mindconnect

- DockerHub (x86 and ARM Images)https://hub.docker.com/r/mindconnect/node-red-contrib-mindconnect

 

npm install @mindconnect/node-red-contrib-mindconnect

Some of the features:

 

NodeJS Library:

- (Bulk-)Upload of TimeSeries, Events and Files to MindSphere 

- native node.js library

- typescript types

- Command Line Interface 

- Starter Projects for javascript and typescript

 

CLI examples:

 

$ mc --help

Usage: mc [options] [command] Options: -V, --version output the version number -h, --help output usage information Commands: onboard|ob [options] onboard the agent with configuration stored in the config file agent-token|atk [options] displays the agent token for use in other tools (e.g. postman) upload-timeseries|ts [options] parse .csv file with timeseriesdata and upload the timeseries data to mindsphere upload-file|uf [options] upload the file to the mindsphere file service (optional: passkey) * create-event|ce [options] create an event in the mindsphere (optional: passkey) * agent-status|as [options] displays the agent status and agent onboarding status * create-agent|ca [options] create an agent in the mindsphere * offboard-agent|of [options] offboards the agent in the mindsphere * renew-agent|rn [options] renews the agent secrets * service-credentials|sc [options] provide login for commands which require technical user credentials * service-token|stk [options] displays the service token for use in other tools (e.g. postman) * register-diagnostic|rd [options] register agent for diagnostic * get-diagnostic|gd [options] get diagnostic information * unregister-diagnostic|ud [options] unregister agent from diagnostic * prepare-bulk|pb [options] creates a template directory for timeseries (bulk) upload * run-bulk|rb [options] runs the timeseries (bulk) upload job from <directoryname> directory * check-bulk|cb [options] checks the progress of the upload jobs from <directoryname> directory * list-assets|la [options] list assets in the tenant * list-files|ls [options] list files stored with the asset * download-file|df [options] download the file from mindsphere file service * spectrum-analysis|sp [options] perform spectrum analysis on a sound file @ signal-validation|sv [options] perform signal validation @ starter-ts|st [options] creates a starter project in typescript # starter-js|sj [options] creates a starter project in javascript # Documentation: the magenta colored commands * require service credentials. the cyan colored commands require mindconnectlib (agent) credentials the blue colored commands @ use analytical functions of MindSphere the green colored commands # are used to setup starter projects the service credentials should only be used in secure environments for setup tasks Full documentation: https://opensource.mindsphere.io

 

Node-RED

(Bulk-)Upload of TimeSeries, Events and Files to MindSphere 

native nodejs implementation

- works on ARM and X86 processor architectures

see also:

 

https://developer.mindsphere.io/resources/index.html#community-tools-and-libraries

 

mindconnectagent-flow (1).pngNode-RED Agent

 

The full documentation can be found on github. Smiley Happy

7 REPLIES 7

Re: [Announcement] Open Source Release of MindConnect-NodeJS and Node-RED Library

Experimenter
Experimenter

I observed, It requires high processing power, while tansmitting the varaible at high samples, someitime getting error token invalid and need to offboard and reonboard the agent with new IAT 

Re: [Announcement] Open Source Release of MindConnect-NodeJS and Node-RED Library

I added some critical sections around renewal of the tokens and storing of the files as well as some load tests in the latest version. @Chandrakants 

Re: [Announcement] Open Source Release of MindConnect-NodeJS and Node-RED Library

mindconnect-nodejs 3.3.0 - (Midnight Blue Vienna) - February 2019
- upgraded referenced packages to the latest version
- improved resilience under heavy load
Bugfixes 3.3.0
- improved resiliency
- added critical sections around file storage and secret renewal
- added retries for file storage and secret renewal
- fixed stream processing in file upload
- cleaned up the code
 
node-red-contrib-mindconnect: 3.3.0 (Vienna Panthers) - February 2019

New Features 3.3.0
- Updated to version 3.3.0. of mindconnect library
- added container build process on hub.docker.com
- direct link to configuration settings in MindSphere from Node-RED UI
- improved error handling

Bugfix 3.3.0
- fixed the issue #3 Failed to load mindconnect node when modifying the URL root path #3 


Re: [Announcement] Open Source Release of MindConnect-NodeJS and Node-RED Library - April 2019

mindconnect-nodejs 3.4.0 - (Malachite Vienna) - April 2019

 

- new CLI commands mc starter-ts and mc starter-js for starter projects
- added version to user-agent

 

Bugfixes 3.4.0

 

- refactored the CLI commands to separate files
- made lock private in mindconnect storage
- references upgrade
 
 
node-red-contrib-mindconnect 3.4.0 (Vienna Caracals) - April 2019

New Features 3.4.0

- updated to version 3.4.0. of mindconnect-nodejs library.
- auto keep-alive: the node will renew the token every hour even when there is no data sent.
- programatic delivery of the configuration - prerequisite for auto-configuration node which is coming in next versions
- moved schema-validation to mindconnect-schema.ts, improved code and documentation
- new msg._error message with timestamped error property for better flows
 
npm install @mindconnect/mindconnect-nodejs
npm install @mindconnect/node-red-contrib-mindconnect
 

Re: [Announcement] Open Source Release of MindConnect-NodeJS and Node-RED Library - May 2019

The mindconnect-nodejs may release is out and is a bit bigger then originally planned Smiley Wink

 

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

 

Here is the changelog.

 

3.5.3 - (Venetian Red Vienna) - May 2019 - Recovery Bugfix 3.5.3

  • added node v8 compatible URL import for Raspberry PIs

3.5.2 - (Venetian Red Vienna) - May 2019 - Recovery Bugfix 3.5.2

  • fixed incorrect handling of --force parameter in mc run-bulk command

 

3.5.1 - (Venetian Red Vienna) - May 2019

  • CLI Command: agent-status displays agent status
  • CLI Command: agent-token provides a valid agent token for use in tools (e.g. postman)
  • CLI Command: service-token provides a valid service-credentials token for use in tools (e.g. postman)
  • CLI Command: prepare-bulk - creates a template directory for timeseries (bulk) upload
  • CLI Command: run-bulk - runs the timeseries (bulk) upload jobs
  • CLI Command: check-bulk - checks the progress of the upload jobs
  • CLI Command: create-agent - creates a new agent in the mindsphere (#12)
  • CLI Command: offboard-agent - offboards the agent in the mindsphere (#11)
  • CLI Command: renew-agent - renews the agent secrets (#13)
  • CLI Command: upload-file - New option: passkey : enables uploading the files also with service credentials
  • CLI Command: upload-file - New option: parallel :configures the number of parallel uploads
  • CLI Command: create-event - New option: passkey : enables creation of events also with service credentials
  • CLI Command: renew-agent - renews the agent secrets (#13)
  • mindconnect-agent: created new UploadFile method capable of running the multipart upload (#4)
  • mindconnect-agent: the UploadFile can now take a buffer additionally to file (#23)
  • mindconnect-agent: the UploadFile can now run in parallel (#23)
  • mindconnect-agent: the MindSphere path name can be configured (#23)
  • mindconnect-agent: removed the manual chunking of the files in favor of multipart upload (#23)
  • mindconnect-agent: deprecated the old upload method (#23)
  • SDK: started a PRELIMINARY SDK for the new commands which require additional mindsphere APIs
  • SDK: preliminary Support for following services
  • Agent Management Service
  • Asset Management Service
  • Event Management File Service
  • Time Series Service
  • Time Series Bulk Service
  • IoT File Service
  • CLI: color support for low color terminals -CLI: progress tracking for long-running commands (upload-file, bulk-run...)

Bugfixes and improvements 3.5.1

  • CLI Command: upload-timeseries - improved help and error messages during parsing #20
  • mindconnect-agent: removed content-type header from GET Messages according to MindSphere recommendation
  • Moved the documentation generation to compodoc instead of typedoc
  • Bumped all dependencies

Contributions ❤️ <3

  • Thanks to ahmedi92 and goko for the contributions on this version. You rock!

Announcements

  • SDK: the SDK will be extracted to a separate package in the version major version (4.0.0)
  • CLI: the CLI will be extracted to a separate package in the future major version (4.0.0)
  • We <3 contributions!
  • We are working on the legal framework to let outside (non-Siemens) collabarators contribute. Stay tuned Smiley Happy

About the SDK in the project and what to expect

The SDK in this package is only a preliminary version which is used to provide support for the CLI.

Even though you can already play with it, don't rely on it too much because it will be redesigned in the future to support different scenarios like deployment in the browser and also different authentication mechanisms like frontend authentication, backend authentication and token service authentication (for cross tenant access) in the SDK.

This is at the moment really just a pre-pre-alpha version which was necessary in order to be able to provide the CLI commands and it only works with service credetials authentication.

Bulk Imports and Standard Imports

At this point in time (May 2019) the Bulk Import only works for Simulation Assets and not for Performance Assets. This is why in this version we still use the standard APIs for the import of the historical data. Please be aware that the use of this feature has a direct impact on your mindsphere resource consumption and that you might get a notice that you will need to upgrade your account's data ingest rate.

The standard import feature will be deprecated and removed from the CLI once bulk upload also gets enabled for performance assets.

 

Re: [Announcement] Open Source Release of MindConnect-NodeJS and Node-RED Library - May 2019

There was also an update for the node-red-contrib-mindconnect Node-RED node.

Smiley Happy

3.5.0 (Vienna Clouded Leopards) - May 2019

New Features 3.5.0

  • updated to version 3.5.3 of mindconnect-nodejs library
  • chunked upload is now using the multipart upload file API
  • there is a new experimental parameter max async uploads: If this setting is > 1 the node will not wait for every request to finish
  • switched documentation generation to compodoc as typedoc doesn't seem to be maintained
  • bumped all versions

Bugfixes 3.5.0

  • improved documentation in README.md

 

see also :

 

https://playground.mindconnect.rocks/#flow/cf48f745.e195e8

 

Capturenodered.PNG

 

Re: [Announcement] Open Source Release of MindConnect-NodeJS and Node-RED Library - July 2019

There were two new releases of MindSphere open source projects. The CLI includes this time a few new basic analytics commands as well (spectrum analysis, signal validation) so that you can play with MindSphere sound analytics or test the MindSphere signal validation from the command line.

 

If somebody feels like contributing to the mindsphere open source software (or improving documentation) the issues which could need some help are all marked with good first issue Smiley Happy

 

https://github.com/mindsphere/mindsphere.github.io/issues

 

Have fun Smiley Happy

 

Changelogs:

 

MindConnect-NodeJS

 

https://opensource.mindsphere.io/docs/mindconnect-nodejs/CHANGELOG.html

 

3.6.0 - (Cobalt Blue Vienna) - July 2019

 

  • SDK: The SDK in this package is stil only a preliminary version which is used to provide support for the CLI.
  • SDK: added IotTimeSeriesAggregateClient to the SDK
  • SDK: added SpectrumAnalysisClient to the SDK
  • SDK: added SignalValidationClient to the SDK
  • CLI Command: mc spectrum-analysis: performs spectrum analysis on a sound file (#40)
  • CLI Command: mc signal-validation: performs signal validation on the mindsphere data (#39)
  • CLI Command: mc list-files: lists iot files stored with the asset (#35)
  • CLI Command: mc list-assets: lists assets in the tenant (#35)
  • CLI Command: mc download-file: downloads file from MindSphere iot file service (#35)

Bugfixes and Improvements 3.6.0

  • SDK: IoTfile - GetFiles - optional parameters are now in query string (bugfix)
  • CLI - agent commands - precedence for location of the .mc directory: path to agentconfig.json > currentdir > user home dir (#65)
  • All tests are now self-contained.
  • All images are now shrinked.
  • Bumped all dependencies. (including all lodash security updates until 7/14/2019)

Contributions 3.6.0 Heart <3

  • Thanks to goko for the contribution and deniz for finding the bug #65.

 

 

MindConnect Node-RED Node - Changelog

https://opensource.mindsphere.io/docs/node-red-contrib-mindconnect/CHANGELOG.html

 

3.6.1 (Vienna Jungle Cats) - July 2019 - RecoveryBugfixes 3.6.1

  • Security fix: Bumped the lodash dependency to 4.17.4

3.6.0 (Vienna Jungle Cats) - July 2019

 

New Features 3.6.0

  • Added Links to MindSphere OpenSource Tools and Libraries Documentation
  • upgraded to version 3.6.0 of the mindconnect-nodejs library
  • bumped all dependencies
  • added explicit :rw to the docker container documentation (see #39)

Bugfixes 3.6.0

  • improved documentation in README.md