Taylor Street / AkmSensor

Modified for compatibility with Rev.E. hardware

Fork of AkmSensor by AKM Development Platform

ak7401ctrl.h@49:c8f8946129b6, 2018-05-01 (annotated)

Committer:
tkstreet
Date:
Tue May 01 21:31:15 2018 +0000
Revision:
49:c8f8946129b6
Parent:
48:427bdb7bf31b 
Modified for Rev.E. compatibility.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
masahikofukasawa 10:5c69b067d88a 1 #ifndef AK7401CTRL_H
masahikofukasawa 10:5c69b067d88a 2 #define AK7401CTRL_H
masahikofukasawa 10:5c69b067d88a 3
masahikofukasawa 10:5c69b067d88a 4 #include "mbed.h"
masahikofukasawa 10:5c69b067d88a 5 #include "akmsensor.h"
masahikofukasawa 10:5c69b067d88a 6 #include "ak7401.h"
tkstreet 43:45225713cd58 7 //#include "akdp_debug.h"
masahikofukasawa 10:5c69b067d88a 8
tkstreet 23:50c98b286e41 9 /**
tkstreet 23:50c98b286e41 10 * Class for handling commands issued to the AK7401.
tkstreet 23:50c98b286e41 11 */
masahikofukasawa 10:5c69b067d88a 12 class Ak7401Ctrl : public AkmSensor
masahikofukasawa 10:5c69b067d88a 13 {
masahikofukasawa 10:5c69b067d88a 14
masahikofukasawa 10:5c69b067d88a 15 public:
masahikofukasawa 29:b488d2c89fba 16
masahikofukasawa 29:b488d2c89fba 17 typedef AkmSensor base;
masahikofukasawa 10:5c69b067d88a 18
tkstreet 23:50c98b286e41 19 /**
tkstreet 23:50c98b286e41 20 * Device Sub-ID.
tkstreet 23:50c98b286e41 21 */
masahikofukasawa 10:5c69b067d88a 22 typedef enum {
tkstreet 23:50c98b286e41 23 SUB_ID_AK7401 = 0x02, /**< AK7401: ID = 02h */
masahikofukasawa 10:5c69b067d88a 24 } SubIdAngleSensor;
masahikofukasawa 10:5c69b067d88a 25
masahikofukasawa 10:5c69b067d88a 26 /**
masahikofukasawa 10:5c69b067d88a 27 * Constructor.
masahikofukasawa 10:5c69b067d88a 28 *
masahikofukasawa 10:5c69b067d88a 29 */
masahikofukasawa 10:5c69b067d88a 30 Ak7401Ctrl();
masahikofukasawa 10:5c69b067d88a 31
masahikofukasawa 10:5c69b067d88a 32 /**
masahikofukasawa 10:5c69b067d88a 33 * Destructor.
masahikofukasawa 10:5c69b067d88a 34 *
masahikofukasawa 10:5c69b067d88a 35 */
masahikofukasawa 10:5c69b067d88a 36 virtual ~Ak7401Ctrl();
tkstreet 23:50c98b286e41 37
tkstreet 23:50c98b286e41 38 /**
tkstreet 23:50c98b286e41 39 * Process for intializing the selected sensor.
tkstreet 23:50c98b286e41 40 *
tkstreet 23:50c98b286e41 41 * @return Termination status type for debugging purposes.
tkstreet 23:50c98b286e41 42 */
masahikofukasawa 10:5c69b067d88a 43 virtual AkmSensor::Status init(const uint8_t id, const uint8_t subid);
tkstreet 23:50c98b286e41 44
tkstreet 23:50c98b286e41 45 /**
tkstreet 23:50c98b286e41 46 * Process abstraction for starting sensor operation.
tkstreet 23:50c98b286e41 47 *
tkstreet 23:50c98b286e41 48 * @return Termination status type for debugging purposes.
tkstreet 23:50c98b286e41 49 */
masahikofukasawa 10:5c69b067d88a 50 virtual AkmSensor::Status startSensor();
tkstreet 23:50c98b286e41 51
tkstreet 23:50c98b286e41 52 /**
tkstreet 23:50c98b286e41 53 * Process abstraction for starting sensor operation.
tkstreet 23:50c98b286e41 54 *
tkstreet 23:50c98b286e41 55 * @param sec Number of seconds of operation.
tkstreet 23:50c98b286e41 56 * @return Termination status type for debugging purposes.
tkstreet 23:50c98b286e41 57 */
masahikofukasawa 10:5c69b067d88a 58 virtual AkmSensor::Status startSensor(const float sec);
tkstreet 23:50c98b286e41 59
tkstreet 23:50c98b286e41 60 /**
tkstreet 23:50c98b286e41 61 * Process abstraction for stopping sensor operation.
tkstreet 23:50c98b286e41 62 *
tkstreet 23:50c98b286e41 63 * @return Termination status type for debugging purposes.
tkstreet 23:50c98b286e41 64 */
masahikofukasawa 10:5c69b067d88a 65 virtual AkmSensor::Status stopSensor();
tkstreet 23:50c98b286e41 66
tkstreet 23:50c98b286e41 67 /**
tkstreet 23:50c98b286e41 68 * Process abstraction for reading data from the sensor.
tkstreet 23:50c98b286e41 69 *
tkstreet 23:50c98b286e41 70 * @param msg Message object that will hold the sensor data.
tkstreet 23:50c98b286e41 71 * @return Termination status type for debugging purposes.
tkstreet 23:50c98b286e41 72 */
masahikofukasawa 10:5c69b067d88a 73 virtual AkmSensor::Status readSensorData(Message* msg);
tkstreet 23:50c98b286e41 74
tkstreet 23:50c98b286e41 75 /**
tkstreet 23:50c98b286e41 76 * Primary process for interfacing a sensor with the AKDP. When implemented
tkstreet 23:50c98b286e41 77 * in sensor class, it will transfer commands between the the sensor control
tkstreet 23:50c98b286e41 78 * class and AkmSensorManager.
tkstreet 23:50c98b286e41 79 *
tkstreet 23:50c98b286e41 80 * @param in Command message to be processed by sensor.
tkstreet 23:50c98b286e41 81 * @param out Message returned from sensor.
tkstreet 23:50c98b286e41 82 * @return Termination status type for debugging purposes.
tkstreet 23:50c98b286e41 83 */
masahikofukasawa 10:5c69b067d88a 84 virtual Status requestCommand(Message* in, Message* out);
masahikofukasawa 13:d008249f0359 85
masahikofukasawa 27:41aa9fb23a2f 86 private:
masahikofukasawa 10:5c69b067d88a 87 Ticker ticker;
masahikofukasawa 10:5c69b067d88a 88 AK7401* ak7401;
masahikofukasawa 10:5c69b067d88a 89 float interval;
masahikofukasawa 10:5c69b067d88a 90 };
masahikofukasawa 10:5c69b067d88a 91
masahikofukasawa 10:5c69b067d88a 92 #endif