upm  1.0.2
Sensor/Actuator repository for libmraa (v1.1.1)
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
rotary.h
Go to the documentation of this file.
1 /*
2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
3  * Sisinty Sasmita Patra <sisinty.s.patra@intel.com>
4  *
5  * Copyright (c) 2016 Intel Corporation.
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining
8  * a copy of this software and associated documentation files (the
9  * "Software"), to deal in the Software without restriction, including
10  * without limitation the rights to use, copy, modify, merge, publish,
11  * distribute, sublicense, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to
13  * the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be
16  * included in all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  */
26 
27 #ifndef ROTARY_H_
28 #define ROTARY_H_
29 
30 #include <unistd.h>
31 
32 #include "upm.h"
33 #include <mraa/aio.h>
34 
46 typedef struct _rotary_context {
47  mraa_aio_context aio;
48  float m_aRef;
49  int16_t m_aRes;
51 
52 #define ROTARY_MAX_ANGLE 300
53 
54 rotary_context rotary_init(int pin, float aRef);
55 
56 void rotary_close(rotary_context dev);
57 
58 upm_result_t rotary_get_value_voltage(const rotary_context dev, float* volts);
59 
60 // degrees only
61 upm_result_t rotary_get_value_angle(rotary_context dev, float* rotval);
62 
63 #endif /* ROTARY_H_ */
Definition: rotary.h:46
struct _rotary_context * rotary_context