Blame view

RIOT/drivers/include/rgbled.h 1.49 KB
fb11e647   vrobic   reseau statique a...
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
  /*
   * Copyright (C) 2014 Freie Universitรคt Berlin
   *
   * This file is subject to the terms and conditions of the GNU Lesser General
   * Public License v2.1. See the file LICENSE in the top level directory for more
   * details.
   */
  
  /**
   * @defgroup    driver_rgbled RGB-LED driver
   * @ingroup     drivers_actuators
   * @brief       High-level driver for RGB-LEDs
   * @{
   *
   * @file
   * @brief       High-level driver for easy handling of RGB-LEDs
   *
   * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
   */
  
  #ifndef RGBLED_H
  #define RGBLED_H
  
  #include "color.h"
  #include "periph/pwm.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief Descriptor struct for rgbleds
   */
  typedef struct {
      pwm_t device;
      int channel_r;
      int channel_g;
      int channel_b;
  } rgbled_t;
  
  
  /**
   * @brief Initialize the RGB LED by assigning PWM channels to colors
   *
   * @param[in] led           Struct identifying the LED
   * @param[in] pwm           PWM device to drive the LED
   * @param[in] channel_r     PWM channel connected to red
   * @param[in] channel_g     PWM channel connected to green
   * @param[in] channel_b     PWM channel connected to blue
   */
  void rgbled_init(rgbled_t *led, pwm_t pwm, int channel_r, int channel_g, int channel_b);
  
  /**
   * @brief Set the RGB-LED to the given color value
   *
   * @param[in] led           Struct identifying the LED to set
   * @param[in] color         Color to set the led to
   */
  void rgbled_set(rgbled_t *led, color_rgb_t *color);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* RGBLED_H */
  /** @} */