led.h

Go to the documentation of this file.

#pragma once
#include "gpio.h"
#include "pwm.h"
#include <stdint.h>

// CONSTANTS

#define HW_LED_GPIO_NONE 0xFFu

#ifndef HW_LED_POOL_CAPACITY
#define HW_LED_POOL_CAPACITY 8u
#endif

#ifndef HW_LED_CONTEXT_SIZE
#define HW_LED_CONTEXT_SIZE 32
#endif

// TYPES

typedef enum {
  hw_led_type_none = 0, 
  hw_led_type_wifi,     
  hw_led_type_neopixel, 
  hw_led_type_gpio,     
  hw_led_type_pwm,      
} hw_led_type_t;

typedef struct hw_led_t hw_led_t;

// LIFECYCLE

hw_led_t *hw_led_init_gpio(hw_gpio_t *gpio);

hw_led_t *hw_led_init_neopixel(hw_gpio_t *gpio, uint8_t led_count);

hw_led_t *hw_led_init_wifi(void);

hw_led_t *hw_led_init_pwm(hw_pwm_t *pwm);

hw_led_t *hw_led_init_device(const char *name);

hw_led_t *hw_led_init_default(void);

void hw_led_deinit(hw_led_t *led);

// PROPERTIES

uint8_t hw_led_gpio_default(hw_led_type_t *out_type, uint8_t *out_count);

// METHODS

bool hw_led_set(hw_led_t *led, uint8_t index, bool enabled);

bool hw_led_set_brightness(hw_led_t *led, uint8_t index, float percent);

bool hw_led_clear(hw_led_t *led);

bool hw_led_blink(hw_led_t *led, uint8_t index, uint32_t period_ms,
                  bool repeating);