sfDevCY8CMBR3.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
// include the sparkfun toolkit headers
#include <sfTk/sfToolkit.h>
 
// Bus interfaces
#include <sfTk/sfTkII2C.h>
// I2C Addressing
const uint8_t kCY8CMBR3DefaultAddr = 0x37; // I2C address for the CY8CMBR3 device.
const uint8_t kCY8CMBR3MinAddr = 0x08;     // Minimum I2C address for the CY8CMBR3 device.
const uint8_t kCY8CMBR3MaxAddr = 0x77;     // Maximum I2C address for the CY8CMBR3 device.
 
// These are the default expeced ID values for the 102 device (CY8CMBR3102)
const uint8_t kDefaultCY8CMBR3102FamilyID = 0x9A; // When polling the FAMILY_ID register, this should be returned on boot.
const uint16_t kDefaultCY8CMBR3102DeviceID = 0xA01; // When polling the DEVICE_ID register, this should be returned on boot.
 
// Register Map
const uint8_t ksfCY8CMBR3RegSensorEn = 0x00;
const uint8_t ksfCY8CMBR3RegFssEn = 0x02;
const uint8_t ksfCY8CMBR3RegToggleEn = 0x04;
const uint8_t ksfCY8CMBR3RegLedOnEn = 0x06;
const uint8_t ksfCY8CMBR3RegSensitivity0 = 0x08;
const uint8_t ksfCY8CMBR3RegSensitivity1 = 0x09;
const uint8_t ksfCY8CMBR3RegSensitivity2 = 0x0A;
const uint8_t ksfCY8CMBR3RegSensitivity3 = 0x0B;
const uint8_t ksfCY8CMBR3RegBaseThreshold0 = 0x0C;
const uint8_t ksfCY8CMBR3RegBaseThreshold1 = 0x0D;
const uint8_t ksfCY8CMBR3RegFingerThreshold2 = 0x0E;
const uint8_t ksfCY8CMBR3RegFingerThreshold3 = 0x0F;
const uint8_t ksfCY8CMBR3RegFingerThreshold4 = 0x10;
const uint8_t ksfCY8CMBR3RegFingerThreshold5 = 0x11;
const uint8_t ksfCY8CMBR3RegFingerThreshold6 = 0x12;
const uint8_t ksfCY8CMBR3RegFingerThreshold7 = 0x13;
const uint8_t ksfCY8CMBR3RegFingerThreshold8 = 0x14;
const uint8_t ksfCY8CMBR3RegFingerThreshold9 = 0x15;
const uint8_t ksfCY8CMBR3RegFingerThreshold10 = 0x16;
const uint8_t ksfCY8CMBR3RegFingerThreshold11 = 0x17;
const uint8_t ksfCY8CMBR3RegFingerThreshold12 = 0x18;
const uint8_t ksfCY8CMBR3RegFingerThreshold13 = 0x19;
const uint8_t ksfCY8CMBR3RegFingerThreshold14 = 0x1A;
const uint8_t ksfCY8CMBR3RegFingerThreshold15 = 0x1B;
const uint8_t ksfCY8CMBR3RegSensorDebounce = 0x1C;
const uint8_t ksfCY8CMBR3RegButtonHys = 0x1D;
const uint8_t ksfCY8CMBR3RegButtonLbr = 0x1F;
const uint8_t ksfCY8CMBR3RegButtonNnt = 0x20;
const uint8_t ksfCY8CMBR3RegButtonNt = 0x21;
const uint8_t ksfCY8CMBR3RegProxEn = 0x26;
const uint8_t ksfCY8CMBR3RegProxCfg = 0x27;
const uint8_t ksfCY8CMBR3RegProxCfg2 = 0x28;
const uint8_t ksfCY8CMBR3RegProxTouchTh0 = 0x2A;
const uint8_t ksfCY8CMBR3RegProxTouchTh1 = 0x2C;
const uint8_t ksfCY8CMBR3RegProxResolution0 = 0x2E;
const uint8_t ksfCY8CMBR3RegProxResolution1 = 0x2F;
const uint8_t ksfCY8CMBR3RegProxHys = 0x30;
const uint8_t ksfCY8CMBR3RegProxLbr = 0x32;
const uint8_t ksfCY8CMBR3RegProxNnt = 0x33;
const uint8_t ksfCY8CMBR3RegProxNt = 0x34;
const uint8_t ksfCY8CMBR3RegProxPositiveTh0 = 0x35;
const uint8_t ksfCY8CMBR3RegProxPositiveTh1 = 0x36;
const uint8_t ksfCY8CMBR3RegProxNegativeTh0 = 0x39;
const uint8_t ksfCY8CMBR3RegProxNegativeTh1 = 0x3A;
const uint8_t ksfCY8CMBR3RegLedOnTime = 0x3D;
const uint8_t ksfCY8CMBR3RegBuzzerCfg = 0x3E;
const uint8_t ksfCY8CMBR3RegBuzzerOnTime = 0x3F;
const uint8_t ksfCY8CMBR3RegGpoCfg = 0x40;
const uint8_t ksfCY8CMBR3RegPwmDutyCycleCfg0 = 0x41;
const uint8_t ksfCY8CMBR3RegPwmDutyCycleCfg1 = 0x42;
const uint8_t ksfCY8CMBR3RegPwmDutyCycleCfg2 = 0x43;
const uint8_t ksfCY8CMBR3RegPwmDutyCycleCfg3 = 0x44;
const uint8_t ksfCY8CMBR3RegPwmDutyCycleCfg4 = 0x45;
const uint8_t ksfCY8CMBR3RegPwmDutyCycleCfg5 = 0x46;
const uint8_t ksfCY8CMBR3RegPwmDutyCycleCfg6 = 0x47;
const uint8_t ksfCY8CMBR3RegPwmDutyCycleCfg7 = 0x48;
const uint8_t ksfCY8CMBR3RegSpoCfg = 0x4C;
const uint8_t ksfCY8CMBR3RegDeviceCfg0 = 0x4D;
const uint8_t ksfCY8CMBR3RegDeviceCfg1 = 0x4E;
const uint8_t ksfCY8CMBR3RegDeviceCfg2 = 0x4F;
const uint8_t ksfCY8CMBR3RegDeviceCfg3 = 0x50;
const uint8_t ksfCY8CMBR3RegI2cAddr = 0x51;
const uint8_t ksfCY8CMBR3RegRefreshCtrl = 0x52;
const uint8_t ksfCY8CMBR3RegStateTimeout = 0x55;
const uint8_t ksfCY8CMBR3RegSliderCfg = 0x5D;
const uint8_t ksfCY8CMBR3RegSlider1Cfg = 0x61;
const uint8_t ksfCY8CMBR3RegSlider1Resolution = 0x62;
const uint8_t ksfCY8CMBR3RegSlider1Threshold = 0x63;
const uint8_t ksfCY8CMBR3RegSlider2Cfg = 0x67;
const uint8_t ksfCY8CMBR3RegSlider2Resolution = 0x68;
const uint8_t ksfCY8CMBR3RegSlider2Threshold = 0x69;
const uint8_t ksfCY8CMBR3RegSliderLbr = 0x71;
const uint8_t ksfCY8CMBR3RegSliderNnt = 0x72;
const uint8_t ksfCY8CMBR3RegSliderNt = 0x73;
const uint8_t ksfCY8CMBR3RegScratchpad0 = 0x7A;
const uint8_t ksfCY8CMBR3RegScratchpad1 = 0x7B;
const uint8_t ksfCY8CMBR3RegConfigCrc = 0x7E;
const uint8_t ksfCY8CMBR3RegGpoOutputState = 0x80;
const uint8_t ksfCY8CMBR3RegSensorId = 0x82;
const uint8_t ksfCY8CMBR3RegCtrlCmd = 0x86;
const uint8_t ksfCY8CMBR3RegCtrlCmdStatus = 0x88;
const uint8_t ksfCY8CMBR3RegCtrlCmdErr = 0x89;
const uint8_t ksfCY8CMBR3RegSystemStatus = 0x8A;
const uint8_t ksfCY8CMBR3RegPrevCtrlCmdCode = 0x8C;
const uint8_t ksfCY8CMBR3RegFamilyId = 0x8F;
const uint8_t ksfCY8CMBR3RegDeviceId = 0x90;
const uint8_t ksfCY8CMBR3RegDeviceRev = 0x92;
const uint8_t ksfCY8CMBR3RegCalcCrc = 0x94;
const uint8_t ksfCY8CMBR3RegTotalWorkingSns = 0x97;
const uint8_t ksfCY8CMBR3RegSnsCpHigh = 0x98;
const uint8_t ksfCY8CMBR3RegSnsVddShort = 0x9A;
const uint8_t ksfCY8CMBR3RegSnsGndShort = 0x9C;
const uint8_t ksfCY8CMBR3RegSnsSnsShort = 0x9E;
const uint8_t ksfCY8CMBR3RegCmodShieldTest = 0xA0;
const uint8_t ksfCY8CMBR3RegButtonStat = 0xAA;
const uint8_t ksfCY8CMBR3RegLatchedButtonStat = 0xAC;
const uint8_t ksfCY8CMBR3RegProxStat = 0xAE;
const uint8_t ksfCY8CMBR3RegLatchedProxStat = 0xAF;
const uint8_t ksfCY8CMBR3RegSlider1Position = 0xB0;
const uint8_t ksfCY8CMBR3RegLiftoffSlider1Position = 0xB1;
const uint8_t ksfCY8CMBR3RegSlider2Position = 0xB2;
const uint8_t ksfCY8CMBR3RegLiftoffSlider2Position = 0xB3;
const uint8_t ksfCY8CMBR3RegSyncCounter0 = 0xB9;
const uint8_t ksfCY8CMBR3RegDiffCnt0 = 0xBA;
const uint8_t ksfCY8CMBR3RegDiffCnt1 = 0xBC;
const uint8_t ksfCY8CMBR3RegDiffCnt2 = 0xBE;
const uint8_t ksfCY8CMBR3RegDiffCnt3 = 0xC0;
const uint8_t ksfCY8CMBR3RegDiffCnt4 = 0xC2;
const uint8_t ksfCY8CMBR3RegDiffCnt5 = 0xC4;
const uint8_t ksfCY8CMBR3RegDiffCnt6 = 0xC6;
const uint8_t ksfCY8CMBR3RegDiffCnt7 = 0xC8;
const uint8_t ksfCY8CMBR3RegDiffCnt8 = 0xCA;
const uint8_t ksfCY8CMBR3RegDiffCnt9 = 0xCC;
const uint8_t ksfCY8CMBR3RegDiffCnt10 = 0xCE;
const uint8_t ksfCY8CMBR3RegDiffCnt11 = 0xD0;
const uint8_t ksfCY8CMBR3RegDiffCnt12 = 0xD2;
const uint8_t ksfCY8CMBR3RegDiffCnt13 = 0xD4;
const uint8_t ksfCY8CMBR3RegDiffCnt14 = 0xD6;
const uint8_t ksfCY8CMBR3RegDiffCnt15 = 0xD8;
const uint8_t ksfCY8CMBR3RegGpoData = 0xDA;
const uint8_t ksfCY8CMBR3RegSyncCounter1 = 0xDB;
const uint8_t ksfCY8CMBR3RegDebugSensorId = 0xDC;
const uint8_t ksfCY8CMBR3RegDebugCp = 0xDD;
const uint8_t ksfCY8CMBR3RegDebugDiffCnt0 = 0xDE;
const uint8_t ksfCY8CMBR3RegDebugBaseline0 = 0xE0;
const uint8_t ksfCY8CMBR3RegDebugRawCnt0 = 0xE2;
const uint8_t ksfCY8CMBR3RegDebugAvgRawCnt0 = 0xE4;
const uint8_t ksfCY8CMBR3RegSyncCounter2 = 0xE7;
 
// Register Bit Definitions
//
// Feel free to submit a PR to add additional bitfield definitions and functions 
// as needed. For now, this library focuses on the registers necessary for basic
// operation with the CY8CMBR3 for soil moisture sensing.
 
// SENSOR_EN: Capacitive sensor enable/disable configuration.
typedef union {
    struct {
        uint8_t CS0: 1;
        uint8_t CS1: 1;
        uint8_t CS2: 1;
        uint8_t CS3: 1;
        uint8_t CS4: 1;
        uint8_t CS5: 1;
        uint8_t CS6: 1;
        uint8_t CS7: 1;
        uint8_t CS8: 1;
        uint8_t CS9: 1;
        uint8_t CS10: 1;
        uint8_t CS11: 1;
        uint8_t CS12: 1;
        uint8_t CS13: 1;
        uint8_t CS14: 1;
        uint8_t CS15: 1;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_sensor_en_t;
 
// TOGGLE_EN: GPO toggle enable/disable.
typedef union {
    struct {
        uint8_t GPO0: 1;
        uint8_t GPO1: 1;
        uint8_t GPO2: 1;
        uint8_t GPO3: 1;
        uint8_t GPO4: 1;
        uint8_t GPO5: 1;
        uint8_t GPO6: 1;
        uint8_t GPO7: 1;
        uint8_t reserved: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_toggle_en_t;
 
// LED_ON_EN: GPO extended LED ON duration enable/disable.
typedef union {
    struct {
        uint8_t GPO0: 1;
        uint8_t GPO1: 1;
        uint8_t GPO2: 1;
        uint8_t GPO3: 1;
        uint8_t GPO4: 1;
        uint8_t GPO5: 1;
        uint8_t GPO6: 1;
        uint8_t GPO7: 1;
        uint8_t reserved: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_led_on_en_t;
 
// SENSITIVITY0: Sensitivities (units: counts/pF) for button sensors 0 - 3
typedef union {
    struct {
        uint8_t CS0_SENSITIVITY: 2;
        uint8_t CS1_SENSITIVITY: 2;
        uint8_t CS2_SENSITIVITY: 2;
        uint8_t CS3_SENSITIVITY: 2;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_sensitivity0_t;
 
// BASE_THRESHOLDx: Base threshold for button sensors 0 - 1
typedef union {
    struct {
        uint8_t CS_BASE_THRESHOLD: 8;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_base_threshold_t;
 
// FINGER_THRESHOLDx: Finger threshold for button sensors 2 - 15
typedef union {
    struct {
        uint8_t CS_FINGER_THRESHOLD: 8;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_finger_threshold_t;
 
// BUTTON_HYS: Button hysteresis
typedef union {
    struct {
        uint8_t BUTTON_HYSTERESIS: 5;
        uint8_t RESERVED: 2;
        uint8_t OVERRIDE: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_button_hys_t;
 
// BUTTON_LBR: Button low baseline reset
typedef union {
    struct {
        uint8_t LOW_BASELINE_RESET_THRESHOLD: 7;
        uint8_t OVERRIDE: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_button_lbr_t;
 
// BUTTON_NNT: Button negative noise threshold
typedef union {
    struct {
        uint8_t NEGATIVE_NOISE_THRESHOLD: 7;
        uint8_t OVERRIDE: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_button_nnt_t;
 
// BUTTON_NT: Button noise threshold
typedef union {
    struct {
        uint8_t NOISE_THRESHOLD: 7;
        uint8_t OVERRIDE: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_button_nt_t;
 
// PROX_EN: Proximity sensor enable/disable configuration.
typedef union {
    struct {
        uint8_t PS0: 1;
        uint8_t PS1: 1;
        uint8_t reserved: 6;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_en_t;
 
// ALP_FILTER_EN
// RESERVED
// PS1_WAKE_ON_APPROACH
// PS0_WAKE_ON_APPROACH
 
// PROX_CFG: Proximity sensor configuration
typedef union {
    struct {
        uint8_t PS0_WAKE_ON_APPROACH: 1;
        uint8_t PS1_WAKE_ON_APPROACH: 1;
        uint8_t RESERVED: 5;
        uint8_t ALP_FILTER_EN: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_cfg_t;
 
// PROX_CFG2: Proximity sensor configuration 2
typedef union {
    struct {
        uint8_t ALP_FILTER_K: 3;
        uint8_t RESERVED: 5;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_cfg2_t;
 
// PROX_RESOLUTIONx: Proximity sensor resolution for PS0 - PS1
typedef union {
    struct {
        uint8_t PROX_RESOLUTION: 3;
        uint8_t RESERVED: 5;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_resolution_t;
 
// PROX_HYS: Proximity sensor hysteresis
typedef union {
    struct {
        uint8_t PROX_HYSTERESIS: 7;
        uint8_t RESERVED: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_hys_t;
 
// PROX_LBR: Proximity sensor low baseline reset
typedef union {
    struct {
        uint8_t LOW_BASELINE_RESET_THRESHOLD: 7;
        uint8_t OVERRIDE: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_lbr_t;
 
// PROX_NNT: Proximity sensor negative noise threshold
typedef union {
    struct {
        uint8_t NEGATIVE_NOISE_THRESHOLD: 7;
        uint8_t OVERRIDE: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_nnt_t;
 
// PROX_NT: Proximity sensor noise threshold
typedef union {
    struct {
        uint8_t NOISE_THRESHOLD: 7;
        uint8_t OVERRIDE: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_nt_t;
 
// LED_ON_TIME: LED on time configuration
typedef union {
    struct {
        uint8_t LED_ON_TIME: 7;
        uint8_t RESERVED: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_led_on_time_t;
 
// GPO_CFG: GPO configuration
typedef union {
    struct {
        uint8_t GPO_CTL: 1; // 0: GPO controlled by CS status, 1: GPO controlled by host via GPO_OUTPUT_STATE register
        uint8_t GPO_PWM: 1; // 0: GPO output DC, 1: GPO output PWM
        uint8_t DRIVE_MODE: 1; // 0: high = Hi-Z, low = strong drive; 1: high = strong drive, low = strong drive
        uint8_t ACTIVE_STATE: 1; // 0: active low, 1: active high
        uint8_t RESERVED: 4;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_gpo_cfg_t;
 
// PWM_DUTYCYCLE_CFGx: PWM duty cycle configuration for GPO0 - GPO7
typedef union {
    struct {
        uint8_t HIGH_DUTY_CYCLE: 4;
        uint8_t LOW_DUTY_CYCLE: 4;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_pwm_dutycycle_cfg_t;
 
// SPO_CFG: Secial purpose output configuration
typedef union {
    struct {
        uint8_t SPO0: 3; // 0: disabled, 1: cap sens, 2: shield elec, 3: buzzer, 4: host int, 5: GPO
        uint8_t RESERVED0: 1;
        uint8_t SPO1: 3;
        uint8_t RESERVED1: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_spo_cfg_t;
 
// DEVICE_CFG0: Button sensing filter enable/disable
typedef union {
    struct {
        uint8_t MED_EN: 1;
        uint8_t IIR_EN: 1;
        uint8_t RESERVED: 6;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_device_cfg0_t;
 
// DEVICE_CFG1: System diagnostics enable/disable
typedef union {
    struct {
        uint8_t SYSD_EN: 1;
        uint8_t RESERVED: 7;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_device_cfg1_t;
 
// DEVICE_CFG2: Global sensing and processing configuration
// PROXIMITY_ARST BUTTON_SLD_ARST ATH_EN EMC_EN GUARD_EN SHIELD_EN
typedef union {
    struct {
        uint8_t SHIELD_EN: 1;
        uint8_t GUARD_EN: 1;
        uint8_t EMC_EN: 1;
        uint8_t ATH_EN: 1;
        uint8_t BUTTON_SLD_ARST: 2; // 0: auto-reset disabled, 1: auto-reset enabled 5sec timeout
        uint8_t PROXIMITY_ARST: 2;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_device_cfg2_t;
 
// DEVICE_CFG3: Device Power Configuration
typedef union {
    struct {
        uint8_t LOW_POWER_MODE: 1; // 0: 1.8-5.5V internally regulated, 1: 1.8V externally regulated
        uint8_t RESERVED: 7;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_device_cfg3_t;
 
// I2C_ADDR: I2C Address configuration
typedef union {
    struct {
        uint8_t I2C_ADDRESS: 7; // 7-bit I2C address
        uint8_t RESERVED: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_i2c_addr_t;
 
// REFRESH_CTRL: Refresh control configuration
typedef union {
    struct {
        uint8_t REFRESH_INTERVAL: 6; // Units of 20 ms
        uint8_t RESERVED: 2;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_refresh_ctrl_t;
 
// STATE_TIMEOUT: Timeout (units: seconds) of no touch activity in Active mode to trigger mode transition
typedef union {
    struct {
        uint8_t TIMEOUT: 6;
        uint8_t RESERVED: 2;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_state_timeout_t;
 
// CONFIG_CRC: Configuration CRC value
typedef union {
    struct {
        uint8_t CRC_LSB: 8;
        uint8_t CRC_MSB: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_config_crc_t;
 
// GPO_OUTPUT_STATE: GPO output state control
typedef union {
    struct {
        uint8_t GPO0: 1;
        uint8_t GPO1: 1;
        uint8_t GPO2: 1;
        uint8_t GPO3: 1;
        uint8_t GPO4: 1;
        uint8_t GPO5: 1;
        uint8_t GPO6: 1;
        uint8_t GPO7: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_gpo_output_state_t;
 
// DEVICE_ID: Device ID register
typedef union {
    struct {
        uint8_t DEVICE_ID_LSB: 8;
        uint8_t DEVICE_ID_MSB: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_device_id_t;
 
// DEVICE_REV: Device revision register
typedef union {
    struct {
        uint8_t REVISION: 8;
        uint8_t reserved: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_device_rev_t;
 
// TOTAL_WORKING_SNS: System diagnostics results summary
typedef union {
    struct {
        uint8_t SENSOR_COUNT: 5;
        uint8_t RESERVED: 2;
        uint8_t SYSD_ERR: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_total_working_sns_t;
 
// BUTTON_STAT: Button sensor status
typedef union {
    struct {
        uint8_t CS0: 1;
        uint8_t CS1: 1;
        uint8_t CS2: 1;
        uint8_t CS3: 1;
        uint8_t CS4: 1;
        uint8_t CS5: 1;
        uint8_t CS6: 1;
        uint8_t CS7: 1;
        uint8_t CS8: 1;
        uint8_t CS9: 1;
        uint8_t CS10: 1;
        uint8_t CS11: 1;
        uint8_t CS12: 1;
        uint8_t CS13: 1;
        uint8_t CS14: 1;
        uint8_t CS15: 1;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_button_stat_t;
 
// LATCHED_BUTTON_STAT: Latched button sensor status
typedef union {
    struct {
        uint8_t CS0: 1;
        uint8_t CS1: 1;
        uint8_t CS2: 1;
        uint8_t CS3: 1;
        uint8_t CS4: 1;
        uint8_t CS5: 1;
        uint8_t CS6: 1;
        uint8_t CS7: 1;
        uint8_t CS8: 1;
        uint8_t CS9: 1;
        uint8_t CS10: 1;
        uint8_t CS11: 1;
        uint8_t CS12: 1;
        uint8_t CS13: 1;
        uint8_t CS14: 1;
        uint8_t CS15: 1;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_latched_button_stat_t;
 
// PROX_STAT: Proximity sensor status
typedef union {
    struct {
        uint8_t PS0: 1;
        uint8_t PS1: 1;
        uint8_t RESERVED: 6;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_prox_stat_t;
 
// LATCHED_PROX_STAT: Latched proximity sensor status
typedef union {
    struct {
        uint8_t PS0: 1;
        uint8_t PS1: 1;
        uint8_t RESERVED: 6;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_latched_prox_stat_t;
 
// SYNC_COUNTER0: Synchronization counter 0
typedef union {
    struct {
        uint8_t COUNTER: 4;
        uint8_t RESERVED: 4;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_sync_counter0_t;
 
// DIFFERENCE_COUNT_SENSOR0: Difference count for sensor 0
typedef union {
    struct {
        uint8_t DIFF_COUNT_LSB: 8;
        uint8_t DIFF_COUNT_MSB: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_diff_cnt_t;
 
// GPO_DATA: Current GPO state values
typedef union {
    struct {
        uint8_t GPO0: 1;
        uint8_t GPO1: 1;
        uint8_t GPO2: 1;
        uint8_t GPO3: 1;
        uint8_t GPO4: 1;
        uint8_t GPO5: 1;
        uint8_t GPO6: 1;
        uint8_t GPO7: 1;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_gpo_data_t;
 
// SYNC_COUNTER1: Synchronization counter 1
typedef union {
    struct {
        uint8_t COUNTER: 4;
        uint8_t RESERVED: 4;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_sync_counter1_t;
 
// DEBUG_CP: Debug capacitor measurement
typedef uint8_t sfe_cy8cmbr3_reg_debug_cp_t;
 
// DEBUG_DIFFERENCE_COUNT0: Debug difference count for sensor 0
typedef union {
    struct {
        uint8_t DIFF_COUNT_LSB: 8;
        uint8_t DIFF_COUNT_MSB: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_debug_diff_cnt_t;
 
// DEBUG_BASELINE0: Debug baseline count for sensor 0
typedef union {
    struct {
        uint8_t BASELINE_LSB: 8;
        uint8_t BASELINE_MSB: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_debug_baseline_t;
 
// DEBUG_RAW_COUNT0: Debug raw count for sensor 0
typedef union {
    struct {
        uint8_t RAW_COUNT_LSB: 8;
        uint8_t RAW_COUNT_MSB: 8;
    };
    uint16_t word;
} sfe_cy8cmbr3_reg_debug_raw_cnt_t;
 
// SYNC_COUNTER2: Synchronization counter 2
typedef union {
    struct {
        uint8_t COUNTER: 4;
        uint8_t RESERVED: 4;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_sync_counter2_t;
 
// SYSTEM_STATUS: System configuration status indicators
typedef union {
    struct {
        uint8_t F_DEFAULT: 1; // Indicates if default configuration is loaded
        uint8_t RESERVED: 7;
    };
    uint8_t byte;
} sfe_cy8cmbr3_reg_system_status_t;
 
// Enum Definitions
//
// Feel free to submit a PR to add additional enum definitions and functions 
// as needed. For now, this library focuses on the registers necessary for basic
// operation with the CY8CMBR3 for soil moisture sensing.
typedef enum {
    SID_0 = 0x00,
    SID_1 = 0x01,
    SID_2 = 0x02,
    SID_3 = 0x03,
    SID_4 = 0x04,
    SID_5 = 0x05,
    SID_6 = 0x06,
    SID_7 = 0x07,
    SID_8 = 0x08,
    SID_9 = 0x09,
    SID_10 = 0x0A,
    SID_11 = 0x0B,
    SID_12 = 0x0C,
    SID_13 = 0x0D,
    SID_14 = 0x0E,
    SID_15 = 0x0F,
    SID_INVALID = 0xFF
} sfe_cy8cmbr3_sensor_id_t;
 
typedef enum {
    CS_SENSITIVITY_500_COUNTS_PER_PF = 0, // 50 counts/0.1pF
    CS_SENSITIVITY_250_COUNTS_PER_PF = 1, // 50 counts/0.2pF
    CS_SENSITIVITY_167_COUNTS_PER_PF = 2, // 50 counts/0.3pF
    CS_SENSITIVITY_125_COUNTS_PER_PF = 3 // 50 counts/0.4pF
} sfe_cy8cmbr3_sensitivity_t;
 
typedef enum {
    // note: for the CY8CMBR3102 which is used in our soil moisture sensor, GPO_0 is the only valid GPO
    // and is tied to the LED
    GPO_0 = 0, 
    GPO_1 = 1,
    GPO_2 = 2,
    GPO_3 = 3,
    GPO_4 = 4,
    GPO_5 = 5,
    GPO_6 = 6,
    GPO_7 = 7
} sfe_cy8cmbr3_gpo_t; 
 
typedef enum {
    REFRESH_INTERVAL_20MS = 1,
    REFRESH_INTERVAL_40MS = 2,
    REFRESH_INTERVAL_60MS = 3,
    REFRESH_INTERVAL_80MS = 4,
    REFRESH_INTERVAL_100MS = 5,
    REFRESH_INTERVAL_120MS = 6,
    REFRESH_INTERVAL_140MS = 7,
    REFRESH_INTERVAL_160MS = 8,
    REFRESH_INTERVAL_180MS = 9,
    REFRESH_INTERVAL_200MS = 10,
    REFRESH_INTERVAL_220MS = 11,
    REFRESH_INTERVAL_240MS = 12,
    REFRESH_INTERVAL_260MS = 13,
    REFRESH_INTERVAL_280MS = 14,
    REFRESH_INTERVAL_300MS = 15,
    REFRESH_INTERVAL_320MS = 16,
    REFRESH_INTERVAL_340MS = 17,
    REFRESH_INTERVAL_360MS = 18,
    REFRESH_INTERVAL_380MS = 19,
    REFRESH_INTERVAL_400MS = 20,
    REFRESH_INTERVAL_420MS = 21,
    REFRESH_INTERVAL_440MS = 22,
    REFRESH_INTERVAL_460MS = 23,
    REFRESH_INTERVAL_480MS = 24,
    REFRESH_INTERVAL_500MS = 25
} sfe_cy8cmbr3_refresh_interval_t;
 
// Host commands for the CTRL_CMD register
typedef enum {
    CTRL_CMD_NO_OP = 0,
    CTRL_CMD_SAVE_CONFIG = 2, //Checks CONFIG_CRC vs. a calculated CRC; if they match, saves current config to non-volatile memory
    CTRL_CMD_CALC_CRC = 3, //Calculates CRC over config registers and stores result in CALC_CRC register
    CTRL_CMD_DEEP_SLEEP = 7, //Puts device into Deep Sleep mode
    CTRL_CMD_RESET_LATCH = 8, //Resets all latched button and proximity status bits
    CTRL_CMD_ALP_RESET_PS0 = 9, //Resets ALP filter for proximity sensor 0
    CTRL_CMD_ALP_RESET_PS1 = 10, //Resets ALP filter for proximity sensor 1
    CTRL_CMD_SW_RESET = 255 //Performs a software reset of the entire device
} sfe_cy8cmbr3_ctrl_cmd_t;
 
// Host command errors
typedef enum {
    CTRL_CMD_ERR_NO_ERROR = 0,
    CTRL_CMD_ERR_SAVE_FAILED = 253,
    CTRL_CMD_ERR_CRC_FAILED = 254,
    CTRL_CMD_ERR_INVALID_CMD = 255
} sfe_cy8cmbr3_ctrl_cmd_err_t;
 
typedef enum {
    SPO_DISABLED = 0,
    SPO_CAP_SENSE = 1,
    SPO_SHIELD_ELEC = 2,
    SPO_BUZZER = 3,
    SPO_HOST_INT = 4,
    SPO_GPO = 5
} sfe_cy8cmbr3_spo_config_t;
 
typedef enum {
    AUTO_RESET_TIMEOUT_DISABLED = 0,
    AUTO_RESET_TIMEOUT_5_SECONDS = 1,
    AUTO_RESET_TIMEOUT_20_SECONDS = 2,
} sfe_cy8cmbr3_auto_reset_timeout_t;
 
 
 
class sfDevCY8CMBR3
{
  public:
    sfDevCY8CMBR3() : _last_data_pF{0}, _currentSensorId{SID_INVALID}, _theBus{nullptr}
    {
    }
 
    bool begin(sfTkIBus *theBus = nullptr);
 
    uint8_t getFamilyID(void);
 
    uint16_t getDeviceID(void);
 
    void setCommunicationBus(sfTkIBus *theBus);
 
    bool isCtrlCommandComplete(void);
 
    bool sendCtrlCommand(sfe_cy8cmbr3_ctrl_cmd_t command, bool waitForCompletion = true);
 
    bool saveConfig(void);
 
    bool reset(bool waitForCompletion = true);
 
    bool readWithSyncCounter(uint8_t reg, uint8_t &data, uint8_t retries = 10);
    bool readWithSyncCounter(uint8_t reg, uint16_t &data, uint8_t retries = 10);
 
    bool setSensorId(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    sfe_cy8cmbr3_sensor_id_t getDebugSensorId(void);
 
    bool setSensitivity(sfe_cy8cmbr3_sensitivity_t sensitivity = CS_SENSITIVITY_500_COUNTS_PER_PF, sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    sfe_cy8cmbr3_sensitivity_t getSensitivity(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    bool setAutoThresholdEnable(bool enable = true);
 
    bool setAutoResetEnable(bool enable = true, sfe_cy8cmbr3_auto_reset_timeout_t timeout = AUTO_RESET_TIMEOUT_5_SECONDS);
 
    bool setSystemDiagnosticsEnable(bool enable = true);
 
    bool setRefreshInterval(sfe_cy8cmbr3_refresh_interval_t interval = REFRESH_INTERVAL_100MS);
 
    bool setSPO0Config(sfe_cy8cmbr3_spo_config_t config = SPO_GPO);
 
    bool setProxEnable(bool enable = false, sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    bool setBaseThreshold(uint8_t threshold = 128, sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    uint8_t getBaseThreshold(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
    
    bool setHysteresisOverride(bool override = false);
 
    bool setHysteresis(uint8_t hysteresis = 0);
 
    uint8_t getHysteresis(void);
 
    bool setLowBaselineResetOverride(bool override = false);
 
    bool setLowBaselineReset(uint8_t baseline = 0);
 
    uint8_t getLowBaselineReset(void);
 
    bool setNegativeNoiseThresholdOverride(bool override = false);
    
    bool setNegativeNoiseThreshold(uint8_t threshold = 0);
 
    uint8_t getNegativeNoiseThreshold(void);
 
    bool setNoiseThresholdOverride(bool override = false);
 
    bool setNoiseThreshold(uint8_t threshold = 0);
 
    uint8_t getNoiseThreshold(void);
 
    bool saveDefaultConfig(void);
 
    bool setGPOConfig(bool controlByHost = true, bool pwmOutput = false, bool strongDrive = true, bool activeHigh = false);
 
    sfe_cy8cmbr3_reg_gpo_cfg_t getGPOConfig(void);
 
    bool setGPOToggleEnable(bool enable = false, sfe_cy8cmbr3_gpo_t gpo = GPO_0);
 
    uint8_t getGPOOutputState(void);
 
    uint8_t getGPOData(void);
 
    bool enable(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0, bool enable = true);
 
    uint8_t readCapacitancePF(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    uint16_t readDebugDifferenceCount(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    uint16_t readDifferenceCount(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    uint16_t readBaselineCount(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    uint16_t readRawCount(sfe_cy8cmbr3_sensor_id_t sensorId = SID_0);
 
    bool ledOn(bool ledOn = true, sfe_cy8cmbr3_gpo_t gpo = GPO_0);
 
    bool ledOff(sfe_cy8cmbr3_gpo_t gpo = GPO_0);
 
    bool defaultMoistureSensorInit(void);
 
  protected:
    bool _setI2CAddress(uint8_t i2cAddress);
 
    bool _readI2CAddress(uint8_t &i2cAddress);
 
  private:
    bool _writeWithRetry(uint8_t regAddress, uint8_t data);
    bool _writeWithRetry(uint8_t regAddress, uint16_t data);
    bool _readWithRetry(uint8_t regAddress, uint8_t &data);
    bool _readWithRetry(uint8_t regAddress, uint16_t &data);
 
    sfe_cy8cmbr3_reg_debug_cp_t _last_data_pF; // Last read data from the sensor.
    sfe_cy8cmbr3_sensor_id_t _currentSensorId; // Current sensor Id for debug operations.
 
    sfTkIBus *_theBus; // Pointer to bus device.
};