BMX160Config.h

Go to the documentation of this file.

/* Copyright (c) 2020 Skyward Experimental Rocketry
 * Author: Davide Mor
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
namespace Boardcore
{
 
struct BMX160Config
{
    enum class FifoMode
    {
        DISABLED,    
        HEADERLESS,  
        HEADER       
    };
 
    enum class FifoInterruptPin
    {
 
        DISABLED,  
        PIN_INT1,  
        PIN_INT2,  
    };
 
    enum class AccelerometerRange
    {
        G_2  = 0x3,  
        G_4  = 0x5,  
        G_8  = 0x8,  
        G_16 = 0xC   
    };
 
    enum class GyroscopeRange
    {
        DEG_2000 = 0x0,  
        DEG_1000 = 0x1,  
        DEG_500  = 0x2,  
        DEG_250  = 0x3,  
        DEG_125  = 0x4   
    };
 
    enum class GyroscopeMeasureUnit
    {
        DEG,  
        RAD   
    };
 
    enum class OutputDataRate
    {
        HZ_0_78125 = 0x01,  
        HZ_1_5625  = 0x02,  
        HZ_3_125   = 0x03,  
        HZ_6_25    = 0x04,  
        HZ_12_5    = 0x05,  
        HZ_25      = 0x06,  
        HZ_50      = 0x07,  
        HZ_100     = 0x08,  
        HZ_200     = 0x09,  
        HZ_400     = 0x0A,  
        HZ_800     = 0x0B,  
        HZ_1600    = 0x0C,  
        HZ_3200    = 0x0D,  
    };
 
    enum class BandwidthParameter
    {
        NORMAL = 0x20,  
        OSR2   = 0x10,  
        OSR4   = 0x00,  
    };
 
    enum class IntMode
    {
        PUSH_PULL,   
        OPEN_DRAIN,  
    };
 
    uint8_t fifoWatermark = -1;
 
    uint8_t magnetometerRepetitionsXY = 0x04;
 
    uint8_t magnetometerRepetitionsZ = 0x0E;
 
    bool enableCompensation = true;
 
    int temperatureDivider = 0;
 
    bool fifoAccelerometerFiltered = true;
 
    uint8_t fifoAccelerationDownsampling = 0;
 
    bool fifoGyroscopeFiltered = true;
 
    uint8_t fifoGyroscopeDownsampling = 0;
 
    FifoMode fifoMode              = FifoMode::DISABLED;
    FifoInterruptPin fifoInterrupt = FifoInterruptPin::DISABLED;
 
    OutputDataRate accelerometerDataRate      = OutputDataRate::HZ_100;
    BandwidthParameter accelerometerBandwidth = BandwidthParameter::NORMAL;
    AccelerometerRange accelerometerRange     = AccelerometerRange::G_2;
 
    OutputDataRate gyroscopeDataRate      = OutputDataRate::HZ_100;
    BandwidthParameter gyroscopeBandwidth = BandwidthParameter::NORMAL;
    GyroscopeRange gyroscopeRange         = GyroscopeRange::DEG_2000;
    GyroscopeMeasureUnit gyroscopeUnit    = GyroscopeMeasureUnit::RAD;
 
    OutputDataRate magnetometerRate = OutputDataRate::HZ_100;
 
    IntMode interrupt1Mode = IntMode::PUSH_PULL;
    IntMode interrupt2Mode = IntMode::PUSH_PULL;
 
    BMX160Config() {}
};
 
}  // namespace Boardcore