Instructions¶

Overview¶

In this tutorial, we cover several use-cases:

• Create a new participant
• Create a new device assignment
• End a device assignment
• Edit a device assignment
• Visualize participant data
• Visualize device data
• Check to which gateway a device was last connected

It takes 5-10 minutes to go through the tutorial.

Participants List¶

The participants list allows you to perform the following actions:

1. Add a new participant (see section "Create a new participant" below)
2. Search for participants using the search field
3. Sort participants according to their state (Active = ongoing device assignment, Inactive = no ongoing device assignment)
4. Change the number of participants displayed per page
5. Check the time and date of the last available data for a participant
6. Open the Detail view for a participant to create or edit device assignments (see corresponding sections below)
7. Copy the participant ID
8. Open the Data Dashboard for a participant (see section "visualize participant data" below)

Source Devices List¶

The source devices list allows you to perform the following actions:

1. Search the source devices based on device name or device ID
2. Change the number of devices displayed per page
3. Check for the currently assigned participant ID
4. Check for the last available data for a device
5. Check the battery status. By hovering over the battery icon, you see additional information about the charging state.
6. Open the device detail view in the Data application
7. Copy the device UUID
8. Open the Data Dashboard for a device (see section "visualize device data" below)

Create a new participant¶

Go to the Participants list and click the button Add Participant.

Enter the participant ID in the field PID and click the save button. If the participant ID does already exist, you will get the error "Participant with ID xy already exists" and need to choose a different ID.

After saving, you will directly see the Device Assignment tab in the participant detail view and can proceed with the next step "create a new assignment" below.

Create a new device assignment¶

To open the Device Assignment tab for a participant, go to the Participants list and open the detail view of a participant by directly clicking on the row in the list or on the information button in the Actions column.

Click the button Add Device Assignment

Fill in the device assignment form as displayed below:

1. Choose the start time of the assignment. You can leave the End Time field free to define it later or already pre-define it upfront.
2. You can search for a device name or device ID in the list of available devices.
3. To ensure a device is ready to be assigned, you can check its status by hovering over the battery symbol.
4. Click the checkbox for the device you want to assign. The chosen device is marked by a green checkmark.
5. Click the Save button

End a device assignment¶

There are two ways to end a device assignment:

1. First option is to click the End Now button for the assignment you want to end in the participant detail view. A dialogue box will pop up, in which you need to confirm your choice.
2. Second option is to edit an assignment by entering a new end date (see section "edit a device assignment" below)

Edit a device assignment¶

You can edit a device assignment by clicking directly on the corresponding row in the Device Assignments tab of the participant's Detail view or by clicking on the information button at the end of that same row.

In the edit assignment form, you have the following options:

1. Change Start Time and/or End Time of the assignment
2. Swap the device to a different one that is available within the defined time
3. Delete the assignment

Visualize participant data¶

To open the data dashboard for a participant, click on the Open Data Dashboard button in the Participants list.

This opens a new tab in your browser with the participant dashboard in Grafana:

1. The time range can be selected in the top right corner. If you choose a long time range, it can take a while for the graph to load.
2. The participant_id can be selected from the dropdown to show the data of a different participant.
3. The interval controls how smooth the graph is. Change it to 1ms if you want to display all the data-points but be aware, that this will increase the loading time accordingly. This is therefore best used for shorter time frames.
4. You can zoom into the graph by selecting a range in the graph while holding down the left mouse button, and zoom out again using the magnifying lens icon in the top right corner.

Visualize device data¶

To open the data dashboard for a device, click the Open Data Dashboard button in the Source Devices list.

This opens a new tab in your browser with the device dashboard in Grafana:

1. The time range can be selected in the top right corner. If you choose a long time range, it can take a while for the graph to load.
2. The device_id can be selected from the dropdown to show the data of a different device. Devices are identified with their UUID. If you do not know the UUID of the device you want, then the fastest way is to go back to the Source Devices list and use the Open Data Dashborad button for the other device.
3. The interval controls how smooth the graph is. Change it to 1ms if you want to display all the data-points but be aware, that this will increase the loading time accordingly. This is therefore best used for shorter time frames.
4. You can zoom into the graph by selecting a range in the graph while holding down the left mouse button, and zoom out again using the magnifying lens icon in the top right corner.

Preventicus Sync¶

• The participant data will be synced with Preventicus every 5 minutes
• To trigger an immediate sync, use the POST /synchronize API in the study-preventicus swagger UI (url https://<devicehub-host>/study-preventicus/docs/)

Find out which gateway a device was last connected to¶

Step 1¶

1. Open the Data App
2. Select the Model (Basler-Band) and enter the name of the device
3. Press the "Detail" ⓘ button below "Aktionen"
   

Step 2¶

1. Open the "Device History" tab
2. Click the "Copy" button from a "device-data" Event Type

Step 3¶

1. Paste the message into a text editor (on Windows e.g. use the "editor" programm or on MacOS the "text edit")
2. You will see the ID of the Gateway this message was sent through