m_batt_meas.h

/*
  Copyright (c) 2010 - 2017, Nordic Semiconductor ASA
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this
     list of conditions and the following disclaimer.

  2. Redistributions in binary form, except as embedded into a Nordic
     Semiconductor ASA integrated circuit in a product or a software update for
     such product, must reproduce the above copyright notice, this list of
     conditions and the following disclaimer in the documentation and/or other
     materials provided with the distribution.

  3. Neither the name of Nordic Semiconductor ASA nor the names of its
     contributors may be used to endorse or promote products derived from this
     software without specific prior written permission.

  4. This software, with or without modification, must only be used with a
     Nordic Semiconductor ASA integrated circuit.

  5. Any software provided in binary form under this license must not be reverse
     engineered, decompiled, modified and/or disassembled.

  THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __M_BATT_MEAS_H__
#define __M_BATT_MEAS_H__

#include "m_ble.h"
#include "nrf_saadc.h"
#include <stdint.h>
#include <stdbool.h>

#define MEAS_INTERVAL_LOW_LIMIT_MS 50
/* The SAADC is configured for oversampling for improved noise immunity.
corresponding settings can be found in sdk_config.h */

enum
{
    M_BATT_STATUS_CODE_SUCCESS,                     
    M_BATT_STATUS_CODE_INVALID_PARAM,               
};

typedef enum
{
    M_BATT_MEAS_EVENT_DATA,                         
    M_BATT_MEAS_EVENT_LOW,                          
    M_BATT_MEAS_EVENT_FULL,                         
    M_BATT_MEAS_EVENT_USB_CONN_CHARGING,            
    M_BATT_MEAS_EVENT_USB_CONN_CHARGING_FINISHED,   
    M_BATT_MEAS_EVENT_USB_DISCONN,                  
    M_BATT_MEAS_EVENT_ERROR,                        
}m_batt_meas_event_type_t;

typedef struct
{
    m_batt_meas_event_type_t    type;               
    uint16_t                    voltage_mv;         
    uint8_t                     level_percent;      
    bool                        valid_voltage;      
}m_batt_meas_event_t;

typedef void (*m_batt_meas_event_handler_t)(m_batt_meas_event_t const * p_event);

typedef struct
{
    uint32_t r_1_ohm;
    uint32_t r_2_ohm;
}voltage_divider_t;

typedef struct
{
    uint16_t            num_elements;                   
    uint16_t            first_element_mv;               
    uint8_t             delta_mv;                       
    uint8_t const *     voltage_to_soc;                 
}state_of_charge_t;


typedef struct
{
    uint16_t            app_timer_prescaler;            
    uint8_t             adc_pin_no;                     
    nrf_saadc_input_t   adc_pin_no_ain;                 
    uint8_t             usb_detect_pin_no;              
    uint8_t             batt_chg_stat_pin_no;           
    bool                batt_mon_en_pin_used;           
    uint8_t             batt_mon_en_pin_no;             
    uint16_t            batt_voltage_limit_low;         
    uint16_t            batt_voltage_limit_full;        
    voltage_divider_t   voltage_divider;                
    state_of_charge_t   state_of_charge;                
}batt_meas_param_t;

typedef struct
{
    m_batt_meas_event_handler_t     evt_handler;        
    batt_meas_param_t               batt_meas_param;    
}batt_meas_init_t;

uint32_t m_batt_meas_init(m_ble_service_handle_t * p_handle, batt_meas_init_t const * const p_batt_meas_init);

uint32_t m_batt_meas_enable(uint32_t meas_interval_ms);

uint32_t m_batt_meas_disable(void);

#endif