David Saul / mbed-dev-bin

R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more information

Fork of mbed-dev-bin by Lancaster University

Timer.h@4:98796b85dcf3, 2017-05-23 (annotated)

Committer:
DavidMS
Date:
Tue May 23 12:27:33 2017 +0000
Revision:
4:98796b85dcf3
Parent:
0:e1a608bb55e8 
basic_microbit_tx_train_controller_code: R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more details

Who changed what in which revision?

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