Skip to content

Device Management

Overview

This section covers the following use cases:

Add a new source device

Prerequiste

A device of the same Model, of which you would like to add additional devices, is already fully configured on the Device Hub. If you want to add a new device Model, please contact Leitwert support.

If the devices are already registered on the Device Hub, jump to step 5 below. Otherwise, proceed with step 1.

  1. Register your new device in the Device section of the Device application by clicking on the + Device button.
    add_device
  2. Choose the corresponding Product and Model from the dropdown menu and enter the Bluetooth MAC address of the devices as Device ID. You can add multiple devices at the same time using a comma-separated list. Alternatively, click the Advanced tab at the top of the screen to directly enter the device Name together with each Device ID. Click the Save button for the changes to take effect.
    add_device_2
  3. In the Device section of the Device application, chose an already configured device of the same Model from the device list and open its detail view by clicking on the corresponding row.
  4. In the tab Device Settings click the button Apply to other devices for the first setting, and select the newly registered devices from the list. Click the Apply button. Repeat for every setting of that device.
    appy_to_other_devices
  5. Open the Source Devices section in the Data application and click the + Device button to add the newly registered devices as source devices for data capture. You need to choose the related Model from the dropdown menu and enter the device IDs (Bluetooth MAC address). You can enter multiple device IDs at the same time using a comma-separated list. Click the Save button.
    add_source_device

Info

After completing the steps above, device events will be stored in the event database. To automatically forward all events to the time-series database, the corresponding configuration must be updated by Leitwert. This can be done retrospectively as well. Please contact Leitwert support to request this.

Assign a source device to a gateway

A Leitwert gateway only connects with devices, which have been assigned to it on the Device Hub.

You can do this as follows:

  1. Navigate to the Source Devices section in the Data application. Filter the source device list for gateways either by using the name search or by selecting the related model from the dropdown menu. Chose the gateway from the list, to which you would like to assign a device. This will open the gateway detail view, which is depicted below. There, open the tab for the device type you would like to add (e.g. MMT Devices as depicted below).
  2. From the list of related devices, select the ones you would like to add to this gateway. Selected devices will be marked with a green check mark. If a device can't be selected, it is already assigned to another gateway and does not allow multiple assignments. In that case, you first need to un-assign it from the other gateway.
  3. If you want to add many devices, you can do this efficiently with the button Select all. If you want to assign all devices to all gateways, follow below Tipp.

Tipp

To assign all devices of a certain model to all gateways, it is more efficient to do the following:
1) Complete above steps one to three for one gateway.
2) Open the device settings of that gateway by navigating to the Device application, then section Devices, filtering for product Gateway and clicking on the specific gateway in the list.
3) For the setting with the Key "device-plugin-(device model)", whereas (device model) is the name of the device model you want to assign, click on the button Apply to other devices and click on select all and save to apply the same settings to all other gateways.

add_device_to_gateway Add a device to a gateway

Find last gateway a device connected with

find gateway 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"
    find gateway step 1 detail

find gateway step 2

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

Note

If the device is currently connected, you can switch on "Auto Refresh" so new incoming messages will be displayed automatically.

  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 find gateway step 3

Note

"wearables-bt-gw-monitoring0007-xxxxxxxxx" corresponds to "GW 07 - smartAF"

Check device states

To check a device state, navigate to the Source Devices section in the Data application. Filter the list of source devices either by using the name search or by selecting a specific device model from the dropdown menu. Then, select the device, for which you would like to see the device state.

Note

There is different information displayed depending on whether a device is a gateway or not.

Standard device state

For devices that are not gateways, the following information is available:

  • Last Attempt: The last time the gateway tried to access the device.
  • Reconfiguration Time: The last time when settings have been applied to the device.
  • Last Sync: The time up to which all data has been retrieved from the device.
  • Last Connection: Time when the last connection has been successfully established between a gateway and the device.
  • Other fields can be configured depending on the device.

device_state Information about the state of a standard device

Gateway state

For gateways, the following information is available:

  • Last Health Check: Last time the gateway sent a health check.
  • Last Update Check: Last time the gateway checked for a firmware update.
  • IP Address: IP address of the gateway in its current network.
  • WiFi MAC Address: WiFi MAC address to which the gateway is currently connected.
  • WiFi Frequency: The WiFi frequency over which the gateway is currently communicating.
  • Hardware Info: Detailed name of the hardware model and version of the gateway.

gateway_state Information about the state of a Leitwert gateway

Visualize device data

Data from the Event Log can be visualized in the User Interface using the Data Explorer. For the generic view, navigate to the Data app and there to the Data Expolorer section.

Note

If you access the Data Explorer via the detail view of a Monitoring Tile, Device or Participant, then it will use preconfigured settings for the related Device and Data Templates, which can't be changed as described in step 1 below.

  1. Click Selection to select a device from the device list, for which you would like to visualize the data. Then select the data template from the Templates drop down menu. Lastly, select a date, for which you would like to visualize the data from that device.
  2. If the graph does not load automatically - or if you would like to refresh the graph - click Refresh Data Source.
  3. You can export the visualized data as CSV or HDF5 file. Click the Refresh CSV Export or Refresh HDF5 Export button, respectively. After the data was processed, which can take a while, the Download CSV Export or Download HDF5 Export button will appear.
    export_csv
  4. The legend shows in which color the parameters are displayed in the graph. You can remove a parameter from the graph by clicking on the colored square next to it. By clicking the colored square again, you can reverse that.
  5. Zoom in to a specific section in the graph by marking that section with your mouse (click-and-drag)
  6. The grey marked section in the smaller graph below shows you which part of the overall graph you are currently viewing. You can navigate the graph an zoom back out by selecting a different section with your mouse (click-and-drag)

Note

If multiple data templates are selected, you will see two rows of refresh buttons corresponding to each data template. The graphs related to both data templates will be overlaid in the same graphic as depicted below.

data_explorer Visualize data in the Data Explorer

Export device data

Note

This feature is currently only available on instances running the new Device Hub architecture. If you would like to know more, please contact Leitwert support.
- You can only download the data for one device at the time.
- The time frame is limited to 100 days by default to prevent overly long waiting times and protect server resources.
- The download file will stay available for download for 1 day.

The most efficient way to export device data is via the Device Hub API. You can find example Python scripts here.

If you would like to export data without requiring any programming know-how, you can use the data export form available in the Study application (see picture below).

export_data_ui
Data export form

  1. Enter the Device UUID of the device, with which the data you would like to export was measured. You can copy the Device UUID of a device with the corresponding button in the Source Device list. copy_device_uuid
  2. Enter the Stream ID for the data you would like to export. The Stream ID is defined by the device's communication protocol. If you don't know the stream ID's of your devices, please contact Leitwert support.
  3. Enter the start time from when you would like to export the data.
  4. Enter the end time until when you would like to export the data. By default, the maximum time frame allowed for export is 100 days.
  5. Click the Start Export button. The application will start to build the CSV file with your requested data and display "Export in progress".
    export_progress
  6. While the export is in progress, you can leave the Data Export page and come back later. Wait until the display shows "Export ready".
    export_ready
  7. Once available, click the Download button to download your CSV file. If your browser was not yet authorized to access the data API, it will ask you for authentication. If you do not know the password for API authentication, please contact Leitwert support. api_authentication
  8. After authentication, the CSV file will be downloaded by your browser.
Last update: 2023-05-04