upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
cjq4435.h
Go to the documentation of this file.
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2017 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 #pragma once
25 
26 #include <stdlib.h>
27 #include <unistd.h>
28 #include <string.h>
29 
30 #include <mraa/pwm.h>
31 #include <upm.h>
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
48  typedef struct _cjq4435_context {
49  mraa_pwm_context pwm;
50 
51  bool enabled;
52  } *cjq4435_context;
53 
61 
68 
76  upm_result_t cjq4435_set_period_us(const cjq4435_context dev, int us);
77 
85  upm_result_t cjq4435_set_period_ms(const cjq4435_context dev, int us);
86 
94  upm_result_t cjq4435_set_period_seconds(const cjq4435_context dev,
95  float seconds);
96 
104  upm_result_t cjq4435_enable(const cjq4435_context dev, bool enable);
105 
116  upm_result_t cjq4435_set_duty_cycle(const cjq4435_context dev,
117  float dutyCycle);
118 
124  void cjq4435_on(const cjq4435_context dev);
125 
131  void cjq4435_off(const cjq4435_context dev);
132 
133 
134 #ifdef __cplusplus
135 }
136 #endif
void cjq4435_off(const cjq4435_context dev)
Definition: cjq4435.c:164
upm_result_t cjq4435_set_period_us(const cjq4435_context dev, int us)
Definition: cjq4435.c:78
upm_result_t cjq4435_enable(const cjq4435_context dev, bool enable)
Definition: cjq4435.c:118
upm_result_t cjq4435_set_period_ms(const cjq4435_context dev, int us)
Definition: cjq4435.c:91
upm_result_t cjq4435_set_duty_cycle(const cjq4435_context dev, float dutyCycle)
Definition: cjq4435.c:132
void cjq4435_on(const cjq4435_context dev)
Definition: cjq4435.c:152
cjq4435_context cjq4435_init(int pin)
Definition: cjq4435.c:31
upm_result_t cjq4435_set_period_seconds(const cjq4435_context dev, float seconds)
Definition: cjq4435.c:104
struct _cjq4435_context * cjq4435_context
Definition: cjq4435.h:48
void cjq4435_close(cjq4435_context dev)
Definition: cjq4435.c:63