/* * Author: Jon Trulson * Copyright (c) 2015 Intel Corporation. * * Thanks to Adafruit for supplying a google translated version of the * Chinese datasheet and some clues in their code. * * 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 #include #include #include #include #include #include #include #include #include #include #include #include #include #define HM11_DEFAULT_UART 0 namespace upm { /** * @brief UPM library for the HM-11 Bluetooth 4.0 Low Energy Module * @defgroup hm11 libupm-hm11 * @ingroup seeed serial wifi */ /** * @library hm11 * @sensor hm11 * @comname HM-11 Bluetooth 4.0 Low Energy Module * @altname HM-10, HM-12 * @category wifi * @manufacturer seeed * @connection uart * @web http://www.seeedstudio.com/wiki/images/c/cd/Bluetooth4_en.pdf * * @brief API HM-11 4.0 Bluetooth Low Energy Module * * The driver was tested with the Grove BLE module. Its an HM-11 * BLE 4.0 module based on a TI CC2541 chip. It operates using a * standard 'AT' command set. See the datasheet for a full list * of available commands and their possible responses. * * http://www.seeedstudio.com/wiki/images/c/cd/Bluetooth4_en.pdf * * It is connected via a UART at 9600 baud. * * @image html hm11.jpg * @snippet hm11.cxx Interesting */ class HM11 { public: /** * HM11 module constructor * * @param uart default uart to use (0 or 1) */ HM11(int uart); /** * HM11 module Destructor */ ~HM11(); /** * check to see if there is data available for reading * * @param millis number of milliseconds to wait, 0 means no wait. * @return true if there is data available to be read */ bool dataAvailable(unsigned int millis); /** * read any available data into a user-supplied buffer. Note, the * call will block until data is available to be read. Use * dataAvailable() to determine whether there is data available * beforehand, to avoid blocking. * * @param buffer the buffer to hold the data read * @param len the length of the buffer * @return the number of bytes read */ int readData(char *buffer, size_t len); /** * write the data in buffer to the device * * @param buffer the buffer to hold the data read * @param len the length of the buffer * @return the number of bytes written */ int writeData(char *buffer, size_t len); /** * setup the proper tty i/o modes and the baudrate. The default * baud rate is 9600 (B9600) for this device. * * @param baud the desired baud rate. * @return true if successful */ bool setupTty(speed_t baud=B9600); protected: int ttyFd() { return m_ttyFd; }; int setTtyFd(int fd) { m_ttyFd = fd; }; private: mraa_uart_context m_uart; int m_ttyFd; }; }