spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/api/Timeout.h@5:ea7377f3d1af, 2017-10-11 (annotated)

Committer:
Pokitto
Date:
Wed Oct 11 20:35:27 2017 +0000
Revision:
5:ea7377f3d1af
Fixed PokittoLib. Includes a working custom mbed-src

Who changed what in which revision?

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