led.h

Go to the documentation of this file.

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

// TYPES

#define HW_LED_CTX_SIZE 64 


typedef struct {
  uint8_t gpio;  
  hw_pwm_t *pwm; 
  uint8_t ctx[HW_LED_CTX_SIZE]; 
} hw_led_t;

typedef enum {
  HW_LED_CAP_NONE = 0,          
  HW_LED_CAP_BINARY = (1 << 0), 
  HW_LED_CAP_LINEAR = (1 << 1), 
  HW_LED_CAP_GPIO = (1 << 2),   
} hw_led_cap_t;

// LIFECYCLE

hw_led_t hw_led_init(uint8_t gpio, hw_pwm_t *pwm);

uint8_t hw_led_status_gpio();

void hw_led_finalize(hw_led_t *led);

// METHODS

bool hw_led_valid(hw_led_t *led);

hw_led_cap_t hw_led_capabilities(hw_led_t *led);

bool hw_led_set_state(hw_led_t *led, bool on);

bool hw_led_set_brightness(hw_led_t *led, uint8_t brightness);

bool hw_led_blink(hw_led_t *led, uint32_t period_ms, bool repeats);

bool hw_led_fade(hw_led_t *led, uint32_t period_ms, bool repeats);