caffeine-sal 0.1.17
Header-only polymorphic middleware services layer for the Caffeine Framework
Loading...
Searching...
No Matches
Data Fields
cfn_sal_dev_led_api_s Struct Reference

LED Virtual Method Table (VMT). More...

#include <cfn_sal_dev_led.h>

Data Fields

cfn_hal_api_base_t base
 
cfn_hal_error_code_t(* set_state )(cfn_sal_dev_led_t *driver, cfn_sal_dev_led_state_t state)
 
cfn_hal_error_code_t(* get_state )(cfn_sal_dev_led_t *driver, cfn_sal_dev_led_state_t *state_out)
 
cfn_hal_error_code_t(* toggle )(cfn_sal_dev_led_t *driver)
 
cfn_hal_error_code_t(* set_brightness )(cfn_sal_dev_led_t *driver, uint8_t percent)
 
cfn_hal_error_code_t(* get_brightness )(cfn_sal_dev_led_t *driver, uint8_t *percent_out)
 
cfn_hal_error_code_t(* set_color )(cfn_sal_dev_led_t *driver, cfn_sal_dev_led_color_t color)
 
cfn_hal_error_code_t(* blink_start )(cfn_sal_dev_led_t *driver, uint32_t period_ms)
 
cfn_hal_error_code_t(* blink_stop )(cfn_sal_dev_led_t *driver)
 
cfn_hal_error_code_t(* set_blink )(cfn_sal_dev_led_t *driver, uint32_t interval_ms, uint32_t count)
 

Detailed Description

LED Virtual Method Table (VMT).

Field Documentation

◆ base

cfn_hal_api_base_t cfn_sal_dev_led_api_s::base

◆ blink_start

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::blink_start) (cfn_sal_dev_led_t *driver, uint32_t period_ms)

◆ blink_stop

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::blink_stop) (cfn_sal_dev_led_t *driver)

◆ get_brightness

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::get_brightness) (cfn_sal_dev_led_t *driver, uint8_t *percent_out)

◆ get_state

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::get_state) (cfn_sal_dev_led_t *driver, cfn_sal_dev_led_state_t *state_out)

◆ set_blink

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::set_blink) (cfn_sal_dev_led_t *driver, uint32_t interval_ms, uint32_t count)

◆ set_brightness

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::set_brightness) (cfn_sal_dev_led_t *driver, uint8_t percent)

◆ set_color

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::set_color) (cfn_sal_dev_led_t *driver, cfn_sal_dev_led_color_t color)

◆ set_state

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::set_state) (cfn_sal_dev_led_t *driver, cfn_sal_dev_led_state_t state)

◆ toggle

cfn_hal_error_code_t(* cfn_sal_dev_led_api_s::toggle) (cfn_sal_dev_led_t *driver)

The documentation for this struct was generated from the following file: