Installation

This software package (FreiStat-Framework) consists out of two different components:

• Microcontroller Software : Repository needs to be downloaded manually
• Python Framework : Can be directly installed with all the requirements via the setup.py

Microcontroller Software

When installing the software on the microcontroller, a define in a sub library needs to be adjusted. For this, execute the following steps:

• Download the library files (ad5940.c and ad5940.h) with for example the external library installer of the Ardunio IDE.
• Open FreiStat/src/ad5940_FreiStat/ad5940_library_extension
• Navigate to the definition of the ad5940.h
• Select the chip you are using by uncommenting the respective line in the ad5940.h

/**
 * Select the correct chip.
 * Recommend to define this in your compiler.
 * */
//#define CHIPSEL_M355      /**< ADuCM355 */
#define CHIPSEL_594X      /**< AD5940 or AD5941 */

Beside this requirement different external libraries are required, depending on the chosen mode of operation. All these libraries can be installed via for example the Arduino IDE.

FreiStat-USB

The serial USB mode is the classical way of operation for laboratory or short distance setups.

Additional libraries:

• None

FreiStat-WiFi

The WiFi mode allows for long distance setups, by using UDP connection to transmit the data to a specified IP and port.

Additional libraries:

• SD Library
• WiFi101 Library

FreiStat-Standalone

The Standalone mode uses an OLED-display in combination with the default values on the microcontroller to execute measurements, without requiring a computer. The data is directly stored as .csv-file on the SD-card.

Additional libraries:

• SD Library
• Adafruit GFX Library
• Adafruit SSD1306 Library

After these steps are done, the software can be flashed onto the microcontroller and the FreiStat is ready for operation.

Python Framework

When the software is installed via the setup.py and pip install, all requirements are installed automatically. These requirements include the following external packages:

• Matplotlib
• Numpy
• Pyserial

Validation of the installation

The installation of the Framework was validated on Windows 10 using the following versions of the software components:

• V1.0.0 - FreiStat-Framework
• V3.3.4 - Matplotlib
• V1.20.1 - Numpy
• V3.5 - Pyserial
• V1.8.13 - Arduino IDE
• V1.10.12- Adafruit GFX Library
• V2.4.6 - Adafruit SSD1306 Library
• V1.2.4 - SD Library
• V0.16.1 - WiFi101 Library