Abdulaziz alsalloum / Project1HomeAlertSystem

Home Alert System

Dependencies:   PWM_Tone_Library DHT

mbed-rtos/rtos/RtosTimer.h@5:569a4894abc1, 2019-03-08 (annotated)

Committer:
aziz111
Date:
Fri Mar 08 17:15:02 2019 +0000
Revision:
5:569a4894abc1
Parent:
3:78f223d34f36 
Final

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ethaderu 3:78f223d34f36 1 /* mbed Microcontroller Library
ethaderu 3:78f223d34f36 2 * Copyright (c) 2006-2012 ARM Limited
ethaderu 3:78f223d34f36 3 *
ethaderu 3:78f223d34f36 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
ethaderu 3:78f223d34f36 5 * of this software and associated documentation files (the "Software"), to deal
ethaderu 3:78f223d34f36 6 * in the Software without restriction, including without limitation the rights
ethaderu 3:78f223d34f36 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ethaderu 3:78f223d34f36 8 * copies of the Software, and to permit persons to whom the Software is
ethaderu 3:78f223d34f36 9 * furnished to do so, subject to the following conditions:
ethaderu 3:78f223d34f36 10 *
ethaderu 3:78f223d34f36 11 * The above copyright notice and this permission notice shall be included in
ethaderu 3:78f223d34f36 12 * all copies or substantial portions of the Software.
ethaderu 3:78f223d34f36 13 *
ethaderu 3:78f223d34f36 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ethaderu 3:78f223d34f36 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ethaderu 3:78f223d34f36 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ethaderu 3:78f223d34f36 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ethaderu 3:78f223d34f36 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ethaderu 3:78f223d34f36 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
ethaderu 3:78f223d34f36 20 * SOFTWARE.
ethaderu 3:78f223d34f36 21 */
ethaderu 3:78f223d34f36 22 #ifndef RTOS_TIMER_H
ethaderu 3:78f223d34f36 23 #define RTOS_TIMER_H
ethaderu 3:78f223d34f36 24
ethaderu 3:78f223d34f36 25 #include <stdint.h>
ethaderu 3:78f223d34f36 26 #include "cmsis_os.h"
ethaderu 3:78f223d34f36 27
ethaderu 3:78f223d34f36 28 namespace rtos {
ethaderu 3:78f223d34f36 29
ethaderu 3:78f223d34f36 30 /** The RtosTimer class allow creating and and controlling of timer functions in the system.
ethaderu 3:78f223d34f36 31 A timer function is called when a time period expires whereby both on-shot and
ethaderu 3:78f223d34f36 32 periodic timers are possible. A timer can be started, restarted, or stopped.
ethaderu 3:78f223d34f36 33
ethaderu 3:78f223d34f36 34 Timers are handled in the thread osTimerThread.
ethaderu 3:78f223d34f36 35 Callback functions run under control of this thread and may use CMSIS-RTOS API calls.
ethaderu 3:78f223d34f36 36 */
ethaderu 3:78f223d34f36 37 class RtosTimer {
ethaderu 3:78f223d34f36 38 public:
ethaderu 3:78f223d34f36 39 /** Create and Start timer.
ethaderu 3:78f223d34f36 40 @param task name of the timer call back function.
ethaderu 3:78f223d34f36 41 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
ethaderu 3:78f223d34f36 42 @param argument argument to the timer call back function. (default: NULL)
ethaderu 3:78f223d34f36 43 */
ethaderu 3:78f223d34f36 44 RtosTimer(void (*task)(void const *argument),
ethaderu 3:78f223d34f36 45 os_timer_type type=osTimerPeriodic,
ethaderu 3:78f223d34f36 46 void *argument=NULL);
ethaderu 3:78f223d34f36 47
ethaderu 3:78f223d34f36 48 /** Stop the timer.
ethaderu 3:78f223d34f36 49 @return status code that indicates the execution status of the function.
ethaderu 3:78f223d34f36 50 */
ethaderu 3:78f223d34f36 51 osStatus stop(void);
ethaderu 3:78f223d34f36 52
ethaderu 3:78f223d34f36 53 /** start a timer.
ethaderu 3:78f223d34f36 54 @param millisec time delay value of the timer.
ethaderu 3:78f223d34f36 55 @return status code that indicates the execution status of the function.
ethaderu 3:78f223d34f36 56 */
ethaderu 3:78f223d34f36 57 osStatus start(uint32_t millisec);
ethaderu 3:78f223d34f36 58
ethaderu 3:78f223d34f36 59 ~RtosTimer();
ethaderu 3:78f223d34f36 60
ethaderu 3:78f223d34f36 61 private:
ethaderu 3:78f223d34f36 62 osTimerId _timer_id;
ethaderu 3:78f223d34f36 63 osTimerDef_t _timer;
ethaderu 3:78f223d34f36 64 #ifdef CMSIS_OS_RTX
ethaderu 3:78f223d34f36 65 uint32_t _timer_data[5];
ethaderu 3:78f223d34f36 66 #endif
ethaderu 3:78f223d34f36 67 };
ethaderu 3:78f223d34f36 68
ethaderu 3:78f223d34f36 69 }
ethaderu 3:78f223d34f36 70
ethaderu 3:78f223d34f36 71 #endif