charger.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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.
****************************************************************************/
 
#ifndef CHARGER_H
#define CHARGER_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_one_wire.h"
 
#define CHARGER_CMD_WRITE_SCRATCHPAD        0x4E
#define CHARGER_CMD_READ_SCRATCHPAD         0xBE
#define CHARGER_CMD_COPY_SCRATCHPAD         0x48
#define CHARGER_CMD_RECALL_MEMORY           0xB8
#define CHARGER_CMD_CONVERT_T               0x44
#define CHARGER_CMD_CONVERT_V               0xB4
 
 // charger_cmd
 
#define CHARGER_PAGE_0                      0
#define CHARGER_PAGE_1                      1
#define CHARGER_PAGE_2                      2
#define CHARGER_PAGE_3                      3
#define CHARGER_PAGE_4                      4
#define CHARGER_PAGE_5                      5
#define CHARGER_PAGE_6                      6
#define CHARGER_PAGE_7                      7
#define CHARGER_PAGE_SIZE                   8
 
#define CHARGER_CONFIG_IAD                  0x01
#define CHARGER_CONFIG_CA                   0x02
#define CHARGER_CONFIG_EE                   0x04
#define CHARGER_CONFIG_AD                   0x08
#define CHARGER_CONFIG_TB                   0x10
#define CHARGER_CONFIG_NVM                  0x20
#define CHARGER_CONFIG_ADB                  0x40
 
#define CHARGER_TEMPERATURE_RES             0.03125f
#define CHARGER_VOLTAGE_RES                 0.01f
#define CHARGER_CURRENT_RES                 204.8f
 
#define CHARGER_FAMILY_CODE                 0x26
 
#define CHARGER_ADDRESS_0                   0x00
#define CHARGER_ADDRESS_ALL                 0xFF
 
 // charger_set
 
#define CHARGER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.ow1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ow2 = MIKROBUS( mikrobus, MIKROBUS_AN );
 
 // charger_map
 // charger
 
typedef enum
{
    CHARGER_GPIO_OW1,                   
    CHARGER_GPIO_OW2                    
} charger_gpio_sel_t;
 
typedef struct
{
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t address;                    
} charger_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t ow1;                     
    pin_name_t ow2;                     
    charger_gpio_sel_t gpio_sel;        
} charger_cfg_t;
 
typedef enum
{
    CHARGER_OK = 0,
    CHARGER_ERROR = -1
 
} charger_return_value_t;
 
void charger_cfg_setup ( charger_cfg_t *cfg );
 
void charger_gpio_selection ( charger_cfg_t *cfg, charger_gpio_sel_t gpio_sel );
 
err_t charger_init ( charger_t *ctx, charger_cfg_t *cfg );
 
err_t charger_default_cfg ( charger_t *ctx );
 
err_t charger_check_communication ( charger_t *ctx );
 
err_t charger_select_device ( charger_t *ctx );
 
err_t charger_read_scratchpad ( charger_t *ctx, uint8_t page, uint8_t *data_out, uint8_t len );
 
err_t charger_write_scratchpad ( charger_t *ctx, uint8_t page, uint8_t *data_in, uint8_t len );
 
err_t charger_copy_scratchpad ( charger_t *ctx, uint8_t page );
 
err_t charger_recall_memory ( charger_t *ctx, uint8_t page );
 
err_t charger_convert_temperature ( charger_t *ctx );
 
err_t charger_convert_voltage ( charger_t *ctx );
 
err_t charger_read_temperature ( charger_t *ctx, float *temperature );
 
err_t charger_read_batt_vdd ( charger_t *ctx, float *voltage );
 
err_t charger_read_system_vdd ( charger_t *ctx, float *voltage );
 
err_t charger_read_current ( charger_t *ctx, float *current );
 
err_t charger_calibrate_current ( charger_t *ctx );
 
err_t charger_write_elapsed_time ( charger_t *ctx, uint32_t seconds );
 
err_t charger_read_elapsed_time ( charger_t *ctx, uint32_t *seconds );
 
#ifdef __cplusplus
}
#endif
#endif // CHARGER_H
 
 // charger
 
// ------------------------------------------------------------------------ END