Modified for compatibility with Rev.E. hardware
Fork of AkmSensor by
Diff: ak7451ctrl.h
- Revision:
- 23:50c98b286e41
- Parent:
- 13:d008249f0359
- Child:
- 34:1ea3357c8d9a
--- a/ak7451ctrl.h Mon Apr 10 23:02:52 2017 +0000 +++ b/ak7451ctrl.h Thu Apr 13 22:15:54 2017 +0000 @@ -6,13 +6,19 @@ #include "akmsensor.h" #include "ak7451.h" +/** + * Class for handling commands issued to the AK7451. + */ class Ak7451Ctrl : public AkmSensor { public: - + + /** + * Device Sub-ID. + */ typedef enum { - SUB_ID_AK7451 = 0x01, + SUB_ID_AK7451 = 0x01, /**< AK7451: ID = 01h */ } SubIdAngleSensor; /** @@ -26,19 +32,76 @@ * */ virtual ~Ak7451Ctrl(); + + /** + * Process for intializing the selected sensor. + * + * @return Termination status type for debugging purposes. + */ virtual AkmSensor::Status init(const uint8_t id, const uint8_t subid); + + /** + * Simple flag process to determine if an event has occurred. + * + * @return TRUE if event has occurred, FALSE if not. + */ virtual bool isEvent(); + + /** + * Process abstraction for starting sensor operation. + * + * @return Termination status type for debugging purposes. + */ virtual AkmSensor::Status startSensor(); + + /** + * Process abstraction for starting sensor operation. + * + * @param sec Number of seconds of operation. + * @return Termination status type for debugging purposes. + */ virtual AkmSensor::Status startSensor(const float sec); + + /** + * Process abstraction for stopping sensor operation. + * + * @return Termination status type for debugging purposes. + */ virtual AkmSensor::Status stopSensor(); + + /** + * Process abstraction for reading data from the sensor. + * + * @param msg Message object that will hold the sensor data. + * @return Termination status type for debugging purposes. + */ virtual AkmSensor::Status readSensorData(Message* msg); + + /** + * Primary process for interfacing a sensor with the AKDP. When implemented + * in sensor class, it will transfer commands between the the sensor control + * class and AkmSensorManager. + * + * @param in Command message to be processed by sensor. + * @param out Message returned from sensor. + * @return Termination status type for debugging purposes. + */ virtual Status requestCommand(Message* in, Message* out); + + /** + * Get the name of the sensor in char format. + * + * @return Sensor name as a char array. + */ virtual char* getSensorName(); + /** + * Callback function for handling sensor events. + */ void eventCallback(); private: - bool event; + bool event; uint8_t primaryId; uint8_t subId; char* sensorName;