Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/hal/api/Timeout.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bryantaylor 0:eafc3fd41f75 1 /* mbed Microcontroller Library
bryantaylor 0:eafc3fd41f75 2 * Copyright (c) 2006-2013 ARM Limited
bryantaylor 0:eafc3fd41f75 3 *
bryantaylor 0:eafc3fd41f75 4 * Licensed under the Apache License, Version 2.0 (the "License");
bryantaylor 0:eafc3fd41f75 5 * you may not use this file except in compliance with the License.
bryantaylor 0:eafc3fd41f75 6 * You may obtain a copy of the License at
bryantaylor 0:eafc3fd41f75 7 *
bryantaylor 0:eafc3fd41f75 8 * http://www.apache.org/licenses/LICENSE-2.0
bryantaylor 0:eafc3fd41f75 9 *
bryantaylor 0:eafc3fd41f75 10 * Unless required by applicable law or agreed to in writing, software
bryantaylor 0:eafc3fd41f75 11 * distributed under the License is distributed on an "AS IS" BASIS,
bryantaylor 0:eafc3fd41f75 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bryantaylor 0:eafc3fd41f75 13 * See the License for the specific language governing permissions and
bryantaylor 0:eafc3fd41f75 14 * limitations under the License.
bryantaylor 0:eafc3fd41f75 15 */
bryantaylor 0:eafc3fd41f75 16 #ifndef MBED_TIMEOUT_H
bryantaylor 0:eafc3fd41f75 17 #define MBED_TIMEOUT_H
bryantaylor 0:eafc3fd41f75 18
bryantaylor 0:eafc3fd41f75 19 #include "Ticker.h"
bryantaylor 0:eafc3fd41f75 20
bryantaylor 0:eafc3fd41f75 21 namespace mbed {
bryantaylor 0:eafc3fd41f75 22
bryantaylor 0:eafc3fd41f75 23 /** A Timeout is used to call a function at a point in the future
bryantaylor 0:eafc3fd41f75 24 *
bryantaylor 0:eafc3fd41f75 25 * You can use as many seperate Timeout objects as you require.
bryantaylor 0:eafc3fd41f75 26 *
bryantaylor 0:eafc3fd41f75 27 * @Note Synchronization level: Interrupt safe
bryantaylor 0:eafc3fd41f75 28 *
bryantaylor 0:eafc3fd41f75 29 * Example:
bryantaylor 0:eafc3fd41f75 30 * @code
bryantaylor 0:eafc3fd41f75 31 * // Blink until timeout.
bryantaylor 0:eafc3fd41f75 32 *
bryantaylor 0:eafc3fd41f75 33 * #include "mbed.h"
bryantaylor 0:eafc3fd41f75 34 *
bryantaylor 0:eafc3fd41f75 35 * Timeout timeout;
bryantaylor 0:eafc3fd41f75 36 * DigitalOut led(LED1);
bryantaylor 0:eafc3fd41f75 37 *
bryantaylor 0:eafc3fd41f75 38 * int on = 1;
bryantaylor 0:eafc3fd41f75 39 *
bryantaylor 0:eafc3fd41f75 40 * void attimeout() {
bryantaylor 0:eafc3fd41f75 41 * on = 0;
bryantaylor 0:eafc3fd41f75 42 * }
bryantaylor 0:eafc3fd41f75 43 *
bryantaylor 0:eafc3fd41f75 44 * int main() {
bryantaylor 0:eafc3fd41f75 45 * timeout.attach(&attimeout, 5);
bryantaylor 0:eafc3fd41f75 46 * while(on) {
bryantaylor 0:eafc3fd41f75 47 * led = !led;
bryantaylor 0:eafc3fd41f75 48 * wait(0.2);
bryantaylor 0:eafc3fd41f75 49 * }
bryantaylor 0:eafc3fd41f75 50 * }
bryantaylor 0:eafc3fd41f75 51 * @endcode
bryantaylor 0:eafc3fd41f75 52 */
bryantaylor 0:eafc3fd41f75 53 class Timeout : public Ticker {
bryantaylor 0:eafc3fd41f75 54
bryantaylor 0:eafc3fd41f75 55 protected:
bryantaylor 0:eafc3fd41f75 56 virtual void handler();
bryantaylor 0:eafc3fd41f75 57 };
bryantaylor 0:eafc3fd41f75 58
bryantaylor 0:eafc3fd41f75 59 } // namespace mbed
bryantaylor 0:eafc3fd41f75 60
bryantaylor 0:eafc3fd41f75 61 #endif