STDATALOG-PYSDK Python software development kit (SDK) for data logging

The STDATALOG_PYSDK is a comprehensive Python framework designed to facilitate the capture, processing, and visualization of data from a wide range of sources, including sensors, algorithms, simulated signals, and telemetries from actuators.

This software development kit is designed with an open and modular architecture, making it an excellent resource for data scientists and embedded designers. STDATALOG-PYSDK has been developed in Python 3.12, but it is also compatible with Python 3.11 and 3.10.

It provides a range of tools and utilities designed to simplify the development of applications that use data from ST system solutions.

It includes Python scripts to create, elaborate, and organize data into structured datasets. These datasets are compatible with mainstream data science toolchains, promoting reusability across multiple projects. Additionally, the scripts can be easily integrated into any data science design workflow.

It was formerly known as HSDPython_SDK, previously distributed in FP-SNS-DATALOG1, FP-SNS-DATALOG2, and FP-IND-DATALOGMC function packs.

Here is the list of references to user documents:

• DB5446 : Python software development kit (SDK) for data logging: complete toolkit with extensive examples for developers.

How to use

This repository has been created using the git submodule command. Please check the instructions below for proper use. Please check also the notes at the end of this section for further information.

1. To clone this repository along with the linked submodules, option --recursive has to be specified as shown below.

git clone --recursive https://github.com/STMicroelectronics/stdatalog-pysdk.git

2. To get the latest updates, in case this repository is already on your local machine, issue the following two commands (with this repository as the current working directory).

git pull
git submodule update --init --recursive

3. To clone a specific version issue the command below after specifying the targeted vX.Y.Z version.

git clone --recursive  --depth 1 --branch vX.Y.Z https://github.com/STMicroelectronics/stdatalog-pysdk.git

Note

• Option --depth 1 specified in instruction (3) above is not mandatory. It may be useful to skip downloading all previous commits up to the one corresponding to the targeted version.
• If GitHub "Download ZIP" option is used instead of the git clone command, then the different submodules have to be collected and added manually.

How to install STDATALOG-PYSDK

The STDATALOG-PYSDK provides installer scripts that can be used to properly install the SDK and all the required dependencies. STDATALOG-PYSDK has been developed in Python 3.12, but it is compatible also with Python 3.11 and 3.10. To properly use it, Python must be already installed on the machine before proceeding with the following procedure.

It is recommended to use a clean virtual environment for configuration. Navigate to the STDATALOG-PYSDK root directory, open a terminal, and run:

# Create the new virtual environment
python -m venv .venv

This command will create a new directory named .venv in your project root. This directory will contain a clean Python environment with its own installation of Python and pip.

Using a virtual environment is highly recommended because it allows you to create an isolated environment for your project. This isolation ensures that the dependencies and packages required for your project do not interfere with those of other projects or the system-wide Python installation. It helps in maintaining a clean and manageable development environment, avoiding potential conflicts between different package versions, and making it easier to reproduce and share your project setup with others.

On Windows

Open a terminal from STDATALOG-PYSDK folder and activate the virtual environment.

.\.venv\Scripts\activate

Launch the installer, the script will install the SDK with the required dependencies.

.\STDATALOG-PYSDK_install.bat

If you are behind a proxy server, you must specify it in the command, if you have special characters in your password, you will have to replace them with their corresponding hex representation. E.g., '&' --> %26.

.\STDATALOG-PYSDK_install.bat http://usr_name:password@proxyserver_name:port

When the installation is completed you can try one of the example scripts.

cd stdatalog_examples
python.exe gui_applications/stdatalog/GUI/stdatalog_GUI.py

On Linux

Open a terminal from STDATALOG-PYSDK folder and activate the virtual environment.

./.venv/bin/activate

• The SDK has been built in a Windows environment. To avoid any possible issues while executing the script in a Linux environment, we suggest you use dos2unix to reformat the files properly.

sudo apt-get install dos2unix
dos2unix STDATALOG-PYSDK_install.sh STDATALOG-PYSDK_install_noGUI.sh STDATALOG-PYSDK_uninstall.sh
chmod 777 STDATALOG-PYSDK_install.sh STDATALOG-PYSDK_install_noGUI.sh STDATALOG-PYSDK_uninstall.sh

Launch the installer, the script will install the SDK with the required dependencies.

./STDATALOG-PYSDK_install.sh

If you are behind a proxy server, you must specify it in the command, if you have special characters in your password, you will have to replace them with their corresponding hex representation. E.g., '&' --> %26.

./STDATALOG-PYSDK_install.sh http://usr_name:password@proxyserver_name:port

Install the required USB drivers

cd linux_setup
dos2unix 30-hsdatalog.rules linux_USB_config_setup.sh linux_USB_config_removal.sh
chmod 777 linux_USB_config_setup.sh linux_USB_config_removal.sh
./linux_USB_config_setup.sh

Reboot the PC to be sure the new USB udev rules are loaded correctly.

Open a terminal from STDATALOG-PYSDK folder and try one of the example scripts.

./.venv/bin/activate
cd stdatalog_examples
python3 gui_applications/stdatalog/GUI/stdatalog_GUI.py

Known Limitations

• STDATALOG-PYSDK is available for Windows and Linux OS only. MacOS is not supported.
• Python 3.13 is not officially supported.

Development Toolchains and Compilers

• Python 3.12, 3.11, 3.10

Supported Devices and Boards

• All devices and boards supported by FP-SNS-DATALOG1, FP-SNS-DATALOG2 and FP-IND-DATALOGMC
• STEVAL-STWINBX1
• STEVAL-STWINKT1B
• STEVAL-MKBOXPRO
• STEVAL-PDETECT1
• STEVAL-C34KAT1
• STEVAL-C34KAT2
• STEVAL-C34KPM1
• B-U585I-IOT02A
• X-NUCLEO-IKS02A1 with NUCLEO-U575ZI-Q
• X-NUCLEO-IKS02A1 with NUCLEO-H7A3ZI-Q
• EVLSPIN32G4-ACT

Backward Compatibility

• None

Dependencies

• None