Modified for compatibility with Rev.E. hardware
Fork of AkmSensor by
Diff: ak9750ctrl.h
- Revision:
- 34:1ea3357c8d9a
- Parent:
- 30:5a241d9b3262
- Parent:
- 23:50c98b286e41
- Child:
- 39:3821886c902e
--- a/ak9750ctrl.h Fri Apr 28 20:32:31 2017 +0000 +++ b/ak9750ctrl.h Wed May 03 18:00:45 2017 +0000 @@ -5,6 +5,9 @@ #include "akmsensor.h" #include "AK9750.h" +/** + * Class for handling commands issued to the AK9750/AK9753. + */ class Ak9750Ctrl : public AkmSensor { @@ -12,9 +15,12 @@ typedef AkmSensor base; + /** + * Device Sub-IDs. + */ typedef enum { - SUB_ID_AK9750 = 0x01, - SUB_ID_AK9753 = 0x03, + SUB_ID_AK9750 = 0x01, /**< AK9750: ID = 01h */ + SUB_ID_AK9753 = 0x03, /**< AK9753: ID = 03h */ } SubIdIrSensor; /** @@ -28,14 +34,60 @@ * */ virtual ~Ak9750Ctrl(); + + /** + * 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); + + /** + * 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 AkmSensor::Status requestCommand(Message* in, Message* out); + + /** + * Set the event flag. + */ virtual void setEvent(); - + private: AK9750* ak9750; // InterruptIn* interrupt;