HAN Solarboat / Mbed 2 deprecated SolarOnFoils_MainModule_20150518

version 1.0

Dependencies:   CMSIS_DSP_401 GPS MPU9150_DMP PID QuaternionMath Servo mbed

Fork of SolarOnFoils_MainModule_20150518 by Dannis Brugman

PinDetect.h@2:f6d058931b17, 2015-08-11 (annotated)

Committer:
Dannis_mbed
Date:
Tue Aug 11 08:38:55 2015 +0000
Revision:
2:f6d058931b17
Parent:
0:81b21910454e 
Test version mainmodule

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Dannis_mbed 0:81b21910454e 1 /*
Dannis_mbed 0:81b21910454e 2 Copyright (c) 2010 Andy Kirkham
Dannis_mbed 0:81b21910454e 3
Dannis_mbed 0:81b21910454e 4 Permission is hereby granted, free of charge, to any person obtaining a copy
Dannis_mbed 0:81b21910454e 5 of this software and associated documentation files (the "Software"), to deal
Dannis_mbed 0:81b21910454e 6 in the Software without restriction, including without limitation the rights
Dannis_mbed 0:81b21910454e 7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Dannis_mbed 0:81b21910454e 8 copies of the Software, and to permit persons to whom the Software is
Dannis_mbed 0:81b21910454e 9 furnished to do so, subject to the following conditions:
Dannis_mbed 0:81b21910454e 10
Dannis_mbed 0:81b21910454e 11 The above copyright notice and this permission notice shall be included in
Dannis_mbed 0:81b21910454e 12 all copies or substantial portions of the Software.
Dannis_mbed 0:81b21910454e 13
Dannis_mbed 0:81b21910454e 14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Dannis_mbed 0:81b21910454e 15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Dannis_mbed 0:81b21910454e 16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Dannis_mbed 0:81b21910454e 17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Dannis_mbed 0:81b21910454e 18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Dannis_mbed 0:81b21910454e 19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Dannis_mbed 0:81b21910454e 20 THE SOFTWARE.
Dannis_mbed 0:81b21910454e 21 */
Dannis_mbed 0:81b21910454e 22
Dannis_mbed 0:81b21910454e 23 #ifndef AJK_PIN_DETECT_H
Dannis_mbed 0:81b21910454e 24 #define AJK_PIN_DETECT_H
Dannis_mbed 0:81b21910454e 25
Dannis_mbed 0:81b21910454e 26 #ifndef MBED_H
Dannis_mbed 0:81b21910454e 27 #include "mbed.h"
Dannis_mbed 0:81b21910454e 28 #endif
Dannis_mbed 0:81b21910454e 29
Dannis_mbed 0:81b21910454e 30 #ifndef PINDETECT_PIN_ASSTERED
Dannis_mbed 0:81b21910454e 31 #define PINDETECT_PIN_ASSTERED 1
Dannis_mbed 0:81b21910454e 32 #endif
Dannis_mbed 0:81b21910454e 33
Dannis_mbed 0:81b21910454e 34 #ifndef PINDETECT_SAMPLE_PERIOD
Dannis_mbed 0:81b21910454e 35 #define PINDETECT_SAMPLE_PERIOD 20000
Dannis_mbed 0:81b21910454e 36 #endif
Dannis_mbed 0:81b21910454e 37
Dannis_mbed 0:81b21910454e 38 #ifndef PINDETECT_ASSERT_COUNT
Dannis_mbed 0:81b21910454e 39 #define PINDETECT_ASSERT_COUNT 1
Dannis_mbed 0:81b21910454e 40 #endif
Dannis_mbed 0:81b21910454e 41
Dannis_mbed 0:81b21910454e 42 #ifndef PINDETECT_HOLD_COUNT
Dannis_mbed 0:81b21910454e 43 #define PINDETECT_HOLD_COUNT 50
Dannis_mbed 0:81b21910454e 44 #endif
Dannis_mbed 0:81b21910454e 45
Dannis_mbed 0:81b21910454e 46 namespace AjK {
Dannis_mbed 0:81b21910454e 47
Dannis_mbed 0:81b21910454e 48 /** PinDetect adds mechanical switch debouncing to DigitialIn and interrupt callbacks.
Dannis_mbed 0:81b21910454e 49 *
Dannis_mbed 0:81b21910454e 50 * This is done by sampling the specified pin at regular intervals and detecting any
Dannis_mbed 0:81b21910454e 51 * change of state ( 0 -> 1 or 1 -> 0 ). When a state change is detected the attached
Dannis_mbed 0:81b21910454e 52 * callback handler is called. Additionally, if the pin stays in the same state after
Dannis_mbed 0:81b21910454e 53 * a state change for a defined period of time, an extra callback is made allowing a
Dannis_mbed 0:81b21910454e 54 * program to detect when a "key is pressed and held down" rather than a momentary
Dannis_mbed 0:81b21910454e 55 * key/switch press.
Dannis_mbed 0:81b21910454e 56 *
Dannis_mbed 0:81b21910454e 57 * All parameters are customisable which include:-
Dannis_mbed 0:81b21910454e 58 * <ul>
Dannis_mbed 0:81b21910454e 59 * <li> The sampling frequency. </li>
Dannis_mbed 0:81b21910454e 60 * <li> The number of continuous samples until a state change is detected. </li>
Dannis_mbed 0:81b21910454e 61 * <li> The number of continuous samples until a key is assumed held after a state change. </li>
Dannis_mbed 0:81b21910454e 62 * <li> The logic level which is assumed to be asserted (0volts or +volts). </li>
Dannis_mbed 0:81b21910454e 63 * </ul>
Dannis_mbed 0:81b21910454e 64 *
Dannis_mbed 0:81b21910454e 65 * Only callbacks that have been attached will be called by the library.
Dannis_mbed 0:81b21910454e 66 *
Dannis_mbed 0:81b21910454e 67 * Example:
Dannis_mbed 0:81b21910454e 68 * @code
Dannis_mbed 0:81b21910454e 69 * #include "mbed.h"
Dannis_mbed 0:81b21910454e 70 * #include "PinDetect.h"
Dannis_mbed 0:81b21910454e 71 *
Dannis_mbed 0:81b21910454e 72 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 73 * DigitialOut led1( LED1 );
Dannis_mbed 0:81b21910454e 74 * DigitialOut led2( LED2 );
Dannis_mbed 0:81b21910454e 75 * DigitialOut led3( LED3 );
Dannis_mbed 0:81b21910454e 76 * DigitialOut led4( LED4 );
Dannis_mbed 0:81b21910454e 77 *
Dannis_mbed 0:81b21910454e 78 * void keyPressed( void ) {
Dannis_mbed 0:81b21910454e 79 * led2 = 1;
Dannis_mbed 0:81b21910454e 80 * led3 = 0;
Dannis_mbed 0:81b21910454e 81 * led4 = 0;
Dannis_mbed 0:81b21910454e 82 * }
Dannis_mbed 0:81b21910454e 83 *
Dannis_mbed 0:81b21910454e 84 * void keyReleased( void ) {
Dannis_mbed 0:81b21910454e 85 * led2 = 0;
Dannis_mbed 0:81b21910454e 86 * led3 = 0;
Dannis_mbed 0:81b21910454e 87 * led4 = 0;
Dannis_mbed 0:81b21910454e 88 * }
Dannis_mbed 0:81b21910454e 89 *
Dannis_mbed 0:81b21910454e 90 * void keyPressedHeld( void ) {
Dannis_mbed 0:81b21910454e 91 * led3 = 1;
Dannis_mbed 0:81b21910454e 92 * }
Dannis_mbed 0:81b21910454e 93 *
Dannis_mbed 0:81b21910454e 94 * void keyReleasedHeld( void ) {
Dannis_mbed 0:81b21910454e 95 * led4 = 1;
Dannis_mbed 0:81b21910454e 96 * }
Dannis_mbed 0:81b21910454e 97 *
Dannis_mbed 0:81b21910454e 98 * int main() {
Dannis_mbed 0:81b21910454e 99 *
Dannis_mbed 0:81b21910454e 100 * pin.mode( PullDown );
Dannis_mbed 0:81b21910454e 101 * pin.attach_asserted( &keyPressed );
Dannis_mbed 0:81b21910454e 102 * pin.attach_deasserted( &keyReleased );
Dannis_mbed 0:81b21910454e 103 * pin.attach_asserted_held( &keyPressedHeld );
Dannis_mbed 0:81b21910454e 104 * pin.attach_deasserted_held( &keyReleasedHeld );
Dannis_mbed 0:81b21910454e 105 *
Dannis_mbed 0:81b21910454e 106 * // Sampling does not begin until you set a frequency.
Dannis_mbed 0:81b21910454e 107 * // The default is 20ms. If you want a different frequency
Dannis_mbed 0:81b21910454e 108 * // then pass the period in microseconds for example, for 10ms :-
Dannis_mbed 0:81b21910454e 109 * // pin.setSampleFrequency( 10000 );
Dannis_mbed 0:81b21910454e 110 * //
Dannis_mbed 0:81b21910454e 111 * pin.setSampleFrequency(); // Defaults to 20ms.
Dannis_mbed 0:81b21910454e 112 *
Dannis_mbed 0:81b21910454e 113 * while( 1 ) {
Dannis_mbed 0:81b21910454e 114 * led1 = !led1;
Dannis_mbed 0:81b21910454e 115 * wait( 0.2 );
Dannis_mbed 0:81b21910454e 116 * }
Dannis_mbed 0:81b21910454e 117 * }
Dannis_mbed 0:81b21910454e 118 * @endcode
Dannis_mbed 0:81b21910454e 119 *
Dannis_mbed 0:81b21910454e 120 * This example will flash led1 in a similar to a standard starting program.
Dannis_mbed 0:81b21910454e 121 *
Dannis_mbed 0:81b21910454e 122 * Applying a "1" (switch on) to pin 30 will switch on led2, removing the "1" to "0"
Dannis_mbed 0:81b21910454e 123 * (switch off) led2 goes out. Holding the "switch" at one for one second will switch
Dannis_mbed 0:81b21910454e 124 * on led3. An unasserted P30 (switched off) will, after one second illuminate led4
Dannis_mbed 0:81b21910454e 125 * when the deasserted calledback is called.
Dannis_mbed 0:81b21910454e 126 *
Dannis_mbed 0:81b21910454e 127 * The above is a very basic introduction. For more details:-
Dannis_mbed 0:81b21910454e 128 * @see example.h
Dannis_mbed 0:81b21910454e 129 */
Dannis_mbed 0:81b21910454e 130 class PinDetect {
Dannis_mbed 0:81b21910454e 131
Dannis_mbed 0:81b21910454e 132 protected:
Dannis_mbed 0:81b21910454e 133 DigitalIn *_in;
Dannis_mbed 0:81b21910454e 134 Ticker *_ticker;
Dannis_mbed 0:81b21910454e 135 int _prevState;
Dannis_mbed 0:81b21910454e 136 int _currentStateCounter;
Dannis_mbed 0:81b21910454e 137 int _sampleTime;
Dannis_mbed 0:81b21910454e 138 int _assertValue;
Dannis_mbed 0:81b21910454e 139 int _samplesTillAssertReload;
Dannis_mbed 0:81b21910454e 140 int _samplesTillAssert;
Dannis_mbed 0:81b21910454e 141 int _samplesTillHeldReload;
Dannis_mbed 0:81b21910454e 142 int _samplesTillHeld;
Dannis_mbed 0:81b21910454e 143 FunctionPointer _callbackAsserted;
Dannis_mbed 0:81b21910454e 144 FunctionPointer _callbackDeasserted;
Dannis_mbed 0:81b21910454e 145 FunctionPointer _callbackAssertedHeld;
Dannis_mbed 0:81b21910454e 146 FunctionPointer _callbackDeassertedHeld;
Dannis_mbed 0:81b21910454e 147
Dannis_mbed 0:81b21910454e 148 /** initialise class
Dannis_mbed 0:81b21910454e 149 *
Dannis_mbed 0:81b21910454e 150 * @param PinName p is a valid pin that supports DigitalIn
Dannis_mbed 0:81b21910454e 151 * @param PinMode m The mode the DigitalIn should use.
Dannis_mbed 0:81b21910454e 152 */
Dannis_mbed 0:81b21910454e 153 void init(PinName p, PinMode m) {
Dannis_mbed 0:81b21910454e 154 _sampleTime = PINDETECT_SAMPLE_PERIOD;
Dannis_mbed 0:81b21910454e 155 _samplesTillAssert = PINDETECT_ASSERT_COUNT;
Dannis_mbed 0:81b21910454e 156 _samplesTillHeld = 0;
Dannis_mbed 0:81b21910454e 157 _samplesTillAssertReload = PINDETECT_ASSERT_COUNT;
Dannis_mbed 0:81b21910454e 158 _samplesTillHeldReload = PINDETECT_HOLD_COUNT;
Dannis_mbed 0:81b21910454e 159 _assertValue = PINDETECT_PIN_ASSTERED;
Dannis_mbed 0:81b21910454e 160
Dannis_mbed 0:81b21910454e 161 _in = new DigitalIn( p );
Dannis_mbed 0:81b21910454e 162 _in->mode( m );
Dannis_mbed 0:81b21910454e 163 _prevState = _in->read();
Dannis_mbed 0:81b21910454e 164 _ticker = new Ticker;
Dannis_mbed 0:81b21910454e 165 }
Dannis_mbed 0:81b21910454e 166
Dannis_mbed 0:81b21910454e 167 public:
Dannis_mbed 0:81b21910454e 168
Dannis_mbed 0:81b21910454e 169 friend class Ticker;
Dannis_mbed 0:81b21910454e 170
Dannis_mbed 0:81b21910454e 171 PinDetect() { error("You must supply a PinName"); }
Dannis_mbed 0:81b21910454e 172
Dannis_mbed 0:81b21910454e 173 /** PinDetect constructor
Dannis_mbed 0:81b21910454e 174 *
Dannis_mbed 0:81b21910454e 175 * By default the PinMode is set to PullDown.
Dannis_mbed 0:81b21910454e 176 *
Dannis_mbed 0:81b21910454e 177 * @see http://mbed.org/handbook/DigitalIn
Dannis_mbed 0:81b21910454e 178 * @param p PinName is a valid pin that supports DigitalIn
Dannis_mbed 0:81b21910454e 179 */
Dannis_mbed 0:81b21910454e 180 PinDetect(PinName p) {
Dannis_mbed 0:81b21910454e 181 init( p, PullDown );
Dannis_mbed 0:81b21910454e 182 }
Dannis_mbed 0:81b21910454e 183
Dannis_mbed 0:81b21910454e 184 /** PinDetect constructor
Dannis_mbed 0:81b21910454e 185 *
Dannis_mbed 0:81b21910454e 186 * @see http://mbed.org/handbook/DigitalIn
Dannis_mbed 0:81b21910454e 187 * @param PinName p is a valid pin that supports DigitalIn
Dannis_mbed 0:81b21910454e 188 * @param PinMode m The mode the DigitalIn should use.
Dannis_mbed 0:81b21910454e 189 */
Dannis_mbed 0:81b21910454e 190 PinDetect(PinName p, PinMode m) {
Dannis_mbed 0:81b21910454e 191 init( p, m );
Dannis_mbed 0:81b21910454e 192 }
Dannis_mbed 0:81b21910454e 193
Dannis_mbed 0:81b21910454e 194 /** PinDetect destructor
Dannis_mbed 0:81b21910454e 195 */
Dannis_mbed 0:81b21910454e 196 ~PinDetect() {
Dannis_mbed 0:81b21910454e 197 if ( _ticker ) delete( _ticker );
Dannis_mbed 0:81b21910454e 198 if ( _in ) delete( _in );
Dannis_mbed 0:81b21910454e 199 }
Dannis_mbed 0:81b21910454e 200
Dannis_mbed 0:81b21910454e 201 /** Set the sampling time in microseconds.
Dannis_mbed 0:81b21910454e 202 *
Dannis_mbed 0:81b21910454e 203 * @param int The time between pin samples in microseconds.
Dannis_mbed 0:81b21910454e 204 */
Dannis_mbed 0:81b21910454e 205 void setSampleFrequency(int i = PINDETECT_SAMPLE_PERIOD) {
Dannis_mbed 0:81b21910454e 206 _sampleTime = i;
Dannis_mbed 0:81b21910454e 207 _prevState = _in->read();
Dannis_mbed 0:81b21910454e 208 _ticker->attach_us( this, &PinDetect::isr, _sampleTime );
Dannis_mbed 0:81b21910454e 209 }
Dannis_mbed 0:81b21910454e 210
Dannis_mbed 0:81b21910454e 211 /** Set the value used as assert.
Dannis_mbed 0:81b21910454e 212 *
Dannis_mbed 0:81b21910454e 213 * Defaults to 1 (ie if pin == 1 then pin asserted).
Dannis_mbed 0:81b21910454e 214 *
Dannis_mbed 0:81b21910454e 215 * @param int New assert value (1 or 0)
Dannis_mbed 0:81b21910454e 216 */
Dannis_mbed 0:81b21910454e 217 void setAssertValue (int i = PINDETECT_PIN_ASSTERED) { _assertValue = i & 1; }
Dannis_mbed 0:81b21910454e 218
Dannis_mbed 0:81b21910454e 219 /** Set the number of continuous samples until assert assumed.
Dannis_mbed 0:81b21910454e 220 *
Dannis_mbed 0:81b21910454e 221 * Defaults to 1 (1 * sample frequency).
Dannis_mbed 0:81b21910454e 222 *
Dannis_mbed 0:81b21910454e 223 * @param int The number of continuous samples until assert assumed.
Dannis_mbed 0:81b21910454e 224 */
Dannis_mbed 0:81b21910454e 225 void setSamplesTillAssert(int i) { _samplesTillAssertReload = i; }
Dannis_mbed 0:81b21910454e 226
Dannis_mbed 0:81b21910454e 227 /** Set the number of continuous samples until held assumed.
Dannis_mbed 0:81b21910454e 228 *
Dannis_mbed 0:81b21910454e 229 * Defaults to 50 * sample frequency.
Dannis_mbed 0:81b21910454e 230 *
Dannis_mbed 0:81b21910454e 231 * @param int The number of continuous samples until held assumed.
Dannis_mbed 0:81b21910454e 232 */
Dannis_mbed 0:81b21910454e 233 void setSamplesTillHeld(int i) { _samplesTillHeldReload = i; }
Dannis_mbed 0:81b21910454e 234
Dannis_mbed 0:81b21910454e 235 /** Set the pin mode.
Dannis_mbed 0:81b21910454e 236 *
Dannis_mbed 0:81b21910454e 237 * @see http://mbed.org/projects/libraries/api/mbed/trunk/DigitalInOut#DigitalInOut.mode
Dannis_mbed 0:81b21910454e 238 * @param PinMode m The mode to pass on to the DigitalIn
Dannis_mbed 0:81b21910454e 239 */
Dannis_mbed 0:81b21910454e 240 void mode(PinMode m) { _in->mode( m ); }
Dannis_mbed 0:81b21910454e 241
Dannis_mbed 0:81b21910454e 242 /** Attach a callback function
Dannis_mbed 0:81b21910454e 243 *
Dannis_mbed 0:81b21910454e 244 * @code
Dannis_mbed 0:81b21910454e 245 *
Dannis_mbed 0:81b21910454e 246 * DigitalOut led1( LED1 );
Dannis_mbed 0:81b21910454e 247 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 248 *
Dannis_mbed 0:81b21910454e 249 * void myCallback( void ) {
Dannis_mbed 0:81b21910454e 250 * led1 = 1;
Dannis_mbed 0:81b21910454e 251 * };
Dannis_mbed 0:81b21910454e 252 *
Dannis_mbed 0:81b21910454e 253 * main() {
Dannis_mbed 0:81b21910454e 254 * pin.attach_asserted( &myCallback );
Dannis_mbed 0:81b21910454e 255 * }
Dannis_mbed 0:81b21910454e 256 *
Dannis_mbed 0:81b21910454e 257 * @endcode
Dannis_mbed 0:81b21910454e 258 *
Dannis_mbed 0:81b21910454e 259 * Call this function when a pin is asserted.
Dannis_mbed 0:81b21910454e 260 * @param function A C function pointer
Dannis_mbed 0:81b21910454e 261 */
Dannis_mbed 0:81b21910454e 262 void attach_asserted(void (*function)(void)) {
Dannis_mbed 0:81b21910454e 263 _callbackAsserted.attach( function );
Dannis_mbed 0:81b21910454e 264 }
Dannis_mbed 0:81b21910454e 265
Dannis_mbed 0:81b21910454e 266 /** Attach a callback object/method
Dannis_mbed 0:81b21910454e 267 *
Dannis_mbed 0:81b21910454e 268 * @code
Dannis_mbed 0:81b21910454e 269 *
Dannis_mbed 0:81b21910454e 270 * class Bar {
Dannis_mbed 0:81b21910454e 271 * public:
Dannis_mbed 0:81b21910454e 272 * void myCallback( void ) { led1 = 1; }
Dannis_mbed 0:81b21910454e 273 * };
Dannis_mbed 0:81b21910454e 274 *
Dannis_mbed 0:81b21910454e 275 * DigitalOut led1( LED1 );
Dannis_mbed 0:81b21910454e 276 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 277 * Bar bar;
Dannis_mbed 0:81b21910454e 278 *
Dannis_mbed 0:81b21910454e 279 * main() {
Dannis_mbed 0:81b21910454e 280 * pin.attach_asserted( &bar, &Bar::myCallback );
Dannis_mbed 0:81b21910454e 281 * }
Dannis_mbed 0:81b21910454e 282 *
Dannis_mbed 0:81b21910454e 283 * @endcode
Dannis_mbed 0:81b21910454e 284 *
Dannis_mbed 0:81b21910454e 285 * Call this function when a pin is asserted.
Dannis_mbed 0:81b21910454e 286 * @param object An object that conatins the callback method.
Dannis_mbed 0:81b21910454e 287 * @param method The method within the object to call.
Dannis_mbed 0:81b21910454e 288 */
Dannis_mbed 0:81b21910454e 289 template<typename T>
Dannis_mbed 0:81b21910454e 290 void attach_asserted(T *object, void (T::*member)(void)) {
Dannis_mbed 0:81b21910454e 291 _callbackAsserted.attach( object, member );
Dannis_mbed 0:81b21910454e 292 }
Dannis_mbed 0:81b21910454e 293
Dannis_mbed 0:81b21910454e 294 /** Attach a callback function
Dannis_mbed 0:81b21910454e 295 *
Dannis_mbed 0:81b21910454e 296 * @code
Dannis_mbed 0:81b21910454e 297 *
Dannis_mbed 0:81b21910454e 298 * DigitalOut led1( LED1 );
Dannis_mbed 0:81b21910454e 299 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 300 *
Dannis_mbed 0:81b21910454e 301 * void myCallback( void ) {
Dannis_mbed 0:81b21910454e 302 * led1 = 0;
Dannis_mbed 0:81b21910454e 303 * };
Dannis_mbed 0:81b21910454e 304 *
Dannis_mbed 0:81b21910454e 305 * main() {
Dannis_mbed 0:81b21910454e 306 * pin.attach_deasserted( &myCallback );
Dannis_mbed 0:81b21910454e 307 * }
Dannis_mbed 0:81b21910454e 308 *
Dannis_mbed 0:81b21910454e 309 * @endcode
Dannis_mbed 0:81b21910454e 310 *
Dannis_mbed 0:81b21910454e 311 * Call this function when a pin is deasserted.
Dannis_mbed 0:81b21910454e 312 * @param function A C function pointer
Dannis_mbed 0:81b21910454e 313 */
Dannis_mbed 0:81b21910454e 314 void attach_deasserted(void (*function)(void)) {
Dannis_mbed 0:81b21910454e 315 _callbackDeasserted.attach( function );
Dannis_mbed 0:81b21910454e 316 }
Dannis_mbed 0:81b21910454e 317
Dannis_mbed 0:81b21910454e 318 /** Attach a callback object/method
Dannis_mbed 0:81b21910454e 319 *
Dannis_mbed 0:81b21910454e 320 * @code
Dannis_mbed 0:81b21910454e 321 *
Dannis_mbed 0:81b21910454e 322 * class Bar {
Dannis_mbed 0:81b21910454e 323 * public:
Dannis_mbed 0:81b21910454e 324 * void myCallback( void ) { led1 = 0; }
Dannis_mbed 0:81b21910454e 325 * };
Dannis_mbed 0:81b21910454e 326 *
Dannis_mbed 0:81b21910454e 327 * DigitalOut led1( LED1 );
Dannis_mbed 0:81b21910454e 328 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 329 * Bar bar;
Dannis_mbed 0:81b21910454e 330 *
Dannis_mbed 0:81b21910454e 331 * main() {
Dannis_mbed 0:81b21910454e 332 * pin.attach_deasserted( &bar, &Bar::myCallback );
Dannis_mbed 0:81b21910454e 333 * }
Dannis_mbed 0:81b21910454e 334 *
Dannis_mbed 0:81b21910454e 335 * @endcode
Dannis_mbed 0:81b21910454e 336 *
Dannis_mbed 0:81b21910454e 337 * Call this function when a pin is deasserted.
Dannis_mbed 0:81b21910454e 338 * @param object An object that conatins the callback method.
Dannis_mbed 0:81b21910454e 339 * @param method The method within the object to call.
Dannis_mbed 0:81b21910454e 340 */
Dannis_mbed 0:81b21910454e 341 template<typename T>
Dannis_mbed 0:81b21910454e 342 void attach_deasserted(T *object, void (T::*member)(void)) {
Dannis_mbed 0:81b21910454e 343 _callbackDeasserted.attach( object, member );
Dannis_mbed 0:81b21910454e 344 }
Dannis_mbed 0:81b21910454e 345
Dannis_mbed 0:81b21910454e 346 /** Attach a callback function
Dannis_mbed 0:81b21910454e 347 *
Dannis_mbed 0:81b21910454e 348 * @code
Dannis_mbed 0:81b21910454e 349 *
Dannis_mbed 0:81b21910454e 350 * DigitalOut led2( LED2 );
Dannis_mbed 0:81b21910454e 351 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 352 *
Dannis_mbed 0:81b21910454e 353 * void myCallback( void ) {
Dannis_mbed 0:81b21910454e 354 * led2 = 1;
Dannis_mbed 0:81b21910454e 355 * };
Dannis_mbed 0:81b21910454e 356 *
Dannis_mbed 0:81b21910454e 357 * main() {
Dannis_mbed 0:81b21910454e 358 * pin.attach_asserted_held( &myCallback );
Dannis_mbed 0:81b21910454e 359 * }
Dannis_mbed 0:81b21910454e 360 *
Dannis_mbed 0:81b21910454e 361 * @endcode
Dannis_mbed 0:81b21910454e 362 *
Dannis_mbed 0:81b21910454e 363 * Call this function when a pin is asserted and held.
Dannis_mbed 0:81b21910454e 364 * @param function A C function pointer
Dannis_mbed 0:81b21910454e 365 */
Dannis_mbed 0:81b21910454e 366 void attach_asserted_held(void (*function)(void)) {
Dannis_mbed 0:81b21910454e 367 _callbackAssertedHeld.attach( function );
Dannis_mbed 0:81b21910454e 368 }
Dannis_mbed 0:81b21910454e 369
Dannis_mbed 0:81b21910454e 370 /** Attach a callback object/method
Dannis_mbed 0:81b21910454e 371 *
Dannis_mbed 0:81b21910454e 372 * @code
Dannis_mbed 0:81b21910454e 373 *
Dannis_mbed 0:81b21910454e 374 * class Bar {
Dannis_mbed 0:81b21910454e 375 * public:
Dannis_mbed 0:81b21910454e 376 * void myCallback( void ) { led2 = 0; }
Dannis_mbed 0:81b21910454e 377 * };
Dannis_mbed 0:81b21910454e 378 *
Dannis_mbed 0:81b21910454e 379 * DigitalOut led2( LED2 );
Dannis_mbed 0:81b21910454e 380 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 381 * Bar bar;
Dannis_mbed 0:81b21910454e 382 *
Dannis_mbed 0:81b21910454e 383 * main() {
Dannis_mbed 0:81b21910454e 384 * pin.attach_asserted_held( &bar, &Bar::myCallback );
Dannis_mbed 0:81b21910454e 385 * }
Dannis_mbed 0:81b21910454e 386 *
Dannis_mbed 0:81b21910454e 387 * @endcode
Dannis_mbed 0:81b21910454e 388 *
Dannis_mbed 0:81b21910454e 389 * Call this function when a pin is asserted and held.
Dannis_mbed 0:81b21910454e 390 * @param object An object that conatins the callback method.
Dannis_mbed 0:81b21910454e 391 * @param method The method within the object to call.
Dannis_mbed 0:81b21910454e 392 */
Dannis_mbed 0:81b21910454e 393 template<typename T>
Dannis_mbed 0:81b21910454e 394 void attach_asserted_held(T *object, void (T::*member)(void)) {
Dannis_mbed 0:81b21910454e 395 _callbackAssertedHeld.attach( object, member );
Dannis_mbed 0:81b21910454e 396 }
Dannis_mbed 0:81b21910454e 397
Dannis_mbed 0:81b21910454e 398 /** Attach a callback function
Dannis_mbed 0:81b21910454e 399 *
Dannis_mbed 0:81b21910454e 400 * @code
Dannis_mbed 0:81b21910454e 401 *
Dannis_mbed 0:81b21910454e 402 * DigitalOut led3( LED3 );
Dannis_mbed 0:81b21910454e 403 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 404 *
Dannis_mbed 0:81b21910454e 405 * void myCallback( void ) {
Dannis_mbed 0:81b21910454e 406 * led3 = 1;
Dannis_mbed 0:81b21910454e 407 * };
Dannis_mbed 0:81b21910454e 408 *
Dannis_mbed 0:81b21910454e 409 * main() {
Dannis_mbed 0:81b21910454e 410 * pin.attach_deasserted_held( &myCallback );
Dannis_mbed 0:81b21910454e 411 * }
Dannis_mbed 0:81b21910454e 412 *
Dannis_mbed 0:81b21910454e 413 * @endcode
Dannis_mbed 0:81b21910454e 414 *
Dannis_mbed 0:81b21910454e 415 * Call this function when a pin is deasserted and held.
Dannis_mbed 0:81b21910454e 416 * @param function A C function pointer
Dannis_mbed 0:81b21910454e 417 */
Dannis_mbed 0:81b21910454e 418 void attach_deasserted_held(void (*function)(void)) {
Dannis_mbed 0:81b21910454e 419 _callbackDeassertedHeld.attach( function );
Dannis_mbed 0:81b21910454e 420 }
Dannis_mbed 0:81b21910454e 421
Dannis_mbed 0:81b21910454e 422 /** Attach a callback object/method
Dannis_mbed 0:81b21910454e 423 *
Dannis_mbed 0:81b21910454e 424 * @code
Dannis_mbed 0:81b21910454e 425 *
Dannis_mbed 0:81b21910454e 426 * class Bar {
Dannis_mbed 0:81b21910454e 427 * public:
Dannis_mbed 0:81b21910454e 428 * void myCallback( void ) { led3 = 0; }
Dannis_mbed 0:81b21910454e 429 * };
Dannis_mbed 0:81b21910454e 430 *
Dannis_mbed 0:81b21910454e 431 * DigitalOut led3( LED3 );
Dannis_mbed 0:81b21910454e 432 * PinDetect pin( p30 );
Dannis_mbed 0:81b21910454e 433 * Bar bar;
Dannis_mbed 0:81b21910454e 434 *
Dannis_mbed 0:81b21910454e 435 * main() {
Dannis_mbed 0:81b21910454e 436 * pin.attach_deasserted_held( &bar, &Bar::myCallback );
Dannis_mbed 0:81b21910454e 437 * }
Dannis_mbed 0:81b21910454e 438 *
Dannis_mbed 0:81b21910454e 439 * @endcode
Dannis_mbed 0:81b21910454e 440 *
Dannis_mbed 0:81b21910454e 441 * Call this function when a pin is deasserted and held.
Dannis_mbed 0:81b21910454e 442 * @param object An object that conatins the callback method.
Dannis_mbed 0:81b21910454e 443 * @param method The method within the object to call.
Dannis_mbed 0:81b21910454e 444 */
Dannis_mbed 0:81b21910454e 445 template<typename T>
Dannis_mbed 0:81b21910454e 446 void attach_deasserted_held(T *object, void (T::*member)(void)) {
Dannis_mbed 0:81b21910454e 447 _callbackDeassertedHeld.attach( object, member );
Dannis_mbed 0:81b21910454e 448 }
Dannis_mbed 0:81b21910454e 449
Dannis_mbed 0:81b21910454e 450 /** operator int()
Dannis_mbed 0:81b21910454e 451 *
Dannis_mbed 0:81b21910454e 452 * Read the value of the pin being sampled.
Dannis_mbed 0:81b21910454e 453 */
Dannis_mbed 0:81b21910454e 454 operator int() { return _in->read(); }
Dannis_mbed 0:81b21910454e 455
Dannis_mbed 0:81b21910454e 456 protected:
Dannis_mbed 0:81b21910454e 457 /** The Ticker periodic callback function
Dannis_mbed 0:81b21910454e 458 */
Dannis_mbed 0:81b21910454e 459 void isr(void) {
Dannis_mbed 0:81b21910454e 460 int currentState = _in->read();
Dannis_mbed 0:81b21910454e 461
Dannis_mbed 0:81b21910454e 462 if ( currentState != _prevState ) {
Dannis_mbed 0:81b21910454e 463 if ( _samplesTillAssert == 0 ) {
Dannis_mbed 0:81b21910454e 464 _prevState = currentState;
Dannis_mbed 0:81b21910454e 465 _samplesTillHeld = _samplesTillHeldReload;
Dannis_mbed 0:81b21910454e 466 if ( currentState == _assertValue )
Dannis_mbed 0:81b21910454e 467 _callbackAsserted.call();
Dannis_mbed 0:81b21910454e 468 else
Dannis_mbed 0:81b21910454e 469 _callbackDeasserted.call();
Dannis_mbed 0:81b21910454e 470 }
Dannis_mbed 0:81b21910454e 471 else {
Dannis_mbed 0:81b21910454e 472 _samplesTillAssert--;
Dannis_mbed 0:81b21910454e 473 }
Dannis_mbed 0:81b21910454e 474 }
Dannis_mbed 0:81b21910454e 475 else {
Dannis_mbed 0:81b21910454e 476 _samplesTillAssert = _samplesTillAssertReload;
Dannis_mbed 0:81b21910454e 477 }
Dannis_mbed 0:81b21910454e 478
Dannis_mbed 0:81b21910454e 479 if ( _samplesTillHeld ) {
Dannis_mbed 0:81b21910454e 480 if ( _prevState == currentState ) {
Dannis_mbed 0:81b21910454e 481 _samplesTillHeld--;
Dannis_mbed 0:81b21910454e 482 if ( _samplesTillHeld == 0 ) {
Dannis_mbed 0:81b21910454e 483 if ( currentState == _assertValue )
Dannis_mbed 0:81b21910454e 484 _callbackAssertedHeld.call();
Dannis_mbed 0:81b21910454e 485 else
Dannis_mbed 0:81b21910454e 486 _callbackDeassertedHeld.call();
Dannis_mbed 0:81b21910454e 487 }
Dannis_mbed 0:81b21910454e 488 }
Dannis_mbed 0:81b21910454e 489 else {
Dannis_mbed 0:81b21910454e 490 _samplesTillHeld = 0;
Dannis_mbed 0:81b21910454e 491 }
Dannis_mbed 0:81b21910454e 492 }
Dannis_mbed 0:81b21910454e 493 }
Dannis_mbed 0:81b21910454e 494
Dannis_mbed 0:81b21910454e 495 };
Dannis_mbed 0:81b21910454e 496
Dannis_mbed 0:81b21910454e 497 }; // namespace AjK ends.
Dannis_mbed 0:81b21910454e 498
Dannis_mbed 0:81b21910454e 499 using namespace AjK;
Dannis_mbed 0:81b21910454e 500
Dannis_mbed 0:81b21910454e 501 #endif