Jhon Plantikow / mbed

.

Dependents:   RTC

Timer.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:88e313c910d0 1 /* mbed Microcontroller Library
jhon309 0:88e313c910d0 2 * Copyright (c) 2006-2013 ARM Limited
jhon309 0:88e313c910d0 3 *
jhon309 0:88e313c910d0 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:88e313c910d0 5 * you may not use this file except in compliance with the License.
jhon309 0:88e313c910d0 6 * You may obtain a copy of the License at
jhon309 0:88e313c910d0 7 *
jhon309 0:88e313c910d0 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:88e313c910d0 9 *
jhon309 0:88e313c910d0 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:88e313c910d0 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:88e313c910d0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:88e313c910d0 13 * See the License for the specific language governing permissions and
jhon309 0:88e313c910d0 14 * limitations under the License.
jhon309 0:88e313c910d0 15 */
jhon309 0:88e313c910d0 16 #ifndef MBED_TIMER_H
jhon309 0:88e313c910d0 17 #define MBED_TIMER_H
jhon309 0:88e313c910d0 18
jhon309 0:88e313c910d0 19 #include "platform.h"
jhon309 0:88e313c910d0 20 #include "ticker_api.h"
jhon309 0:88e313c910d0 21
jhon309 0:88e313c910d0 22 namespace mbed {
jhon309 0:88e313c910d0 23
jhon309 0:88e313c910d0 24 /** A general purpose timer
jhon309 0:88e313c910d0 25 *
jhon309 0:88e313c910d0 26 * Example:
jhon309 0:88e313c910d0 27 * @code
jhon309 0:88e313c910d0 28 * // Count the time to toggle a LED
jhon309 0:88e313c910d0 29 *
jhon309 0:88e313c910d0 30 * #include "mbed.h"
jhon309 0:88e313c910d0 31 *
jhon309 0:88e313c910d0 32 * Timer timer;
jhon309 0:88e313c910d0 33 * DigitalOut led(LED1);
jhon309 0:88e313c910d0 34 * int begin, end;
jhon309 0:88e313c910d0 35 *
jhon309 0:88e313c910d0 36 * int main() {
jhon309 0:88e313c910d0 37 * timer.start();
jhon309 0:88e313c910d0 38 * begin = timer.read_us();
jhon309 0:88e313c910d0 39 * led = !led;
jhon309 0:88e313c910d0 40 * end = timer.read_us();
jhon309 0:88e313c910d0 41 * printf("Toggle the led takes %d us", end - begin);
jhon309 0:88e313c910d0 42 * }
jhon309 0:88e313c910d0 43 * @endcode
jhon309 0:88e313c910d0 44 */
jhon309 0:88e313c910d0 45 class Timer {
jhon309 0:88e313c910d0 46
jhon309 0:88e313c910d0 47 public:
jhon309 0:88e313c910d0 48 Timer();
jhon309 0:88e313c910d0 49 Timer(const ticker_data_t *data);
jhon309 0:88e313c910d0 50
jhon309 0:88e313c910d0 51 /** Start the timer
jhon309 0:88e313c910d0 52 */
jhon309 0:88e313c910d0 53 void start();
jhon309 0:88e313c910d0 54
jhon309 0:88e313c910d0 55 /** Stop the timer
jhon309 0:88e313c910d0 56 */
jhon309 0:88e313c910d0 57 void stop();
jhon309 0:88e313c910d0 58
jhon309 0:88e313c910d0 59 /** Reset the timer to 0.
jhon309 0:88e313c910d0 60 *
jhon309 0:88e313c910d0 61 * If it was already counting, it will continue
jhon309 0:88e313c910d0 62 */
jhon309 0:88e313c910d0 63 void reset();
jhon309 0:88e313c910d0 64
jhon309 0:88e313c910d0 65 /** Get the time passed in seconds
jhon309 0:88e313c910d0 66 */
jhon309 0:88e313c910d0 67 float read();
jhon309 0:88e313c910d0 68
jhon309 0:88e313c910d0 69 /** Get the time passed in mili-seconds
jhon309 0:88e313c910d0 70 */
jhon309 0:88e313c910d0 71 int read_ms();
jhon309 0:88e313c910d0 72
jhon309 0:88e313c910d0 73 /** Get the time passed in micro-seconds
jhon309 0:88e313c910d0 74 */
jhon309 0:88e313c910d0 75 int read_us();
jhon309 0:88e313c910d0 76
jhon309 0:88e313c910d0 77 #ifdef MBED_OPERATORS
jhon309 0:88e313c910d0 78 operator float();
jhon309 0:88e313c910d0 79 #endif
jhon309 0:88e313c910d0 80
jhon309 0:88e313c910d0 81 protected:
jhon309 0:88e313c910d0 82 int slicetime();
jhon309 0:88e313c910d0 83 int _running; // whether the timer is running
jhon309 0:88e313c910d0 84 unsigned int _start; // the start time of the latest slice
jhon309 0:88e313c910d0 85 int _time; // any accumulated time from previous slices
jhon309 0:88e313c910d0 86 const ticker_data_t *_ticker_data;
jhon309 0:88e313c910d0 87 };
jhon309 0:88e313c910d0 88
jhon309 0:88e313c910d0 89 } // namespace mbed
jhon309 0:88e313c910d0 90
jhon309 0:88e313c910d0 91 #endif