Skip to content

Commit ddabf91

Browse files
committed
chore: fix spelling issues and small corrections
1 parent 67b0dc6 commit ddabf91

File tree

8 files changed

+17
-30
lines changed

8 files changed

+17
-30
lines changed

Dashboard_getting_started/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Now create a second tab called *Detail* with only one group named *Events*. We w
6868
# Designing the Dashboard:
6969
In this chapter, we will bring some life and functionality to our Overview dashboard. This tutorial is designed to build all elements from scratch and simultaneously show the logic behind a VFC dashboard. Some steps might be overcomplicated with the purpose of demonstrating several VFC nodes.
7070

71-
> If you just want to check out the final result, you can copy paste the [Json Flow Data From Here](./Resources/Dashboard.json). It will import all elements, including nodes, tabs and groups. Remember to adjust all *read-timeseries* and *write-timeseries* nodes to your own assets.
71+
> If you just want to check out the final result, you can copy paste the [Json Flow Data From Here](./Resources/IMPORT_Dashboard.json). It will import all elements, including nodes, tabs and groups. Remember to adjust all *read-timeseries* and *write-timeseries* nodes to your own assets.
7272
7373
For the beginning, we will place three *text* nodes and three *button* nodes in the flow. This will be our Asset selector, where each machine has it's own button like below:
7474

DataLake_provideAccessToken/readme.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ This small flow triggers sets up an API endpoint which can be called from extern
2525
The function delivers the body for the API request against the `/api/datalake/v3/generateAccessToken` endpoint. From here, the Access Token is provided and feedback to the user via the `http`-Node
2626

2727
## Result
28-
Once the API endpoint is accessed, the user is presented with a JSON respose containing the Access Token for IDL.
29-
This can then be used in native S3-Tools to be worked with and connect to the IDL:
28+
Once the API endpoint is accessed, the user is presented with a JSON response containing the Access Token for IDL.
29+
This can then be used in native S3-Tools to be worked with and connect to the IDL:
30+
<!-- markdown-link-check-disable-next-line -->
3031
In this example, calling the full API endpoint https://presiot-visualflowcreatorhttp.eu1.mindsphere.io/public/presiot/getAccessTokenForIDL?key=1a03090a3cc44d56c57d5cd7d545899219523b5127079317fcc2c637b3a0cab23cc1fcadce75196b36f761428e6ee80dacc64e4349928b23a2cf8e0e6495b897 results in a JSON response like shown below.
3132
![image](./doc/result_IDL_AccessToken.png)
3233

README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Insights Hub Visual Flow Creator Examples
22

3-
[![The MDL License](https://img.shields.io/badge/license-MDL-009999.svg?style=flat)](./LICENSE.md)
43
[![Documentation](https://img.shields.io/badge/mindsphere-documentation-%23009999.svg)](https://opensource.mindsphere.io/docs/mindconnect-nodejs/index.html)
54
[![Forum](https://img.shields.io/badge/mindsphere-community-%23009999.svg)](https://community.plm.automation.siemens.com/t5/Developer-Space/bd-p/MindSphere-platform-forum)
65

@@ -40,17 +39,12 @@ Please note, that the json-files are exported from another tenant. So their migh
4039
| [Virtual machine simulator](./virtualMachineSimulator/readme.md) | | :star: | - |
4140
| [Write location data to your Asset](./WriteLocationToAsset/readme.md) | Write locational information directly to your Asset using the Asset Management API | :star: | - |
4241
| [VFC Dashboard - Getting Started Guide](./Dashboard_getting_started/readme.md) | Create a dynamic Dashboard completely from scratch and learn the basics of VFC Dashboarding | :star: | - |
43-
44-
### Examples which have to be added:
45-
| Name | Description | Complexity Rating | Prerequisites |
46-
| --- | --- | --- | --- |
47-
| [TODO: Integrate external API](./integrateExternalApi/readme.md) | | :star: | |
48-
| [TODO: Dashboard with dynamic data layer](./dynamicDashboards/readme.md) | | :star: :star: | |
42+
| [Integrate external API](./integrateExternalApi/readme.md) | | :star: | |
4943

5044
You can add here your ideas or requests for further examples.
5145

5246
### Example template
53-
You want to create your own example? Just copy the [template flow-directory](./templateFlow/), adapt it and send us your pull request.
47+
You want to create your own example? Just copy an existing folder, adapt it and send us your pull request.
5448
## Remarks
5549
Please note that the screenshots show just the current state, when these examples have been created. They might differ to the latest software release.
5650

commandMqttDevice_MindConnect/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Commanding can be initiated via a dedicated API. Here we will use VFC to initiat
2727
A dedicated commanding node was added to the standard nodes of Visual Flow Creator.
2828
https://documentation.mindsphere.io/MindSphere/apps/visual-flow-creator/mindconnect-nodes.html#command-mindconnect
2929

30-
Manual confuguration towards the API endpoint for commanding is no longer needed but still shown in depth in the description below.
30+
Manual configuration towards the API endpoint for commanding is no longer needed but still shown in depth in the description below.
3131
With "MindConnect" nodes, you can send a command to MindConnect MQTT device and check the status of the sent command. For more information about MindConnect Elements, refer to [Connectivity](https://documentation.mindsphere.io/MindSphere/connectivity/overview.html).
3232

3333

createCustomEndpoint/readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The example shows how you can
77
- choose who has access to this endpoint (only users of the flow, all users on the tenant, public access)
88
- develop the API functionality using VFC nodes
99

10-
This flow demonstrates a simple getting-started example on how to provide machine data via an API for external access of the last 15min intervall of machine data as JSON object.
10+
This flow demonstrates a simple getting-started example on how to provide machine data via an API for external access of the last 15min interval of machine data as JSON object.
1111
![image](./doc/createCustomEndpoint.png)
1212

1313

@@ -20,7 +20,7 @@ This flow demonstrates a simple getting-started example on how to provide machin
2020
- generate key in case of public API access
2121
- the URL shown in the node setup is the direct URL to access the service
2222
![image](./doc/setup_KeyGeneration.png)
23-
3. Selet an Asset / Aspect / Variable(s) where you want to read the time series data from (yellow node)
23+
3. Select an Asset / Aspect / Variable(s) where you want to read the time series data from (yellow node)
2424
![image](./doc/setup_selectAssetToRead.png)
2525
4. Save the flow
2626

@@ -31,7 +31,7 @@ https://[TenantName]-visualflowcreatorhttp.eu1.mindsphere.io/public/presiot/mach
3131

3232
## Result
3333

34-
When querying the service URL e.g. via a Browser/Postman/Pyhton/... the JSON-object with the timeseries data will be received.
34+
When querying the service URL e.g. via a Browser/Postman/Python/... the JSON-object with the timeseries data will be received.
3535
![image](./doc/result.png)
3636

3737

generateSampleData/readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ With this example you are able to do that.
99
![image](./doc/generateSampleData.png)
1010

1111
- Import the flow in Visual Flow Creator
12-
- Selet an asset / aspect / variable where you want to write time series data
13-
- Doubleclick on the datatype node like `Integer` and rename the `Parameter out` value with the name of your data variable
12+
- Select an asset / aspect / variable where you want to write time series data
13+
- Double click on the datatype node like `Integer` and rename the `Parameter out` value with the name of your data variable
1414
- Save the flow
1515
- Trigger the flow

integrateExternalApi/readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Your business case may require to use external services over HTTP. Visual Flow C
1818

1919
- The inject node passes the `CITY` and `API_KEY` information to HTTP Request node through `msg` object.
2020
- (**Get Weather**) node is the HTTP Request node and it contains the URL with query parameters.
21-
- This node performs the substitution of variables with the values it recieves from the inject node.
21+
- This node performs the substitution of variables with the values it receives from the inject node.
2222
- Then HTTP request node fetches the data synchronously from Openweather service endpoint.
23-
- It converts the recieved response to JSON format and sets it as value for the payload field of the msg object.
23+
- It converts the received response to JSON format and sets it as value for the payload field of the msg object.
2424
- Debug node in the end displays the contents of payload field to the debug window.
2525

2626

virtualMachineSimulator/readme.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ It can be used if no physical assets are available or to learn about the feature
88
![image](./doc/virtualMachineSimulator.png)
99

1010
## Prerequisites
11-
- access to Asset-Managment
11+
- access to Asset-Management
1212

1313
## Setup & Configuration
1414
### Setup machine asset
@@ -27,23 +27,15 @@ e.g. `my virtual machine`
2727
2. Open the settings for the **upper** write-timeseries node select the previously generated asset instance `my virtual machine` and aspect `machine_states`. Do not select any variables.
2828
![image](./doc/VFC_setup_Asset-Aspect.png)
2929
4. Repeat this for the **lower** write-timeseries node and select `my virtual machine` -> `product_counter`. Do not select any variables.
30-
5. Adjust the execution intervall for the simulation as desired in the link-in node.
30+
5. Adjust the execution interval for the simulation as desired in the link-in node.
3131
6. Save the flow
3232

3333
:cloud: :heavy_check_mark: You're done, your machine simulation is now running - enjoy!
3434

3535

3636
## Result
37-
After saving the flow, the output of the simulation is written to the asset and you can monitor the results e.g. in Fleet Manager. Based on this you can also now start calculating the machine KPIs (OEE, Availability, Quality, ...) using the VFC or other apps.
37+
After saving the flow, the output of the simulation is written to the asset and you can monitor the results e.g. in Insights Hub Monitor. Based on this you can also now start calculating the machine KPIs (OEE, Availability, Quality, ...) using the VFC or other apps.
3838
![image](./doc/FleetManager_Results.png)
3939

4040
## See also
4141
- [Asset Manager Documentation](https://documentation.mindsphere.io/resources/html/asset-manager/en-US/index.html)
42-
43-
44-
45-
46-
47-
48-
49-

0 commit comments

Comments
 (0)