Skip to content

MindSphere node library

Usages of MindSphere nodes

The following listing shows the specific "MindSphere" nodes and their respective functions:

Send email

Send email

The "send email" node sends an email to one or more recipients.

You use this node to:

  • Notify the user about an important event.
  • Attach the files stored in an asset.

Note

It supports only PDF, ZIP, CSV and JSON file types.

Requirements:

  • The email address must be valid.

Example

To send an email from VFC, follow these steps:

  1. Create the flow as shown below:

    create the flow

  2. Edit read file node properties: – Asset: Select an Asset file. – File path: Enter the file path.

  3. Edit function node properties: – Code:

        msg.attachments = {
        content: msg.payload, filename: 'example.zip'
        };
        return msg;
    
  4. Edit send email node properties:

    edit send email

    ① Enter the email address

  5. Save and execute the flow.

Note

Content of "send mail" node Users of Visual Flow Creator are responsible for the content of all emails that are sent using the "send mail" node.

Output

The email is successfully received with the attachment.

Output

Send SMS

Send SMS

The "send SMS" node sends a message to receive the notification directly on the mobile phone.

Example

To send a message to your mobile phone from VFC, follow these steps:

  1. Create the flow as shown below:

    Create the flow

  2. Edit inject node properties:

    • Payload (string): Dear Customer, Welcome to VFC.
  3. Edit send SMS node properties:

    Edit send sms

  4. Save and execute the flow.

Output

The message is successfully received on your mobile phone.

Output mobile phone

Create event node

create event node

The "create event" node writes events for a specific asset to MindSphere.

You use this node to:

  • Document events such as errors, status changes in MindSphere.
  • Make unusual events visible in other applications, e.g. Fleet Manager.

Requirements:

  • An asset must already exist in MindSphere.

Read events node

read event node

The "read events“ node reads event data from MindSphere.

You use this node to:

  • Evaluate existing events for an asset.
  • Enable statistical analyses.
  • Check status of events.
  • In the interval mode, the dates can be passed as an ISO string or as a date object formats.

Requirements:

  • An asset must already exist in MindSphere.

Read file node

read file node

The "read file“ node reads files from MindSphere and outputs the file contents.

You use this node to:

  • Send the file contents as a message (only for non-binary files)

Write file node

Write file node

The "write file" node writes a file and links it to a certain asset.

You use this node to:

  • Write the received message as file contents to a file.
  • Define the mime type of the file using "Predefined type" element.
  • Overwrite to replace the existing file using "Overwrite" element.

Requirements:

  • An asset must already exist in MindSphere.

List file node

list file node

The "list files" node reads all file names for one asset as an array.

You use this node to:

  • List all files of an asset

Requirements:

  • An asset must already exist in MindSphere.

Delete file node

Delete file node

The "delete file" node deletes the file of an asset from MindSphere.

You use this node to:

  • Delete the file of an asset.

Requirements:

  • The file of an asset must already exist in MindSphere.

Generate node

Generate node

The "generate" node generates basic time series data and combines them. The "generate" node supports the creation of complex signals.

You use this node to:

  • Simulate cyclical time series data for test purposes.
  • Set signal type, amplitude, offset, etc. for the signal
  • Use signal type "walk" to generate a continuous signal path

Read aggregates

read aggregates

The "read aggregates" node reads aggregates by using the aggregate or time series API from MindSphere.

You use this node to:

  • Read aggregated interval data for specific interval.
  • Create statistical values
  • Allows applications to retrieve smaller data sets that cover a longer period of time with much better performance than processing all of the raw time series data.

Requirements:

  • Asset, aspect, variable must exist in MindSphere.
  • Entity Id, the property set name, a time range, and a requested aggregation interval of the application.
Configurable properties Description
API In this property, you can configure using the aggregate API or the timeseries API.
Interval Unit In this property, you can configure the interval unit using the possible values like minute, hour, day, week and month. (applicable for aggregate API only)
Interval Value In this property, the value depends on the selected interval unit. (applicable for aggregate API only)
Count In this property, you can specify the count of the result aggregates. (applicable for aggregate API only)
Mode In this property, 2 modes are available:
- Interval: In this mode, you need to set the interval with "From" and "To" timestamps and timezone. The dates can be passed as an ISO string or as a date object formats.
- Period: In this mode, you need to set the period from the past to now.

For more information on API specifications, see IoT Times Series Aggregates Service API.

Read timeseries node

Read timeseries node

The "read timeseries“ node reads time series data from MindSphere.

You use this node to:

  • Further process/convert data using a function or analytic node.
  • Specifically evaluate or validate the time series data.
  • Process multiple time series data together (using a "combine" node).
  • Select different types of variables from different aspects.
  • Read values of aspects defined for assets.
Mode Description
Interval In this mode, you need to set the interval with "From" and "To" timestamps and timezone. The dates can be passed as an ISO string or as a date object formats.
Period In this mode, you need to set the period from the past to now.
Last Value In this mode, the last timeseries value will be read.
Note: An empty value will be read, if the last timeseries entry doesn't contain required variable the empty array will be returned as output.
From last execution In this property, the value depends on the selected interval unit. (applicable for aggregate API only)

Requirements:

  • Asset, aspect and a variable must exist in MindSphere.

Note

Maximum count of timeseries data points is 2000.

Write timeseries node

write timeseries

The "write timeseries" node writes time series data to MindSphere.

You use this node to:

  • Write unprocessed data to MindSphere.
  • Update the existing time series data by activating "Use merging" option. For example, you can update the aspect value without changing the variables.

Requirements:

  • Asset, aspect and a variable must already exist in MindSphere.

Note

Update of time series data on new write operation

The "write timeseries" node overwrites all data and values of an existing timestamp. With this write operation, all variables of an asset or aspect for the respective timestamp are updated and overwritten. The "write timeseries" node overwrites existing data of variables that are not taken into consideration with zero.

The write operations can take some time. The written time series data cannot be read immediately after they are written - especially the generation of aggregations can take longer time. The written data could appear delayed (up to 15 minutes).

Subscribe timeseries node

Subscribe timeseries

The "subscribe timeseries“ node subscribes time series data from MindSphere.

You use this node to:

  • Get notifications of new incoming time series data in order to perform tasks.
  • Get updates on the new timeseries data which is posted in IOT.

Requirements:

  • Asset, aspect and a variable must exist in MindSphere.

Once the subscription is created, it can take up to 15 minutes for the service to start working.

Note

Region deviation

Support for "Subscribe timeseries" feature is in progress for Region Europe 2.

Asset type

Asset type

The "asset type“ node makes it possible to read data from multiple assets which belong to the same asset type.

You use this node to:

  • Get multiple messages with topic properties defining assets which belong to a particular asset type. The topic property messages can be directly forwarded on the input pin of read timeseries node.

Requirements:

  • Asset type, asset, aspect and a variable must exist in MindSphere.

Note

Region deviation

Support for "Asset type" feature is in progress for Region Europe 2.

Read aspect static vars

read aspect static vars

The "read aspect static vars“ node reads the static variables from the aspects.

Requirements:

  • Asset, aspect and a variable must already exist in MindSphere.

Write aspect static vars

write aspect static vars

The "write aspect static vars“ node updates the static variables in the aspects.

Requirements:

  • Asset and aspect must already exist in MindSphere.

Read asset static vars

read asset static vars

The "read asset static vars“ node reads the static variables from the assets.

Requirements:

  • Asset, aspect and a variable must already exist in MindSphere.

Write asset static vars

write asset static vars

The "write asset static vars“ node updates the static variables in the assets.

Requirements:

  • Asset and aspect must already exist in MindSphere.

Asset status

Asset status

The "asset health“ node updates the status of the asset health. The asset health status can be viewed in the info tab of Fleet Manager.

Requirements:

  • Aspect in the asset must already exist in MindSphere.

Using MindSphere in nodes

Let's try to use described nodes in some simple scenario:

Example scenario

A new logistics center is being set up in the smart city. The power consumption (Kilowatt hour) of the cranes is acquired in MindSphere. The cranes are not operated continuously. The smart city has its own power generation through wind turbines, photovoltaics and heat pumps.

Objective

The owner of the logistics center would like to calculate the energy consumed by the crane operation in order to better estimate its cost accounting of energy consumption. The owner would like to know whether a change to another energy provider is worthwhile. The following detailed data regarding the energy consumption of the cranes is needed for this:

  • Magnitude of the share of the base load.
  • Magnitude of the peak loads.

The owner would like to use the crane data for a comparison of different energy producers.

Requirement

  • The crane is connected to MindSphere and collects the energy data.
  • The energy production of the different energy suppliers of the smart city is acquired in MindSphere.

Procedure

To use a "MindSphere in" node, follow these steps:

  1. To create a "timestamp" node on the working area, move an "input node" to the working area using drag-and-drop.
  2. Move the read timeseries to the working area using drag-and-drop.
  3. Repeat step 1 with "function node" and "output node" "debug". – In this example, the function nodes contain JavaScript code for calculation of the energy consumption and the costs.
  4. Interconnect the nodes.

    Interconnect node

  5. Double-click the "read timeseries" node.

  6. To enter the asset data, click on next to the topic.

    asset data

  7. Select the asset, aspect and variable that are to be read, e.g. crane, energy data, consumption (KWh).

  8. Enter the time range using the drop-down menus of "Mode" or "Period".
  9. To start the flow, click the blue button to the left of the "timestamp" node.

Result

The flow reads the energy data of the cranes from MindSphere. The nodes can be flexibly modified and used with data of another energy supplier. Continuous checking of the energy costs is ensured. The data can be compared with other energy suppliers.

Using MindSphere out nodes

Let's try to use described nodes in an simple scenario:

Example scenario

The smart city has its own energy generation through wind energy. In the event of a storm, certain measures must be taken, e.g. implementation of a plan for maintaining the energy supply through other sources or temporary reduction of energy demand.

Objective

The smart city would like to send an email to its executives in the event of a storm warning.

Requirement

  • A weather forecast is required for next 2 days.
  • An automatable check of weather data, e.g. through an API call of a weather service.
  • The data must include the wind speed.
  • You have created the basic flow for a weather web service. You can find more information about the basic flow in the section Create a basic flow.

Procedure

To send an email, follow these steps:

  1. Move the "MindSphere out" node "send email" to the working area using drag-and-drop.
  2. Connect the "function" node to the "send email" node.

    function-email-node

  3. Double-click the "send email" node.

  4. Enter the e-mail address of the recipient.
  5. To activate the flow, click the blue button to the left of the ""timestamp"." node.

Result

The information supplied by the weather web service is converted to an object structure in the "json" node in order for the information to be processed in the "function" node.

The "function" node uses a script to check for a storm warning in the list of weather data. The "send email" node sends an email to the executives in the event of a storm warning.

Example using MindSphere nodes

Example Scenario

The maintenance team of a turbine company needs to regulate the pressure and temperature of the existing assets in the organization.

Objective

The maintenance team needs to read all data from the existing assets so as to know if the readings of all the assets are within control and operating properly.

Let us try to display the data of the assets from the given asset list - one at a time.

Requirements

  • A timestamp input
  • Asset type node
  • Read timeseries nide
  • Message payload

Procedure

  1. Import the "asset type" node and configure the topic properties as show below:

    • Double click the "asset type" node. The editor for "asset type" node pops up. Browse and select the topic for an asset.
    • Define the selections for the variables, aspects, asset type of an asset. select asset type aspect Also, you can deselect assets from the "asset type" node pop-up by using the "Exclude" feature. Click the "Exclude" checkbox and select the assets for which data readings are not to be included. Excluded window
    • Design and connect the nodes as shown below:

Design and connect node

  1. Inject the timestamp.

Result

You can view the results in the message payload.

In this example the "read timeseries" node reads the data from the selected asset and displays the data in the message payload.

read timeseries

Example using asset health node

Example

The maintenance team of a turbine company needs to update the health status of the existing assets in the organization. The asset health status can be viewed in Fleet Manager.

Objective

The maintenance team needs to check the health status of an asset and update it using asset health node.

Procedure

To update the asset health status from the previous health status to current health status, follow these steps:

  1. Design the flow as shown below: design the flow
  2. Edit the asset health node properties: Edit the asset health
    • Click select icon to select an asset.
    • Health status: Change from "Information" to "Ok".
  3. Save and execute the flow.

Result

To view the result, open "Info" tab in Fleet Manager. The asset health status is successfully updated from "Information" to "Ok".

Info tab

Note

If the asset health status is unconfirmed, it should be acknowledge by the user.

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.


Last update: July 29, 2022