diff options
Diffstat (limited to 'peripheral/libupm/src/nunchuck/nunchuck.h')
-rw-r--r-- | peripheral/libupm/src/nunchuck/nunchuck.h | 161 |
1 files changed, 161 insertions, 0 deletions
diff --git a/peripheral/libupm/src/nunchuck/nunchuck.h b/peripheral/libupm/src/nunchuck/nunchuck.h new file mode 100644 index 0000000..24d509f --- /dev/null +++ b/peripheral/libupm/src/nunchuck/nunchuck.h @@ -0,0 +1,161 @@ +/* + * Author: Jon Trulson <jtrulson@ics.com> + * Copyright (c) 2015 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. + */ +#pragma once + +#include <string> +#include <mraa/i2c.h> + +#define NUNCHUCK_I2C_ADDR 0x52 + +namespace upm { + + /** + * @brief Wii Nunchuk library + * @defgroup nunchuck libupm-nunchuck + * @ingroup generic i2c accelerometer robok + */ + /** + * @library nunchuck + * @sensor nunchuck + * @comname Wii Nunchuk + * @type accelerometer + * @man generic + * @web http://wiibrew.org/wiki/Wiimote/Extension_Controllers + * @con i2c + * @kit robok + * + * @brief API for the Wii* Nunchuk controller + * + * UPM module for the Wii Nunchuk controller. This module was tested with + * Wii Nunchuk connected to I2C via a Grove Wii Nunchuk adapter. + * + * See http://wiibrew.org/wiki/Wiimote/Extension_Controllers and + * http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck + * for more details on the controller and its protocol. + * + * A warning for the Grove Wii Nunchuk adapter: it has 2 traces on one + * side, and 3 traces on the other. Do not match these up with the + * Nunchuk connector's traces. The connector's 'Grove' + * should be on the same side as the Grove interface socket on the + * adapter. + * + * @image html nunchuck.jpg + * @snippet nunchuck.cxx Interesting + */ + class NUNCHUCK { + public: + /** + * NUNCHUCK constructor + * + * @param bus I2C bus to use + * @param addr I2C address to use + */ + NUNCHUCK(int bus, uint8_t addr=NUNCHUCK_I2C_ADDR); + + /** + * NUNCHUCK destructor + */ + ~NUNCHUCK(); + + /** + * Writes value(s) into registers + * + * @param reg Register location to start writing into + * @param byte Byte to write + * @return True if successful + */ + bool writeByte(uint8_t reg, uint8_t byte); + + /** + * Reads value(s) from registers + * + * @param reg Register location to start reading from + * @param buffer Buffer for data storage + * @param len Number of bytes to read + * @return Number of bytes read + */ + int readBytes(uint8_t reg, uint8_t *buffer, int len); + + /** + * Initializes the controller. Here, we disable encryption after + * delaying for a time to ensure the controller is ready. + * + * @return True if initialization is successful + */ + bool init(); + + /** + * Reads and updates the current state of the controller. + * + */ + void update(); + + /** + * Current analog stick X position + * + */ + int stickX; + + /** + * Current analog stick Y position + * + */ + int stickY; + + /** + * Current accelerometer X value + * + */ + int accelX; + + /** + * Current accelerometer Y value + * + */ + int accelY; + + /** + * Current accelerometer Z value + * + */ + int accelZ; + + /** + * Button C pressed? + * + */ + bool buttonC; + + /** + * Button Z pressed? + * + */ + bool buttonZ; + + private: + mraa_i2c_context m_i2c; + }; +} + + |