SEAN O CONNELL / Mbed 2 deprecated mDot_LoRa_Sensornode

lora sensnode

Dependencies:   libmDot mbed-rtos mbed

Fork of mDot_LoRa_Sensornode by Adrian Mitevski

app/TaskProximity.h@1:e67174cc4953, 2016-08-10 (annotated)

Committer:
socie123
Date:
Wed Aug 10 12:54:10 2016 +0000
Revision:
1:e67174cc4953
Parent:
0:f2815503561f 
lora sensnode

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mitea1 0:f2815503561f 1 /**
mitea1 0:f2815503561f 2 * @file TaskProximity.h
mitea1 0:f2815503561f 3 *
mitea1 0:f2815503561f 4 * @author Adrian
mitea1 0:f2815503561f 5 * @date 03.06.2016
mitea1 0:f2815503561f 6 *
mitea1 0:f2815503561f 7 */
mitea1 0:f2815503561f 8 #include "SI1143.h"
mitea1 0:f2815503561f 9 #include "SI1143ProximityMessage.h"
mitea1 0:f2815503561f 10 #include "main.h"
mitea1 0:f2815503561f 11
mitea1 0:f2815503561f 12 #ifndef TASKPROXIMITY_H_
mitea1 0:f2815503561f 13 #define TASKPROXIMITY_H_
mitea1 0:f2815503561f 14
mitea1 0:f2815503561f 15 /**
mitea1 0:f2815503561f 16 * @class TaskProximity
mitea1 0:f2815503561f 17 * @brief This TaskProximity Class handles the proximity measurement using the SI1143.
mitea1 0:f2815503561f 18 * Starting the task using the start() starts the measurement.
mitea1 0:f2815503561f 19 * It can be used alongside with other measurement Tasks inside the mbed::rtos
mitea1 0:f2815503561f 20 * environment. The Task Class basically wraps mbeds Thread functionality.
mitea1 0:f2815503561f 21 */
mitea1 0:f2815503561f 22 class TaskProximity {
mitea1 0:f2815503561f 23 public:
mitea1 0:f2815503561f 24 TaskProximity(SI1143*,Mutex*,Queue<SI1143ProximityMessage,PROXIMITY_QUEUE_LENGHT>*);
mitea1 0:f2815503561f 25 TaskProximity(SI1143*,Mutex*,Queue<SI1143ProximityMessage,PROXIMITY_QUEUE_LENGHT>*,
mitea1 0:f2815503561f 26 osPriority, uint32_t, unsigned char*);
mitea1 0:f2815503561f 27 virtual ~TaskProximity();
mitea1 0:f2815503561f 28
mitea1 0:f2815503561f 29
mitea1 0:f2815503561f 30 /**
mitea1 0:f2815503561f 31 * @brief Starts the task by building it and connecting a callback function to
mitea1 0:f2815503561f 32 * the mbed::Thread
mitea1 0:f2815503561f 33 * @return
mitea1 0:f2815503561f 34 */
mitea1 0:f2815503561f 35 osStatus start();
mitea1 0:f2815503561f 36
mitea1 0:f2815503561f 37 /**
mitea1 0:f2815503561f 38 * @brief Stops the task. Should only be used after start() was used
mitea1 0:f2815503561f 39 * @return
mitea1 0:f2815503561f 40 */
mitea1 0:f2815503561f 41 osStatus stop();
mitea1 0:f2815503561f 42
mitea1 0:f2815503561f 43
mitea1 0:f2815503561f 44 /**
mitea1 0:f2815503561f 45 * @brief Gets the actual state of the Task either RUNNING or SLEEPING
mitea1 0:f2815503561f 46 * @return
mitea1 0:f2815503561f 47 */
mitea1 0:f2815503561f 48 TASK_STATE getState();
mitea1 0:f2815503561f 49
mitea1 0:f2815503561f 50 private:
mitea1 0:f2815503561f 51 rtos::Thread* thread;
mitea1 0:f2815503561f 52 rtos::Queue<SI1143ProximityMessage,PROXIMITY_QUEUE_LENGHT>* queue;
mitea1 0:f2815503561f 53 rtos::Mutex* mutexI2C ;
mitea1 0:f2815503561f 54 osPriority priority;
mitea1 0:f2815503561f 55 uint32_t stack_size;
mitea1 0:f2815503561f 56 unsigned char *stack_pointer;
mitea1 0:f2815503561f 57
mitea1 0:f2815503561f 58 TASK_STATE state;
mitea1 0:f2815503561f 59
mitea1 0:f2815503561f 60 SI1143* si1143;
mitea1 0:f2815503561f 61
mitea1 0:f2815503561f 62
mitea1 0:f2815503561f 63 /**
mitea1 0:f2815503561f 64 * @brief A Callback function thats called by the mbed::Thread of this TaskClass
mitea1 0:f2815503561f 65 * @param
mitea1 0:f2815503561f 66 */
mitea1 0:f2815503561f 67 static void callBack(void const *);
mitea1 0:f2815503561f 68
mitea1 0:f2815503561f 69 /**
mitea1 0:f2815503561f 70 * @brief A thread safe method that acquires data from the gyroscope. After acquiring data from the
mitea1 0:f2815503561f 71 * it stores the data inside a MPU9250GyroscopeMessage
mitea1 0:f2815503561f 72 */
mitea1 0:f2815503561f 73 void measureProximity();
mitea1 0:f2815503561f 74
mitea1 0:f2815503561f 75
mitea1 0:f2815503561f 76 /**
mitea1 0:f2815503561f 77 * @brief Sets the message Queue of the Task where the measured values will be stored
mitea1 0:f2815503561f 78 * after the measurement
mitea1 0:f2815503561f 79 * @param queueProximity the queue where the SI1143ProximityMessage will be stored
mitea1 0:f2815503561f 80 */
mitea1 0:f2815503561f 81 void setQueue(Queue<SI1143ProximityMessage,PROXIMITY_QUEUE_LENGHT>* queueProximity);
mitea1 0:f2815503561f 82
mitea1 0:f2815503561f 83 /**
mitea1 0:f2815503561f 84 * @brief Sets the mutex thats used for a thread safe measurement
mitea1 0:f2815503561f 85 * @param mutexI2C the I2C mutex
mitea1 0:f2815503561f 86 */
mitea1 0:f2815503561f 87 void setMutex(Mutex* mutexI2C);
mitea1 0:f2815503561f 88
mitea1 0:f2815503561f 89 /**
mitea1 0:f2815503561f 90 * @brief Sets the priority of the Task
mitea1 0:f2815503561f 91 * @param priority priority of the Task
mitea1 0:f2815503561f 92 */
mitea1 0:f2815503561f 93 void setPriority(osPriority priority);
mitea1 0:f2815503561f 94
mitea1 0:f2815503561f 95 /**
mitea1 0:f2815503561f 96 * @brief Sets the size of the Task
mitea1 0:f2815503561f 97 * @param stackSize the stack size in Bytes
mitea1 0:f2815503561f 98 */
mitea1 0:f2815503561f 99 void setStackSize(uint32_t stackSize);
mitea1 0:f2815503561f 100
mitea1 0:f2815503561f 101 /**
mitea1 0:f2815503561f 102 * @brief Sets the stack pointer of for the task stack
mitea1 0:f2815503561f 103 * @param stackPointer
mitea1 0:f2815503561f 104 */
mitea1 0:f2815503561f 105 void setStackPointer(unsigned char* stackPointer);
mitea1 0:f2815503561f 106
mitea1 0:f2815503561f 107
mitea1 0:f2815503561f 108 /**
mitea1 0:f2815503561f 109 * @brief Sets the actual state of the Task.
mitea1 0:f2815503561f 110 * @param taskState either RUNNING or SLEEPING
mitea1 0:f2815503561f 111 */
mitea1 0:f2815503561f 112 void setState(TASK_STATE);
mitea1 0:f2815503561f 113 };
mitea1 0:f2815503561f 114
mitea1 0:f2815503561f 115 #endif /* TASKPROXIMITY_H_ */