~ruther/CTU-FEE-B0B35APO-Semestral-project

ref: 42bce0277ee778e4dbf452779f512152c630619e CTU-FEE-B0B35APO-Semestral-project/lib-pheripherals/include/mzapo_rgb_led.h -rw-r--r-- 2.0 KiB
42bce027 — František Boháček docs: add code documentation 3 years ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
#ifndef __MZAPO_RGB_LED_H__
#define __MZAPO_RGB_LED_H__

#include "display_utils.h"

typedef enum {
  LED_LEFT,
  LED_RIGHT
} mzapo_rgb_leds_t;

#ifdef __cplusplus
extern "C" {
#endif
  typedef struct {
    uint8_t blue;
    uint8_t green;
    uint8_t red;
  } __attribute__((__packed__)) rgb_led_pixel_t;

  typedef struct {
    volatile rgb_led_pixel_t *mem_base;
  } mzapo_rgb_led_t;

  /**
   * @brief Create rgb leds with state
   * 
   * @param mem_base virtual memory address where rgb leds data begin
   * @return mzapo_rgb_led_t 
   */
  mzapo_rgb_led_t rgb_led_create(unsigned char *mem_base);

  /**
   * @brief Set given rgb led to rgb, 000 for turn off
   * 
   * @param rgb_led 
   * @param id what led to change
   * @param r red (min 0, max 255)
   * @param g green (min 0, max 255)
   * @param b blue (min 0, max 255)
   */
  void rgb_led_set(mzapo_rgb_led_t *rgb_led, mzapo_rgb_leds_t id, uint8_t r,
                   uint8_t g, uint8_t b);

  /**
   * @brief Set given rgb led to full red
   * 
   * @param rgb_led 
   * @param id what led to change
   */
  void rgb_led_set_red(mzapo_rgb_led_t *rgb_led, mzapo_rgb_leds_t id);

  /**
   * @brief Set given rgb led to full green
   * 
   * @param rgb_led 
   * @param id what led to change
   */
  void rgb_led_set_green(mzapo_rgb_led_t *rgb_led, mzapo_rgb_leds_t id);

  /**
   * @brief Set given rgb led to full blue
   * 
   * @param rgb_led 
   * @param id what led to change
   */
  void rgb_led_set_blue(mzapo_rgb_led_t *rgb_led, mzapo_rgb_leds_t id);

  /**
   * @brief Get given rgb led color
   * 
   * @param rgb_led 
   * @param id what led to get data from 
   * @return rgb_led_pixel_t 
   */
  rgb_led_pixel_t rgb_led_get(mzapo_rgb_led_t *rgb_led, mzapo_rgb_leds_t id);

  /**
   * @brief Set given rgb led to 0 - turn off
   * 
   * @param rgb_led 
   * @param id what led to change
   */
  void rgb_led_clear(mzapo_rgb_led_t *rgb_led, mzapo_rgb_leds_t id);

#ifdef __cplusplus
} /* extern "C"*/
#endif

#endif // __MZAPO_RGB_LED_H__
Do not follow this link