Spin API is an entry point to access APIs and peripheral HALs dedicated for interaction with the Spin board

To work with Spin API, include the following file in your code:

Note

#include <SpinAPI.h>

Detailed documentation on available API classes:

Detailed documentation on Hardware Abstraction Layer classes:

ClassList > SpinAPI

Contains all the elements linked to peripherals of the spin board.

Type	Name
CompHAL	comp Contains all the function of the STM32 comparator used with the current mode.
DacHAL	dac Contains all the function of the STM32 DAC used to generate signals and handle the current mode.
DataAPI	data Data acquisition from SPIN ADCs.
GpioHAL	gpio Contains all the functions for the spin gpio.
LedHAL	led Contains all the function of the embedded LED.
PwmHAL	pwm Contains all the function of the STM32 hrtim PWM generator.
TimerHAL	timer Contains all the function of the STM32 Timer4 functions that handle the encoder.
UartHAL	uart Contains all the function of the STM32 Usart1 functions.

Contains all the function of the STM32 comparator used with the current mode.

CompHAL SpinAPI::comp;

Contains all the function of the STM32 DAC used to generate signals and handle the current mode.

DacHAL SpinAPI::dac;

Data acquisition from SPIN ADCs.

DataAPI SpinAPI::data;

Contains all the functions for the spin gpio.

GpioHAL SpinAPI::gpio;

Contains all the function of the embedded LED.

LedHAL SpinAPI::led;

Contains all the function of the STM32 hrtim PWM generator.

PwmHAL SpinAPI::pwm;

Contains all the function of the STM32 Timer4 functions that handle the encoder.

TimerHAL SpinAPI::timer;

Contains all the function of the STM32 Usart1 functions.

UartHAL SpinAPI::uart;

The documentation for this class was generated from the following file docs/core/zephyr/modules/owntech_spin_api/zephyr/public_api/SpinAPI.h