From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.
Dependents: motor_driver motor_driver_screaming_fix
drivers/Timeout.h@0:083111ae2a11, 2020-11-26 (annotated)
- Committer:
- saloutos
- Date:
- Thu Nov 26 04:08:56 2020 +0000
- Revision:
- 0:083111ae2a11
first commit of leaned mbed dev lib
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
saloutos | 0:083111ae2a11 | 1 | /* mbed Microcontroller Library |
saloutos | 0:083111ae2a11 | 2 | * Copyright (c) 2006-2013 ARM Limited |
saloutos | 0:083111ae2a11 | 3 | * |
saloutos | 0:083111ae2a11 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
saloutos | 0:083111ae2a11 | 5 | * you may not use this file except in compliance with the License. |
saloutos | 0:083111ae2a11 | 6 | * You may obtain a copy of the License at |
saloutos | 0:083111ae2a11 | 7 | * |
saloutos | 0:083111ae2a11 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
saloutos | 0:083111ae2a11 | 9 | * |
saloutos | 0:083111ae2a11 | 10 | * Unless required by applicable law or agreed to in writing, software |
saloutos | 0:083111ae2a11 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
saloutos | 0:083111ae2a11 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
saloutos | 0:083111ae2a11 | 13 | * See the License for the specific language governing permissions and |
saloutos | 0:083111ae2a11 | 14 | * limitations under the License. |
saloutos | 0:083111ae2a11 | 15 | */ |
saloutos | 0:083111ae2a11 | 16 | #ifndef MBED_TIMEOUT_H |
saloutos | 0:083111ae2a11 | 17 | #define MBED_TIMEOUT_H |
saloutos | 0:083111ae2a11 | 18 | |
saloutos | 0:083111ae2a11 | 19 | #include "drivers/Ticker.h" |
saloutos | 0:083111ae2a11 | 20 | #include "platform/NonCopyable.h" |
saloutos | 0:083111ae2a11 | 21 | #include "platform/mbed_sleep.h" |
saloutos | 0:083111ae2a11 | 22 | |
saloutos | 0:083111ae2a11 | 23 | namespace mbed { |
saloutos | 0:083111ae2a11 | 24 | /** \addtogroup drivers */ |
saloutos | 0:083111ae2a11 | 25 | |
saloutos | 0:083111ae2a11 | 26 | /** A Timeout is used to call a function at a point in the future |
saloutos | 0:083111ae2a11 | 27 | * |
saloutos | 0:083111ae2a11 | 28 | * You can use as many seperate Timeout objects as you require. |
saloutos | 0:083111ae2a11 | 29 | * |
saloutos | 0:083111ae2a11 | 30 | * @note Synchronization level: Interrupt safe |
saloutos | 0:083111ae2a11 | 31 | * |
saloutos | 0:083111ae2a11 | 32 | * Example: |
saloutos | 0:083111ae2a11 | 33 | * @code |
saloutos | 0:083111ae2a11 | 34 | * // Blink until timeout. |
saloutos | 0:083111ae2a11 | 35 | * |
saloutos | 0:083111ae2a11 | 36 | * #include "mbed.h" |
saloutos | 0:083111ae2a11 | 37 | * |
saloutos | 0:083111ae2a11 | 38 | * Timeout timeout; |
saloutos | 0:083111ae2a11 | 39 | * DigitalOut led(LED1); |
saloutos | 0:083111ae2a11 | 40 | * |
saloutos | 0:083111ae2a11 | 41 | * int on = 1; |
saloutos | 0:083111ae2a11 | 42 | * |
saloutos | 0:083111ae2a11 | 43 | * void attimeout() { |
saloutos | 0:083111ae2a11 | 44 | * on = 0; |
saloutos | 0:083111ae2a11 | 45 | * } |
saloutos | 0:083111ae2a11 | 46 | * |
saloutos | 0:083111ae2a11 | 47 | * int main() { |
saloutos | 0:083111ae2a11 | 48 | * timeout.attach(&attimeout, 5); |
saloutos | 0:083111ae2a11 | 49 | * while(on) { |
saloutos | 0:083111ae2a11 | 50 | * led = !led; |
saloutos | 0:083111ae2a11 | 51 | * wait(0.2); |
saloutos | 0:083111ae2a11 | 52 | * } |
saloutos | 0:083111ae2a11 | 53 | * } |
saloutos | 0:083111ae2a11 | 54 | * @endcode |
saloutos | 0:083111ae2a11 | 55 | * @ingroup drivers |
saloutos | 0:083111ae2a11 | 56 | */ |
saloutos | 0:083111ae2a11 | 57 | class Timeout : public Ticker, private NonCopyable<Timeout> { |
saloutos | 0:083111ae2a11 | 58 | |
saloutos | 0:083111ae2a11 | 59 | protected: |
saloutos | 0:083111ae2a11 | 60 | virtual void handler(); |
saloutos | 0:083111ae2a11 | 61 | }; |
saloutos | 0:083111ae2a11 | 62 | |
saloutos | 0:083111ae2a11 | 63 | } // namespace mbed |
saloutos | 0:083111ae2a11 | 64 | |
saloutos | 0:083111ae2a11 | 65 | #endif |