Modified for compatibility with Rev.E. hardware

Fork of AkmSensor by AKM Development Platform

ak9752ctrl.h

Committer:
tkstreet
Date:
2018-05-01
Revision:
49:c8f8946129b6
Parent:
39:3821886c902e

File content as of revision 49:c8f8946129b6:

#ifndef AK9752CTRL_H
#define AK9752CTRL_H

#include "mbed.h"
#include "akmsensor.h"
#include "AK9752.h"

/**
 * Class for handling commands issued to the AK9752.
 */
class Ak9752Ctrl : public AkmSensor
{

public:
    
    typedef AkmSensor base;

    /**
     * Device Sub-ID
     */
    typedef enum {
        SUB_ID_AK9752              = 0x02       /**< AK9752: 02h */
    } SubIdAk9752;

    /**
     * Constructor.
     *
     */
    Ak9752Ctrl();

    /**
     * Destructor.
     *
     */
    virtual ~Ak9752Ctrl();
    
    /**
     * 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 event flag.
     */
    virtual void setEvent();

private:
    AK9752*         ak9752;
    
    // hold settings
    AK9752::OperationMode mode;
    AK9752::FcTmp fc_tmp;
    AK9752::FcIr fc_ir;
};

#endif