diff --git a/utrasonicSensor/MeUltrasonicSensor.h b/utrasonicSensor/MeUltrasonicSensor.h new file mode 100644 index 0000000..e3dceb9 --- /dev/null +++ b/utrasonicSensor/MeUltrasonicSensor.h @@ -0,0 +1,173 @@ +/** + * \par Copyright (C), 2012-2016, MakeBlock + * \class MeUltrasonicSensor + * \brief Driver for Me ultrasonic sensor device. + * @file MeUltrasonicSensor.h + * @author MakeBlock + * @version V1.0.1 + * @date 2016/06/25 + * @brief Header for for MeUltrasonicSensor.cpp module + * + * \par Copyright + * This software is Copyright (C), 2012-2016, MakeBlock. Use is subject to license \n + * conditions. The main licensing options available are GPL V2 or Commercial: \n + * + * \par Open Source Licensing GPL V2 + * This is the appropriate option if you want to share the source code of your \n + * application with everyone you distribute it to, and you also want to give them \n + * the right to share who uses it. If you wish to use this software under Open \n + * Source Licensing, you must contribute all your source code to the open source \n + * community in accordance with the GPL Version 2 when your application is \n + * distributed. See http://www.gnu.org/copyleft/gpl.html + * + * \par Copyright + * This software is Copyright (C), 2012-2015, MakeBlock. Use is subject to license \n + * conditions. The main licensing options available are GPL V2 or Commercial: \n + * + * \par Open Source Licensing GPL V2 + * This is the appropriate option if you want to share the source code of your \n + * application with everyone you distribute it to, and you also want to give them \n + * the right to share who uses it. If you wish to use this software under Open \n + * Source Licensing, you must contribute all your source code to the open source \n + * community in accordance with the GPL Version 2 when your application is \n + * distributed. See http://www.gnu.org/copyleft/gpl.html + * + * \par Description + * This file is a drive for Me ultrasonic sensor device, It supports ultrasonic sensor + * V3.0 provided by the MakeBlock. + * + * \par Method List: + * + * 1. void MeUltrasonicSensor::setpin(uint8_t SignalPin) + * 2. double MeUltrasonicSensor::distanceCm(uint16_t MAXcm) + * 3. double MeUltrasonicSensor::distanceInch(uint16_t MAXinch) + * 4. long MeUltrasonicSensor::measure(unsigned long timeout) + * + * \par History: + *
+ * ``         `
+ */ +#ifndef MeUltrasonicSensor_H +#define MeUltrasonicSensor_H + +#include +#include +#include +#include "MeConfig.h" + +#ifdef ME_PORT_DEFINED +#include "MePort.h" +#endif // ME_PORT_DEFINED + +/** + * Class: MeUltrasonicSensor + * \par Description + * Declaration of Class MeUltrasonicSensor. + */ +#ifndef ME_PORT_DEFINED +class MeUltrasonicSensor +#else // !ME_PORT_DEFINED +class MeUltrasonicSensor : public MePort +#endif // !ME_PORT_DEFINED +{ +public: +#ifdef ME_PORT_DEFINED +/** + * Alternate Constructor which can call your own function to map the ultrasonic sensor to arduino port, + * no pins are used or initialized here. + * \param[in] + * None + */ + MeUltrasonicSensor(void); + +/** + * Alternate Constructor which can call your own function to map the ultrasonic Sensor to arduino port + * \param[in] + * port - RJ25 port from PORT_1 to M2 + */ + MeUltrasonicSensor(uint8_t port); +#else // ME_PORT_DEFINED +/** + * Alternate Constructor which can call your own function to map the ultrasonic Sensor to arduino port, + * it will assigned the signal pin. + * \param[in] + * port - arduino port(should analog pin) + */ + MeUltrasonicSensor(uint8_t port); +#endif // ME_PORT_DEFINED + +/** + * \par Function + * setpin + * \par Description + * Reset the ultrasonic Sensor available PIN by its arduino port. + * \param[in] + * SignalPin - arduino port for sensor read(should analog pin) + * \par Output + * None + * \return + * None + * \par Others + * None + */ + void setpin(uint8_t SignalPin); + +/** + * \par Function + * distanceCm + * \par Description + * Centimeters return the distance + * \param[in] + * MAXcm - The Max centimeters can be measured, the default value is 400. + * \par Output + * None + * \return + * The distance measurement in centimeters + * \par Others + * None + */ + double distanceCm(uint16_t = 400); + +/** + * \par Function + * distanceInch + * \par Description + * Inch return the distance + * \param[in] + * MAXinch - The Max inch can be measured, the default value is 180. + * \par Output + * None + * \return + * The distance measurement in inch + * \par Others + * None + */ + double distanceInch(uint16_t = 180); + +/** + * \par Function + * measure + * \par Description + * To get the duration of the ultrasonic sensor + * \param[in] + * timeout - This value is used to define the measurement range, The + * default value is 30000. + * \par Output + * None + * \return + * The duration value associated with distance + * \par Others + * None + */ + long measure(unsigned long = 30000); +private: + volatile uint8_t _SignalPin; + volatile bool _measureFlag; + volatile long _lastEnterTime; + volatile float _measureValue; +}; + +#endif \ No newline at end of file diff --git a/utrasonicSensor/utrasonicSensor.ino b/utrasonicSensor/utrasonicSensor.ino new file mode 100644 index 0000000..0bd16ce --- /dev/null +++ b/utrasonicSensor/utrasonicSensor.ino @@ -0,0 +1,34 @@ +/** + * \par Copyright (C), 2012-2016, MakeBlock + * @file UltrasonicSensorTest.ino + * @author MakeBlock + * @version V1.0.0 + * @date 2015/09/01 + * @brief Description: this file is sample code for Me ultrasonic sensor module. + * + * Function List: + * 1. double MeUltrasonicSensor::distanceCm(uint16_t MAXcm) + * + * \par History: + *
+ *      
+ */ +//#include "MeOrion.h" +#include + +MeUltrasonicSensor ultraSensor(PORT_3); /* Ultrasonic module can ONLY be connected to port 3, 4, 6, 7, 8 of base shield. */ + +void setup() +{ + Serial.begin(9600); +} + +void loop() +{ + Serial.print("Distance : "); + Serial.print(ultraSensor.distanceCm() ); + Serial.println(" cm"); + delay(100); /* the minimal measure interval is 100 milliseconds */ +}