mraa: rename from maa to mraa

[contrib/mraa.git] / api / mraa / pwm.h

diff --git a/api/maa/pwm.h b/api/mraa/pwm.h
similarity index 81%
rename from api/maa/pwm.h
rename to api/mraa/pwm.h
index 6345b04..9f32f05 100644 (file)
--- a/api/maa/pwm.h
+++ b/api/mraa/pwm.h
@@ -28,7 +28,7 @@
  * @file
  * @brief Pulse Width Modulation module
  *
- * PWM is the Pulse Width Modulation interface to libmaa. It allows the
+ * PWM is the Pulse Width Modulation interface to libmraa. It allows the
  * generation of a signal on a pin. Some boards may have higher or lower levels
  * of resolution so make sure you check the board & pin you are using before
  * hand.
@@ -45,7 +45,7 @@ extern "C" {
 
 #include "common.h"
 
-typedef struct _pwm* maa_pwm_context;
+typedef struct _pwm* mraa_pwm_context;
 
 /**
  * Initialise pwm_context, uses board mapping
@@ -53,7 +53,7 @@ typedef struct _pwm* maa_pwm_context;
  * @param pin The PWM PIN
  * @return pwm context or NULL
  */
-maa_pwm_context maa_pwm_init(int pin);
+mraa_pwm_context mraa_pwm_init(int pin);
 
 /**
  * Initialise pwm_context, raw mode
@@ -62,7 +62,7 @@ maa_pwm_context maa_pwm_init(int pin);
  * @param pin The PWM PIN.
  * @return pwm context or NULL
  */
-maa_pwm_context maa_pwm_init_raw(int chipid, int pin);
+mraa_pwm_context mraa_pwm_init_raw(int chipid, int pin);
 
 /**
  * Set the ouput duty-cycle percentage, as a float
@@ -73,7 +73,7 @@ maa_pwm_context maa_pwm_init_raw(int chipid, int pin);
  *    Values above or below this range will be set at either 0.0f or 1.0f
  * @return Result of operation
  */
-maa_result_t maa_pwm_write(maa_pwm_context dev, float percentage);
+mraa_result_t mraa_pwm_write(mraa_pwm_context dev, float percentage);
 
 /**
  * Read the ouput duty-cycle percentage, as a float
@@ -83,7 +83,7 @@ maa_result_t maa_pwm_write(maa_pwm_context dev, float percentage);
  *    The value should lie between 0.0f (representing on 0%) and 1.0f
  *    Values above or below this range will be set at either 0.0f or 1.0f
  */
-float maa_pwm_read(maa_pwm_context dev);
+float mraa_pwm_read(mraa_pwm_context dev);
 
 /**
  * Set the PWM period as seconds represented in a float
@@ -92,7 +92,7 @@ float maa_pwm_read(maa_pwm_context dev);
  * @param seconds Period represented as a float in seconds
  * @return Result of operation
  */
-maa_result_t maa_pwm_period(maa_pwm_context dev, float seconds);
+mraa_result_t mraa_pwm_period(mraa_pwm_context dev, float seconds);
 
 /**
  * Set period, milliseconds.
@@ -101,7 +101,7 @@ maa_result_t maa_pwm_period(maa_pwm_context dev, float seconds);
  * @param ms Milliseconds for period
  * @return Result of operation
  */
-maa_result_t maa_pwm_period_ms(maa_pwm_context dev, int ms);
+mraa_result_t mraa_pwm_period_ms(mraa_pwm_context dev, int ms);
 
 /**
  * Set period, microseconds
@@ -110,7 +110,7 @@ maa_result_t maa_pwm_period_ms(maa_pwm_context dev, int ms);
  * @param us Microseconds as period
  * @return Result of operation
  */
-maa_result_t maa_pwm_period_us(maa_pwm_context dev, int us);
+mraa_result_t mraa_pwm_period_us(mraa_pwm_context dev, int us);
 
 /**
  * Set pulsewidth, As represnted by seconds in a (float)
@@ -119,7 +119,7 @@ maa_result_t maa_pwm_period_us(maa_pwm_context dev, int us);
  * @param seconds The duration of a pulse
  * @return Result of operation
  */
-maa_result_t maa_pwm_pulsewidth(maa_pwm_context dev, float seconds);
+mraa_result_t mraa_pwm_pulsewidth(mraa_pwm_context dev, float seconds);
 
 /**
  * Set pulsewidth, milliseconds
@@ -128,7 +128,7 @@ maa_result_t maa_pwm_pulsewidth(maa_pwm_context dev, float seconds);
  * @param ms Milliseconds for pulsewidth
  * @return Result of operation
  */
-maa_result_t maa_pwm_pulsewidth_ms(maa_pwm_context dev, int ms);
+mraa_result_t mraa_pwm_pulsewidth_ms(mraa_pwm_context dev, int ms);
 
 /**
  * Set pulsewidth, microseconds
@@ -137,7 +137,7 @@ maa_result_t maa_pwm_pulsewidth_ms(maa_pwm_context dev, int ms);
  * @param us Microseconds for pulsewidth
  * @return Result of operation
  */
-maa_result_t maa_pwm_pulsewidth_us(maa_pwm_context dev, int us);
+mraa_result_t mraa_pwm_pulsewidth_us(mraa_pwm_context dev, int us);
 
 /**
  * Set the enable status of the PWM pin. None zero will assume on with output being driven.
@@ -147,7 +147,7 @@ maa_result_t maa_pwm_pulsewidth_us(maa_pwm_context dev, int us);
  * @param enable Toggle status of pin
  * @return Result of operation.
  */
-maa_result_t maa_pwm_enable(maa_pwm_context dev, int enable);
+mraa_result_t mraa_pwm_enable(mraa_pwm_context dev, int enable);
 
 /**
  * Change ownership of context
@@ -156,7 +156,7 @@ maa_result_t maa_pwm_enable(maa_pwm_context dev, int enable);
  * @param owner Ownership boolean
  * @return Result of operation
  */
-maa_result_t maa_pwm_owner(maa_pwm_context dev, maa_boolean_t owner);
+mraa_result_t mraa_pwm_owner(mraa_pwm_context dev, mraa_boolean_t owner);
 
 /**
  * Close and unexport the PWM pin
@@ -164,7 +164,7 @@ maa_result_t maa_pwm_owner(maa_pwm_context dev, maa_boolean_t owner);
  * @param dev The pwm context to use
  * @return Result of operation
  */
-maa_result_t maa_pwm_close(maa_pwm_context dev);
+mraa_result_t mraa_pwm_close(mraa_pwm_context dev);
 
 #ifdef __cplusplus
 }