mraa  0.4.5
Low Level Skeleton Library for Communication on GNU/Linux platforms
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
pwm.hpp
1 /*
2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
3  * Copyright (c) 2014 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
25 #pragma once
26 
27 #include "pwm.h"
28 
29 namespace mraa {
30 
38 class Pwm {
39  public:
49  Pwm(int pin, int chipid=-1, bool owner = true) {
50  if (chipid == -1)
51  m_pwm = mraa_pwm_init(pin);
52  else
53  m_pwm = mraa_pwm_init_raw(pin, chipid);
54  if (!owner)
55  mraa_pwm_owner(m_pwm, 0);
56  }
60  ~Pwm() {
61  mraa_pwm_close(m_pwm);
62  }
72  mraa_result_t write(float percentage) {
73  return mraa_pwm_write(m_pwm, percentage);
74  }
83  float read() {
84  return mraa_pwm_read(m_pwm);
85  }
93  return mraa_pwm_period(m_pwm, period);
94  }
102  return mraa_pwm_period_ms(m_pwm, ms);
103  }
111  return mraa_pwm_period_us(m_pwm, us);
112  }
119  mraa_result_t pulsewidth(float seconds) {
120  return mraa_pwm_pulsewidth(m_pwm, seconds);
121  }
129  return mraa_pwm_pulsewidth_ms(m_pwm, ms);
130  }
138  return mraa_pwm_pulsewidth_us(m_pwm, us);
139  }
148  if (enable)
149  return mraa_pwm_enable(m_pwm, 1);
150  else
151  return mraa_pwm_enable(m_pwm, 0);
152  }
160  mraa_result_t config_ms(int period, float duty) {
161  return mraa_pwm_config_ms(m_pwm, period, duty);
162  }
171  return mraa_pwm_config_percent(m_pwm, period, duty);
172  }
173 
174  private:
175  mraa_pwm_context m_pwm;
176 };
177 
178 }
mraa_result_t period(float period)
Definition: pwm.hpp:92
mraa_result_t mraa_pwm_period(mraa_pwm_context dev, float seconds)
mraa_pwm_context mraa_pwm_init(int pin)
Pulse Width Modulation module.
mraa_result_t pulsewidth_ms(int ms)
Definition: pwm.hpp:128
mraa_pwm_context mraa_pwm_init_raw(int chipid, int pin)
mraa_result_t mraa_pwm_config_ms(mraa_pwm_context dev, int period, float duty)
mraa_result_t pulsewidth_us(int us)
Definition: pwm.hpp:137
mraa_result_t mraa_pwm_period_ms(mraa_pwm_context dev, int ms)
mraa_result_t config_percent(int period, float duty)
Definition: pwm.hpp:170
mraa_result_t pulsewidth(float seconds)
Definition: pwm.hpp:119
mraa_result_t mraa_pwm_pulsewidth_ms(mraa_pwm_context dev, int ms)
mraa_result_t mraa_pwm_pulsewidth_us(mraa_pwm_context dev, int us)
mraa_result_t period_ms(int ms)
Definition: pwm.hpp:101
mraa_result_t mraa_pwm_enable(mraa_pwm_context dev, int enable)
mraa_result_t config_ms(int period, float duty)
Definition: pwm.hpp:160
float mraa_pwm_read(mraa_pwm_context dev)
mraa_result_t mraa_pwm_period_us(mraa_pwm_context dev, int us)
mraa_result_t mraa_pwm_write(mraa_pwm_context dev, float percentage)
float read()
Definition: pwm.hpp:83
mraa_result_t mraa_pwm_pulsewidth(mraa_pwm_context dev, float seconds)
mraa_result_t write(float percentage)
Definition: pwm.hpp:72
mraa_result_t
Definition: types.h:49
Pwm(int pin, int chipid=-1, bool owner=true)
Definition: pwm.hpp:49
mraa_result_t enable(bool enable)
Definition: pwm.hpp:147
mraa_result_t period_us(int us)
Definition: pwm.hpp:110
mraa_result_t mraa_pwm_close(mraa_pwm_context dev)
~Pwm()
Definition: pwm.hpp:60
mraa_result_t mraa_pwm_config_percent(mraa_pwm_context dev, int period, float duty)
mraa_result_t mraa_pwm_owner(mraa_pwm_context dev, mraa_boolean_t owner)
API to Pulse Width Modulation.
Definition: pwm.hpp:38