Introduction to MindSphere 1 Prerequisites 2 MindSphere MindConnect IoT Extension Getting Started Preparations 3 MindConnect IoT Extension 4 Verify data in Fleet Manager 5 Getting Started 07/2018
Legal information Warning notice system This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger. DANGER indicates that death or severe personal injury will result if proper precautions are not taken. WARNING indicates that death or severe personal injury may result if proper precautions are not taken. CAUTION indicates that minor personal injury can result if proper precautions are not taken. NOTICE indicates that property damage can result if proper precautions are not taken. If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage. Qualified Personnel The product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems. Proper use of Siemens products Note the following: Trademarks WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed. All names identified by are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner. Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions. Siemens AG Division Digital Factory Postfach 48 48 90026 NÜRNBERG GERMANY P 08/2018 Subject to change Copyright Siemens AG 2018. All rights reserved
Table of contents 1 Introduction to MindSphere... 5 2 Prerequisites... 7 3 Preparations... 9 3.1 Activate MindConnect IoT Extension... 9 3.2 MindSphere Launchpad Integration... 9 3.3 Create an asset... 9 4 MindConnect IoT Extension... 13 4.1 Log in to MindConnect IoT Extension... 13 4.2 Assign required roles... 13 4.3 Create Device Simulator... 15 4.4 Data Mapping... 18 5 Verify data in Fleet Manager... 23 Getting Started, 07/2018 3
Table of contents 4 Getting Started, 07/2018
Introduction to MindSphere 1 Here are some links for further overview information and details: MindSphere Documentation Area (https://documentation.mindsphere.io) MindSphere Developer Documentation (https://developer.mindsphere.io) Cumulocity Developer Center (https://www.cumulocity.com/dev-center) Getting Started, 07/2018 5
Introduction to MindSphere 6 Getting Started, 07/2018
Prerequisites 2 MindAccess IoT Value Plan/Developer Plan Modern web browser (Google Chrome, Mozilla Firefox, Apple Safari) Getting Started, 07/2018 7
Prerequisites 8 Getting Started, 07/2018
Preparations 3 3.1 Activate MindConnect IoT Extension In the welcome mail of your purchased IoT or Developer Plan you can find the activation link for MindConnect IoT Extension. Click on it, fill out the details and send it to provisioning@mindsphere.io. After a while, you should receive an e-mail with the login credentials for MindConnect IoT Extension. 3.2 MindSphere Launchpad Integration The next step is to assign the required role to your user to unlock MindConnect IoT Extension so that it appears on your MindSphere Launchpad. Procedure 1. Log in to your MindSphere tenant. 2. In the Launchpad, click on User Management. 3. Select your user from the list and click on "Edit" (alternatively, you can use the search box to find your user). 4. In the "Edit User" dialog search for role "mdsp:core:mcie.user" and assign it to your user. 5. Close the "Edit User" dialog. 3.3 Create an asset An asset can have properties that are time series data. Before ingesting time series data into MindSphere, an asset has to be created. The creation of an asset consists of three steps: 1. Create an aspect type. 2. Create an asset type and use the previously defined aspect type. 3. Create an asset based on the asset type. If you already have an existing asset, then you can skip this step and continue with chapter MindConnect IoT Extension (Page 13). The entities mentioned above can either be created via Asset Manager or via the Asset Management API. Getting Started, 07/2018 9
Preparations 3.3 Create an asset Create aspect type To create an aspect type, proceed as follows: 1. In Asset Manager, click on "Aspects". 2. Click on "+". 3. Enter the required data: ID: mcint.pump Note The ID prefix must match your tenant prefix. Name: PumpProperties Description: Pump Aspect (from ) 4. Enter data for variable: Variable Name: StuffingBoxTemp Data Type: STRING Max. Length: 16 Unit: 5. Click on "Add variable". 6. Click on "Save". The result should be similar to the screenshot down below. 10 Getting Started, 07/2018
Preparations 3.3 Create an asset Create asset type To create an asset type, proceed as follows: 1. In Asset Manager click on "Types". 2. Click on "+". 3. Enter the required data: ID: mcint.pumpiotextintegration Name: PumpIoTExtIntegrationType Description: Pump Asset Type (from ) 4. Add aspect type casprm12.pump which you have created previously. 5. Click on "Save". The result should look similar to the following screenshot. Create asset To create an asset, proceed as follows: 1. In Asset Manager click on "Assets". 2. Click on "+". 3. Search for the previously defined asset type PumpIoTExtIntegrationType and click on it. Getting Started, 07/2018 11
Preparations 3.3 Create an asset 4. Enter the required data (only the name is mandatory): Name: PumpIoTAsset Description: Pump Asset (from ) 5. Click on "Save". The result should look similar to the screenshot down below. 12 Getting Started, 07/2018
MindConnect IoT Extension 4 In the Launchpad, click on "MindConnect IoT Extension". In case you do not see the MindConnect IoT Extension symbol in your Launchpad, please check the assigned roles of your user (see chapter MindSphere Launchpad Integration (Page 9)). 4.1 Log in to MindConnect IoT Extension In your Welcome Mail of your purchased IoT Developer Plan you can find the credentials you need to log in to IoT Extension (see chapter Activate MindConnect IoT Extension (Page 9)). 4.2 Assign required roles At first, you use built-in Device Simulator. Therefore, you need the role "Devicemanagement User". Getting Started, 07/2018 13
MindConnect IoT Extension 4.3 Create Device Simulator To get the role "Devicemanagement User", proceed as follows: 1. Go to the User Management area (Administration > User). 2. Add the role "Devicemanagement User" to your user account and click on "Apply". 14 Getting Started, 07/2018
MindConnect IoT Extension 4.3 Create Device Simulator 4.3 Create Device Simulator You will use a device simulator that mimics a real-world device. Getting Started, 07/2018 15
MindConnect IoT Extension 4.3 Create Device Simulator To use a device simulator, proceed as follows: 1. Go to Device Management > Simulators 2. Click on "New simulator". 3. In the "Add simulator" dialog, choose "Temperature measurements" as preset, enter a name for the new simulator, e.g. PumpSimulator, and click on "Continue". The new simulator is created and in a paused state. 4. Activate the simulator by clicking on the toggle button. It switches to the run state. Note You can also create your own simulator by selecting Empty Simulator. 16 Getting Started, 07/2018
MindConnect IoT Extension 4.3 Create Device Simulator You can also see your simulator within the device list. Getting Started, 07/2018 17
MindConnect IoT Extension 4.4 Data Mapping 4.4 Data Mapping You have to define a mapping in order to correlate the device simulators and their measurements to MindSphere assets and their aspects. This can be done manually by "Asset Mapping" provided in the Device Management Application. Go to the Device Management and navigate to "Asset Mapping" in the left upper corner. The main view is separated into two panels: "Navigation" (containing devices and assets) and "Data Mapping". The left side of the navigation panel shows a tree component with all available device groups and devices (Simulators). The right side lists all available assets and childassets of the related MindSphere tenant. The lower panel shows all current data mappings. To create a mapping, proceed as follows: 1. Select a device on the left side of the navigation panel. You can see all mappings of selected device below in the Data Mapping table. 2. Select an asset on the right side of the navigation panel. 3. Click + Add Mapping. (In order to add a new mapping, you have to choose a device and an asset from the lowest level.) 4. Select Source and "Target" in a seperate dialog. 18 Getting Started, 07/2018
MindConnect IoT Extension 4.4 Data Mapping In case of multiple devices and assets, the search text fields for each section can help finding devices or assets on navigation panel. You can clear the selection on the navigation panel by clicking on "Clear Selection". After clicking + Add Mapping, a dialog appears to select the mapping information of the selected device and asset. Getting Started, 07/2018 19
MindConnect IoT Extension 4.4 Data Mapping Now select the required "Source" and "Target" information in the "Add Mapping" dialog: Measurement: Source measurement of IoT Extension (comparable to aspect level) Series: Source series of IoT Extension (comparable to variable level) Aspect: Target aspect of MindSphere Variable: Target variable of MindSphere Clicking on "+ Add" creates a mapping between source and target. You can add more mappings by repeating the steps above. Note Within the mapping the units are not getting checked. At this state the mapping is not committed yet. Mappings have to be committed (published) by clicking on Commit Changes and applying those changes in the confirmation dialog box. This action activates all mappings immediately. 20 Getting Started, 07/2018
MindConnect IoT Extension 4.4 Data Mapping Click on "Previous" or "Next" in order to navigate through the mappings. Edit or delete a mapping by clicking on the "pencil" or "recycle bin" icon. The "undo" functionality enables you to discard changes on a mapping that you didn't commit yet. On the upper right corner you can choose the mappings to be shown: Show all Show mapped only Show unmapped only Getting Started, 07/2018 21
Verify data in Fleet Manager 5 Finally, Fleet Manager shows you the collected time series data. Select the asset and choose "Aspects". The data can be seen on the right side of Fleet Manager (as the values are currently strings, they are displayed in a table instead of a chart). Getting Started, 07/2018 23
Verify data in Fleet Manager 24 Getting Started, 07/2018