FRC - Hackathon / GP2A

Sharp GP2 familly distance sensor library

Dependents:   FRC_2018 0hackton_08_06_18 0hackton_08_06_18_publish Kenya_2019 ... more

GP2A.h@1:956ee3b2eaa0, 2018-05-21 (annotated)

Committer:
haarkon
Date:
Mon May 21 12:36:09 2018 +0000
Revision:
1:956ee3b2eaa0
Parent:
0:17de10d278c2
Child:
2:5e591a5b8edd
cosmetic modifications

Who changed what in which revision?

UserRevisionLine numberNew contents of line
haarkon 0:17de10d278c2 1 /**
haarkon 0:17de10d278c2 2 * @author Hugues Angelis
haarkon 0:17de10d278c2 3 *
haarkon 0:17de10d278c2 4 * @section LICENSE
haarkon 0:17de10d278c2 5 *
haarkon 0:17de10d278c2 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
haarkon 0:17de10d278c2 7 * of this software and associated documentation files (the "Software"), to deal
haarkon 0:17de10d278c2 8 * in the Software without restriction, including without limitation the rights
haarkon 0:17de10d278c2 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
haarkon 0:17de10d278c2 10 * copies of the Software, and to permit persons to whom the Software is
haarkon 0:17de10d278c2 11 * furnished to do so, subject to the following conditions:
haarkon 0:17de10d278c2 12 *
haarkon 0:17de10d278c2 13 * The above copyright notice and this permission notice shall be included in
haarkon 0:17de10d278c2 14 * all copies or substantial portions of the Software.
haarkon 0:17de10d278c2 15 *
haarkon 0:17de10d278c2 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
haarkon 0:17de10d278c2 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
haarkon 0:17de10d278c2 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
haarkon 0:17de10d278c2 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
haarkon 0:17de10d278c2 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
haarkon 0:17de10d278c2 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
haarkon 0:17de10d278c2 22 * THE SOFTWARE.
haarkon 0:17de10d278c2 23 *
haarkon 0:17de10d278c2 24 * @section DESCRIPTION
haarkon 0:17de10d278c2 25 *
haarkon 0:17de10d278c2 26 * SHARP GP2 Analog sensor familly library
haarkon 0:17de10d278c2 27 *
haarkon 0:17de10d278c2 28 * Any GP2 analog sensor may be added to this library using the constructor :
haarkon 0:17de10d278c2 29 * minDistance : is the minimum distance for linear approximation (cm)
haarkon 0:17de10d278c2 30 * maxDistance : is the maximum distance for linear approximation (cm)
haarkon 0:17de10d278c2 31 * slope : is the slope of the linear part of the graph V = f(1/d)
haarkon 0:17de10d278c2 32 * take special care that we use the 1/d instead of d for x
haarkon 0:17de10d278c2 33 * axis.
haarkon 1:956ee3b2eaa0 34 * The slope parameter must be computed by user unless the GP2 reference is
haarkon 1:956ee3b2eaa0 35 * listed in the list below :
haarkon 1:956ee3b2eaa0 36 * - GP2Y0A02YK0F (Min = 30cm, Max = 150cm, Slope = 60)
haarkon 1:956ee3b2eaa0 37 * - GP2Y0A21YK0F (Min = 7cm, Max = 80cm, Slope = 20.88)
haarkon 1:956ee3b2eaa0 38 *
haarkon 1:956ee3b2eaa0 39 * You may add others sensors if you wish it
haarkon 0:17de10d278c2 40 *
haarkon 0:17de10d278c2 41 * One must be aware that under the minimum distance the sensor will output
haarkon 0:17de10d278c2 42 * a false value of distance leading to strong errors.
haarkon 1:956ee3b2eaa0 43 * @endsection
haarkon 0:17de10d278c2 44 */
haarkon 0:17de10d278c2 45
haarkon 0:17de10d278c2 46 #ifndef GP2A_H
haarkon 0:17de10d278c2 47 #define GP2A_H
haarkon 0:17de10d278c2 48
haarkon 0:17de10d278c2 49 /**
haarkon 0:17de10d278c2 50 * Slope definitions for common GP2A sensors
haarkon 0:17de10d278c2 51 */
haarkon 0:17de10d278c2 52
haarkon 0:17de10d278c2 53 #define GP2Y0A02YK0F 60.0
haarkon 0:17de10d278c2 54 #define GP2Y0A21YK0F 20.888
haarkon 0:17de10d278c2 55
haarkon 0:17de10d278c2 56 /**
haarkon 0:17de10d278c2 57 * Includes
haarkon 0:17de10d278c2 58 */
haarkon 0:17de10d278c2 59 #include "mbed.h"
haarkon 0:17de10d278c2 60
haarkon 0:17de10d278c2 61 /**
haarkon 1:956ee3b2eaa0 62 * GP2A Sensor
haarkon 0:17de10d278c2 63 */
haarkon 0:17de10d278c2 64 class GP2A {
haarkon 0:17de10d278c2 65
haarkon 0:17de10d278c2 66 public :
haarkon 0:17de10d278c2 67
haarkon 0:17de10d278c2 68 /**
haarkon 0:17de10d278c2 69 * Constructor.
haarkon 0:17de10d278c2 70 *
haarkon 0:17de10d278c2 71 * @param vmes is the Mbed pin used to connect with GP2A sensor
haarkon 0:17de10d278c2 72 * @param dMin is the GP2A sensor min distance to mesure
haarkon 0:17de10d278c2 73 * @param dMax is the GP2A sensor max distance to mesure
haarkon 0:17de10d278c2 74 * @param slope is the slope of the linear part of the graph V = f(1/d)
haarkon 0:17de10d278c2 75 */
haarkon 0:17de10d278c2 76 GP2A(PinName vmes, float dMin, float dMax, float slope);
haarkon 0:17de10d278c2 77
haarkon 0:17de10d278c2 78 /**
haarkon 0:17de10d278c2 79 * Return the distance to target in cm
haarkon 0:17de10d278c2 80 *
haarkon 1:956ee3b2eaa0 81 * @return the distance in cm
haarkon 0:17de10d278c2 82 */
haarkon 0:17de10d278c2 83 float getDistance (void);
haarkon 0:17de10d278c2 84
haarkon 0:17de10d278c2 85 /**
haarkon 0:17de10d278c2 86 * Return the voltage on GP2A output
haarkon 0:17de10d278c2 87 *
haarkon 1:956ee3b2eaa0 88 * @return the voltage between 0 and 3.3V
haarkon 0:17de10d278c2 89 */
haarkon 0:17de10d278c2 90 float getVoltage (void);
haarkon 0:17de10d278c2 91
haarkon 0:17de10d278c2 92 private :
haarkon 0:17de10d278c2 93 float m_dMin, m_dMax, m_slope;
haarkon 0:17de10d278c2 94
haarkon 0:17de10d278c2 95 protected :
haarkon 0:17de10d278c2 96
haarkon 0:17de10d278c2 97 AnalogIn _sensor ;
haarkon 0:17de10d278c2 98
haarkon 0:17de10d278c2 99 };
haarkon 0:17de10d278c2 100 #endif //GP2A_H