diff options
Diffstat (limited to 'peripheral/libupm/src/grove/groverotary.h')
-rw-r--r-- | peripheral/libupm/src/grove/groverotary.h | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/peripheral/libupm/src/grove/groverotary.h b/peripheral/libupm/src/grove/groverotary.h new file mode 100644 index 0000000..ee98978 --- /dev/null +++ b/peripheral/libupm/src/grove/groverotary.h @@ -0,0 +1,45 @@ +/* + * Place-holder Header for Documentation and future API change + * + * Copyright (c) 2014 Intel Corporation. + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +/** + * @library grove + * @sensor groverotary + * @comname Grove Rotary Angle Sensor + * @altname Rotary Potentiometer + * @type ainput + * @man seeed + * @con analog + * @kit gsk + * + * @brief API for the Grove Rotary Angle Sensor (Knob) + * + * Basic UPM module for the Grove rotary angle sensor (knob) on analog. Provides + * a set of functions to read the absolute pin value, degrees or radians, and another set + * to do the same relative to the center of the knob's range. + * + * @image html groverotary.jpeg + * @snippet groverotary.cxx Interesting + */ +
\ No newline at end of file |