Parameter definitions for mapping peripherals directly to SAUL. More...
Detailed Description
Parameter definitions for mapping peripherals directly to SAUL.
Definition in file periph.h.
Include dependency graph for periph.h: This graph shows which files directly or indirectly include this file:Go to the source code of this file.
Data Structures | |
| struct | saul_gpio_params_t |
| Direct mapped GPIO configuration values. More... | |
| struct | saul_adc_params_t |
| Direct mapped ADC configuration values. More... | |
| struct | saul_pwm_channel_t |
| Single PWM channel exposed via SAUL. More... | |
| struct | saul_pwm_dimmer_params_t |
| PWM channels mapped to dimmer-style registration entries. More... | |
| struct | saul_pwm_rgb_params_t |
| PWM channels mapped to RGB LED registration entries. More... | |
| #define | SAUL_PWM_FREQ_DEFAULT 1000 |
| Default value for SAUL_PWM_FREQ. | |
| #define | SAUL_PWM_FREQ SAUL_PWM_FREQ_DEFAULT |
| Define the PWM frequency for LEDs. More... | |
| #define | SAUL_PWM_NO_DIMMER |
| Suppress saul_pwm's dimmer generation. More... | |
| #define | SAUL_PWM_NO_RGB |
| Suppress saul_pwm's RGB LED generation. More... | |
| enum | saul_gpio_flags_t { SAUL_GPIO_INVERTED = (1 << 0) , SAUL_GPIO_INIT_CLEAR = (1 << 1) , SAUL_GPIO_INIT_SET = (1 << 2) } |
| SAUL GPIO configuration flags. More... | |
| enum | saul_pwm_flags_t { SAUL_PWM_REGULAR = (0 << 0) , SAUL_PWM_INVERTED = (1 << 0) } |
| SAUL PWM parameters. More... | |
| static const uint16_t | saul_pwm_resolution = 255 |
| Resolution of SAUL mapped PWMs. | |
Macro Definition Documentation
◆ SAUL_PWM_FREQ
| #define SAUL_PWM_FREQ SAUL_PWM_FREQ_DEFAULT |
Define the PWM frequency for LEDs.
This frequency is requested from the PWM driver. As the per pwm_init, the actual frequency may be lower, and the SAUL wrapper does not place a limit there.
Frequencies of above 200Hz usually give a smooth visual experience. The higher 1kHz is picked as a default as some devices can't go that low with their timer.
This is typically set in the board's pwm_params.h.
◆ SAUL_PWM_NO_DIMMER
| #define SAUL_PWM_NO_DIMMER |
Suppress saul_pwm's dimmer generation.
This can be defined in pwm_params.h if the saul_pwm module is used, but no dimmers (and only RGB LEDs) are in use. Then, no saul_pwm_dimmer_params needs to be set.
◆ SAUL_PWM_NO_RGB
| #define SAUL_PWM_NO_RGB |
Suppress saul_pwm's RGB LED generation.
This can be defined in pwm_params.h if the saul_pwm module is used, but no RGB LEDs (and only dimmers) are in use. Then, no saul_pwm_rgb_params_t needs to be set.
Enumeration Type Documentation
◆ saul_gpio_flags_t
| enum saul_gpio_flags_t |
◆ saul_pwm_flags_t
| enum saul_pwm_flags_t |
