Bosch XDL120 User Manual

XDL120 | User Manual
1 | 25
Data subj ect t o cha ng e without notice
XDL120: Data Logger/ Data Streamer for XDK110
User Manual
XDK110: Data Logger / Data Streamer: User Manual
Document revision
1.3
Document release date
July 20th, 2018
Workbench version
3.0.0 and above
Document number
BCDS-XDK110-DataLogger-Streamer
Technical reference code(s)
Notes
Data in this document is subject to change without notice. Product photos and pictures are for illustration purposes only and may differ from the real product’s appearance. This document is confidential and under NDA inherent with the purchase of an XDK110.
Advance information – Subject to change without notice
XDL120 | User Manual
2 | 25
Data subj ect t o cha ng e without notice
Table of contents
1 Introduction 4
1.1 Key features of the XDL120 DataLogger/Streamer ..........................................................................................................4
1.2 Components of XDL120 shipment ........................................................................................................................................4
2 Feature details 5
2.1 Accurate logging of sensor samples with timestamps......................................................................................................5
2.2 Global time stamp reference to sensor data.......................................................................................................................5
2.3 Online streaming of sensor samples via WLAN.................................................................................................................5
2.4 Seamless auto-save .................................................................................................................................................................5
2.5 LED indication on application state.......................................................................................................................................5
3 Usage of the XDL120 7
3.1 Prerequisites ..............................................................................................................................................................................7
3.2 Overview .....................................................................................................................................................................................7
3.3 Installing the application on the XDK....................................................................................................................................7
3.4 Installing Python ........................................................................................................................................................................8
3.5 Configuration ..............................................................................................................................................................................9
3.5.1 Sensor configuration 10
3.5.2 System configuration 15
3.5.3 Data transfer configuration 15
3.5.4 Network configuration 15
3.6 Data extraction & conversion .............................................................................................................................................. 16
3.6.1 Data logging 16
3.6.2 Data streaming 18
3.7 Dos and Don’ts ....................................................................................................................................................................... 20
3.8 Known Limitations .................................................................................................................................................................. 20
XDL120 | User Manual
3 | 25
Data subj ect t o cha ng e without notice
4 Data security concept 21
4.1 Introduction .............................................................................................................................................................................. 21
4.2 Stakeholders and Roles ....................................................................................................................................................... 22
4.2.1 XDL user 22
4.2.2 Bosch Connected Devices and Solutions 22
4.3 Physical and Environmental Security ................................................................................................................................ 22
4.3.1 Use Case Scenario 1 (Deployment at private area) 22
4.3.2 Use Case Scenario 2 (Deployment in industry) 22
4.3.3 Use Case Scenario 3 (Deployment in public area) 22
4.4 Asset Management / Media Handling ............................................................................................................................... 22
4.5 Access control......................................................................................................................................................................... 23
4.5.1 Media Handling 23
4.5.2 Access to Networks 24
4.6 Encryption ................................................................................................................................................................................ 24
4.7 Termination of service ........................................................................................................................................................... 24
5 Known Issues 24
6 References 24
XDL120 | User Manual
4 | 25
Data subj ect t o cha ng e without notice
1 Introduction
The Data Logger / Streamer application for Cross -Domain Development Kit XDK110 is intended to extract raw data from the XDK with the highest performance achievable with the build-in sensors, giving the user the ability to acquire reliable, highly accurate data for further analysis. The data are stored locally on the SD card within the device. Alternatively, the data can also be sent to a network computer via WLAN.
1.1 Key features of the XDL120 DataLogger/ Streamer
Easy data acquisition from on-board sensors of XDK (except acoustic noise) with high data rates Customizable: Sensor selection and configuration via xml file, no programming needed Saves data locally on SD card (logging mode) Transmits data continuously via WLAN to a UDP socket (streaming mode) (Enterprise WPA2 option available) Auto save feature with configurable saving frequency MessagePack format for integration in third-party applications Time-equidistant sampling with global time synchronization support with SNTP over WLAN Simply pressing a button starts and stops data logging/streaming
1.2 Components of XDL120 shipment
The following components are part of the XDL120:
Binary files (full version):
o XDL120_Rev1.bin : for XDK with bootloader <v1.0 o XDL120_Rev2.bin : for XDK with bootloader ≥v1.0
Binary files (trial version):
o XDL120_trial_Rev1.bin : for XDK with bootloader <v1.0 o XDL120_trial_Rev2.bin : for XDK with bootloader ≥v1.0
Datalogger.exe (alternative: datalogger.py python script for systems with python3 environment available) config.XML file wlan.TXT file XDL120_tolerance_calculation.xls EULA / Licence text (PDF) User manual (this document)
NOTE
If you are using the trial version of the XDL120, the features and usage as described in this manual are identical to the full version with the exception of the logging time. The trial version only allows for logging of up to 30 minutes per log.
XDL120 | User Manual
5 | 25
Data subj ect t o cha ng e without notice
2 Feature details
2.1 Accurate logging of sensor samples with timestamps
The XDL120 allows logging with high data rates for all on board sensors except the acoustic noise sensor without loss of data, when individual sensors are configured. Data is homogeneously timestamped with millisecond resolution based on the FreeRTOS system time. Table 1 provides a quick overview on the maximum sample rates per sensor. Please be aware that those rates only apply if a single sensor is configured at a time for logging. For multiple sensors, the data rate for the single sensors must be reduced. The value described in the table refer to maximum values achieved in ideal conditions. In real applications, some data might be lost e.g. due to noise on the sensor bus induced by increased temperature, or other factors. In our tests, the data loss exhibited under real life testing conditions were typically in range of <0.5% of the maximum values setting. If data from more than one sensor needs to be logged, it is recommended to reduce the data rate for the individual sensors to minimize data loss. The file XDL120_tolerance_calculation.xls delivered with the XDL120 can help estimate typical data loss when logging several sensors at once.
Table 1: Maximum raw data output of XDK sensors
Sensor
Data rate
BMI 160 – Gyroscope part
3200 Hz
BMI 160 – Acceleration part
1600 Hz
BMM150 – Magnetic field
30 Hz
BMA280 – Acceleration
1000 Hz (corresponds to bandwidth 500 Hz)
BME280 – Temperature, Humidity, Pressure
25 Hz
BMG160 – Gyroscope
1000 Hz (corresponds to bandwidth 500 Hz)
MAX44009 – Light
25 Hz
For further details on sensor parameters, please refer to section 3.5.1
2.2 Global time stamp reference to sensor data
The application allows you to configure an SNTP time server (see Configuration for details) to obtain a global time stamp for your measurement data. The Synchronization is done once on power-on of the XDK. The device will (re-)try to establish a connection up to four times (see Table 2: LED pattern of the XDL120 for details). This feature requires WLAN access. Please make sure to select a time server that is reachable from your local network.
2.3 Online streaming of sensor samples via WLAN
XDL120 allows to stream sensor data live during logging using WLAN, with a focus on high data-rates (see Configuration for details). The data will be sent via UDP to a host within the same network. Due to the nature of the protocol and the RF conditions in the target application, this method cannot guarantee package delivery (packet loss may be possible). Please analyze the time stamp provided to identify lost packages.
2.4 Seamless auto-save
The seamless Auto-save is one of the key feature of the Data Logger / Streamer application. The user can configure the time interval in which to store the logs in separate files when the Data Logger / Streamer application is configured to log data to the SD Card. Based on the time interval configured in the config.xml file, a new log file is created for every time interval. This feature will not interrupt logging and at the same time it saves data. The user can configure the auto-save time interval from 1 min to 24 hours. Given a configuration of 2 min, a new log file will be created every two minutes.
2.5 LED indication on application state
Four LEDs are available on the XDK and each LED except the green LED indicates a specific state of the application. The possible LED patterns and their causes are listed in Table 2.
XDL120 | User Manual
6 | 25
Data subj ect t o cha ng e without notice
Table 2: LED pattern of the XDL120
State Name
LED State
Condition for appearance / State description
Yellow
Orange
Red
Data logger /streamer not ready / No SNTP time stamp acquired
OFF
ON
ON
Data logger / streamer initialization is not completed.
Data logger / streamer ready
OFF
OFF
OFF
Data logger / streamer initialization is completed and ready to log data.
Logging
ON
OFF
OFF
When button 1 pressed, logging starts.
SNTP error
ON -
If logging
state
OFF-
If not in
logging state
Blink -
If a data loss
occurred
OFF -
If no data
loss occurred
ON
When the SNTP server did not send a response (OR)
The application is not able to receive data from server (OR)
WLAN connection could not be established.
Data Loss
ON
Blink
depends on
the
frequency of
the data loss
OFF-
No SNTP error
occurred
ON-
If a SNTP
error occurred
Indicates data loss due to environmental conditions or sub-optimal sensor configuration.
Fatal error
Blink for
every 1sec
Blink for
every 1sec
Blink for every
1sec
When no SD card is inserted. (OR)
Due to an invalid configuration file on the SD card. (OR)
Configuration file contains invalid configuration parameters. (OR)
WLAN is enabled and no WLAN could be established. (OR)
All sensors are disabled in the configuration file.
XDL120 | User Manual
7 | 25
Data subj ect t o cha ng e without notice
3 Usage of the XDL120
3.1 Prerequisites
The following items are needed to use the XDL120:
microSD card for configuration and data storage microSD card reader to write configuration and to retrieve sensor data XDK device with micro USB cable XDK workbench installed on computer Microsoft Windows 7 or greater or Python >= 3.4 with dependencies installed on computer as listed below
3.2 Overview
Figure 1: User interface external view of XDK shows the user interface of the XDK110 device. For more details, please refer to the XDK documentation available at www.xdk.io.
3.3 Installing the application on the XDK
To use the XDK120, the respective binary file has to be installed (“flashed”) onto the XDK device. This is done via the XDK workbench. Information on how to install the XDK workbench is available on the XDK website (www.xdk.io). It is recommended to have a look at the XDK First Steps Guide to get familiar with the workbench. After Installation, follow the description below to flash the binary:
Run the XDK-Workbench.exe application, by default the welcome screen will appear on the opening screen of the
XDK-Workbench.
Figure 1: User interface external view of XDK
XDL120 | User Manual
8 | 25
Data subj ect t o cha ng e without notice
Figure 2: XDK Workbench welcome screen
Click on Click & Go tab, then the default operating view for implementing XDK projects will appear.
Please make sure that the connected XDK is turned on and displayed in the XDK Devices view.
o The name of the XDK device can be changed by right-clicking on the device icon
Drag and drop the correct binary for your bootloader version (XDL120_Rev1.bin or _Rev2.bin) onto the XDK in the XDK
Devices view, e.g. from the explorer window.
o The binary will now be flashed to the XDK
After the binary file was flashed, the XDK will automatically start the flashed application. The XDL120 is now ready to log
and stream sensor data.
3.4 Installing Python
If you cannot use the datalogger.exe to convert the logging files (see section 3.6), Python needs to be installed to run the
datalogger.py script. If you can use the EXE file, you can skip this chapter.
To install and setup python:
Download python version 3.x or higher here: https://www.python.org/downloads/
o If working under windows it is recommended to add the Python installation to the system's path.
Instructions can be found here: http://stackoverflow.com/questions/6318156/adding-python-path-on-
windows-7
o Note: If this is not possible, the python script can still be used. However, python script must be called from
its installation directory
Download py-serial here: https://pypi.python.org/pypi/pyserial (File: pyserial-3.3-py2.py3-none-any.whl (md5)). Install py-serial with the following command: python -m pip install pyserial-3.3-py2.py3-none-any.whl.
Figure 3: XDK data logger debug/flash & reboot options in workbench
Loading...
+ 17 hidden pages