diff options
Diffstat (limited to 'peripheral/libupm/src/grove/grovebutton.hpp')
-rw-r--r-- | peripheral/libupm/src/grove/grovebutton.hpp | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/peripheral/libupm/src/grove/grovebutton.hpp b/peripheral/libupm/src/grove/grovebutton.hpp new file mode 100644 index 0000000..6f746cc --- /dev/null +++ b/peripheral/libupm/src/grove/grovebutton.hpp @@ -0,0 +1,42 @@ +/* + * 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 grovebutton + * @comname Grove Button + * @altname Grove Touch Sensor + * @type button touch + * @man seeed + * @con gpio + * @kit gsk + * + * @brief API for the Grove Button + * + * Basic UPM module for the Grove button + * + * @image html grovebutton.jpg + * @snippet grovebutton.cxx Interesting + */ |