1 /* 2 * Place-holder Header for Documentation and future API change 3 * 4 * Copyright (c) 2014 Intel Corporation. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining 7 * a copy of this software and associated documentation files (the 8 * "Software"), to deal in the Software without restriction, including 9 * without limitation the rights to use, copy, modify, merge, publish, 10 * distribute, sublicense, and/or sell copies of the Software, and to 11 * permit persons to whom the Software is furnished to do so, subject to 12 * the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be 15 * included in all copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 21 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 22 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 23 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 24 */ 25 26 /** 27 * @library grove 28 * @sensor groverotary 29 * @comname Grove Rotary Angle Sensor 30 * @altname Rotary Potentiometer 31 * @type ainput 32 * @man seeed 33 * @con analog 34 * @kit gsk 35 * 36 * @brief API for the Grove Rotary Angle Sensor (Knob) 37 * 38 * Basic UPM module for the Grove rotary angle sensor (knob) on analog. Provides 39 * a set of functions to read the absolute pin value, degrees or radians, and another set 40 * to do the same relative to the center of the knob's range. 41 * 42 * @image html groverotary.jpeg 43 * @snippet groverotary.cxx Interesting 44 */ 45