Unlock Your Data: A Deep Dive into STMicroelectronics' STDATALOG-PYSDK

Are you struggling to efficiently capture, process, and visualize data from your sensors, algorithms, or actuators? The STMicroelectronics STDATALOG-PYSDK offers a powerful, open-source solution for data logging, streamlining your workflow and maximizing data insights. This article will guide you through the SDK's features, installation, and give you practical examples to boost your data science projects.

What is STDATALOG-PYSDK?

The STDATALOG-PYSDK is a Python software development kit (SDK) designed for data logging and processing from various sources. Whether you're working with sensors, simulated signals, or actuator telemetries, this SDK provides a comprehensive framework. Specifically designed for data scientists and embedded designers, its modular architecture allows for easy customization and integration.

Comprehensive Framework: Capture, process, and visualize data seamlessly.
Open and Modular Architecture: Customize and extend the SDK to fit your specific needs.
Cross-Platform Compatibility: Works with Windows, Linux, and macOS.

Key Features & Benefits

This Python SDK simplifies the creation, elaboration, and organization of data into structured datasets, fully compatible with popular data science tools. This ensures reusability across multiple projects while also promoting seamless integration into your existing data science workflows.

Easy Data Handling: Streamline data organization into structured datasets
Broad Compatibility Compatible with mainstream data science toolchains.
Effortless Integration Easily integrates into data science designs

Getting Started: Installation Guide

Ready to dive in? Here's how to install the STDATALOG-PYSDK on your system. The SDK supports Python 3.10, 3.11, and 3.12. Before starting, ensure you have Python installed on your machine.

Cloning the Repository

First, clone the repository using the following command, making sure to include the --recursive option to fetch all necessary submodules:

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

To update an existing repository:

git pull
git submodule update --init --recursive

To clone a specific version:

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

The --depth 1 option is optional and skips downloading previous commits.

Setting up a Virtual Environment

Creating a virtual environment is highly recommended to isolate your project dependencies.

python -m venv .venv

Installation on Windows

Activate the virtual environment:
```
. .venv\Scripts\activate
```

Run the installer:

. \STDATALOG-PYSDK_install.bat

If you're behind a proxy:

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

Installation on Linux

Activate the virtual environment:

source .venv/bin/activate

Reformat the files using dos2unix to handle windows based formatting in Linux environments.

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
./STDATALOG-PYSDK_install.sh
./linux_setup/linux_USB_config_setup.sh

Launch the installer:

./STDATALOG-PYSDK_install.sh

If you're behind a proxy:

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

Install 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 your PC.

Installation on macOS

Install Homebrew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Activate the virtual environment:
```
source .venv/bin/activate
```

Install dos2unix:

brew install dos2unix
dos2unix STDATALOG-PYSDK_install.sh STDATALOG-PYSDK_install_noGUI.sh STDATALOG-PYSDK_uninstall.sh
chmod +x STDATALOG-PYSDK_install.sh STDATALOG-PYSDK_install_noGUI.sh STDATALOG-PYSDK_uninstall.sh

Run the installer:

./STDATALOG-PYSDK_install.sh

If you're behind a proxy:

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

Running Example Scripts

After installation, explore the example scripts:

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

Supported Devices

The STDATALOG-PYSDK supports a wide array of STMicroelectronics devices and boards, including:

STEVAL-STWINBX1
STEVAL-STWINKT1B
STEVAL-MKBOXPRO
B-U585I-IOT02A
X-NUCLEO-IKS02A1 with NUCLEO-U575ZI-Q
EVLSPIN32G4-ACT

Refer to the documentation for a complete list of supported devices.

Known Limitations

macOS support starts from v1.1.0.
Python 3.13 is not officially supported.

Take Control of Your Data Today

The STDATALOG-PYSDK provides a robust and versatile platform for your data logging needs. By leveraging its modular design and compatibility with standard data science tools, you can accelerate your development process and gain deeper insights from your data. Start exploring the STDATALOG-PYSDK today and transform the way you work with sensor data.