AP_Compass_AK09916.h

Go to the documentation of this file.

/*
 * This file is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This file is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#pragma once

#include <AP_Common/AP_Common.h>
#include <AP_HAL/AP_HAL.h>
#include <AP_HAL/I2CDevice.h>
#include <AP_Math/AP_Math.h>

#include "AP_Compass.h"
#include "AP_Compass_Backend.h"

#ifndef HAL_COMPASS_AK09916_I2C_ADDR
# define HAL_COMPASS_AK09916_I2C_ADDR 0x0C
#endif

// the AK09916 can be connected via an ICM20948
#ifndef HAL_COMPASS_ICM20948_I2C_ADDR
# define HAL_COMPASS_ICM20948_I2C_ADDR 0x69
#endif

class AP_Compass_AK09916 : public AP_Compass_Backend
{
public:
    static AP_Compass_Backend *probe(Compass &compass,
                                     AP_HAL::OwnPtr<AP_HAL::I2CDevice> dev,
                                     bool force_external = false,
                                     enum Rotation rotation = ROTATION_NONE);

    // separate probe function for when behind a ICM20948 IMU
    static AP_Compass_Backend *probe_ICM20948(Compass &compass,
                                              AP_HAL::OwnPtr<AP_HAL::I2CDevice> dev,
                                              AP_HAL::OwnPtr<AP_HAL::I2CDevice> dev_icm,
                                              bool force_external = false,
                                              enum Rotation rotation = ROTATION_NONE);
    
    void read() override;

    static constexpr const char *name = "AK09916";

private:
    enum bus_type {
        AK09916_I2C=0,
        AK09916_ICM20948_I2C,
    } bus_type;
    
    AP_Compass_AK09916(Compass &compass,
                       AP_HAL::OwnPtr<AP_HAL::Device> dev,
                       AP_HAL::OwnPtr<AP_HAL::Device> dev_icm,
                       bool force_external,
                       enum Rotation rotation,
                       enum bus_type bus_type);

    AP_HAL::OwnPtr<AP_HAL::Device> dev;
    AP_HAL::OwnPtr<AP_HAL::Device> dev_icm;
    
    bool init();
    void timer();

    uint8_t compass_instance;
    Vector3f accum;
    uint16_t accum_count;
    bool force_external;
    enum Rotation rotation;
};