view Small_CPU/Src/batteryGasGauge.c @ 471:73da921869d9 fix-bat-2

bugfix: implement battery charge percentage in dive header This commit is (much) less trivial than the related 919e5cb51c92. First, rename the CCRmode attribute (corresponding to byte Ox59) of the SLogbookHeaderOSTC3. This byte (according to the hwOS interface document) does not contain any CCR related value, but it contains "battery information". Already since 2017, this byte is used from libdivecomputer to interface the charge percentage. So, its renamed from CCRmode to batteryCharge, to reflect its true purpose. Now, simply add a batteryCharge attribute to the SLogbookHeader (and see below why that is possible, without breaking things). The remaining changes are trivial to implement battery charge percentage in dive header. Caveat: do not get confused by the exact role of the individual logbook header types. SLogbookHeaderOSTC3 is the formal type of the logbook format that the OSTC4 produces. This format is supposed to identical to the format, as is used in hwOS for the series of small OSTCs. Only some values of attributes are different. For example, the OSTC4 supports VPM, so byte 0x79 (deco model used for this dive) also has a value for VPM. But the SLogbookHeader type, despite its name and structure, is *not* a true logbook header, as it includes attributes that are not available in the SLogbookHeaderOSTC3 formal header type. Signed-off-by: Jan Mulder <jan@jlmulder.nl>
author Jan Mulder <jlmulder@xs4all.nl>
date Wed, 22 Apr 2020 13:08:57 +0200
parents aa286a4926c2
children 1b995079c045
line wrap: on
line source

/**
  ******************************************************************************
  * @file    batteryGasGauge.c 
  * @author  heinrichs weikamp gmbh
  * @version V0.0.1
  * @date    09-Dec-2014
  * @brief   LTC2942 Battery Gas Gauge
  *           
  @verbatim                 
  ============================================================================== 
                ##### stm32f4xx_hal_i2c.c modification #####
  ============================================================================== 
	The LTC2942 requires an repeated start condition without stop condition
	for data reception.
	
  @endverbatim
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; COPYRIGHT(c) 2014 heinrichs weikamp</center></h2>
  *
  ******************************************************************************
  */ 
/* Includes ------------------------------------------------------------------*/
#include <string.h>	/* memset */
#include "batteryGasGauge.h"
#include "baseCPU2.h"
#include "stm32f4xx_hal.h"
#include "i2c.h"

static float battery_f_voltage = 6.0;		/* max assumed voltage */
static float battery_f_charge_percent = 0;

#define BGG_BATTERY_OFFSET          (26123)  //; 65536-(3,35Ah/0,085mAh)
#define BGG_BATTERY_DIVIDER         (394)    //; 3,35Ah/0,085mAh/100 [%]

float get_voltage(void)
{
#ifdef OSTC_ON_DISCOVERY_HARDWARE
	return 3.0f;
#endif

	return battery_f_voltage;
}


float get_charge(void)
{
	#ifdef OSTC_ON_DISCOVERY_HARDWARE
		return 100.0f;
	#endif
	
	return battery_f_charge_percent;
}


void init_battery_gas_gauge(void)
{
	#ifdef OSTC_ON_DISCOVERY_HARDWARE
		return;
	#endif
	
	uint8_t buffer[2];
	buffer[0] = 0x01;

	// F8 = 11111000:
	// ADC auto mode (11)
	// Prescale M = 128 (111)
	// AL/CC pin disable (0)
	// Shutdown (0)
	buffer[1] = 0xF8;
	I2C_Master_Transmit(DEVICE_BATTERYGAUGE, buffer, 2);
}

uint8_t battery_gas_gauge_CheckConfigOK(void)
{
	#ifdef OSTC_ON_DISCOVERY_HARDWARE
		return;
	#endif

	uint8_t retval = 0;
	uint8_t bufferReceive[10];

	memset(bufferReceive,0,sizeof(bufferReceive));

	I2C_Master_Receive(DEVICE_BATTERYGAUGE, bufferReceive, 10);
	if(bufferReceive[1] == 0xf8)
	{
		retval = 1;
	}
	return retval;
}

static void disable_adc(void)
{
	uint8_t buffer[2];
	buffer[0] = 0x01;

	// according to the datasheet of the LTC2942, the adc shall
	// be disabled when writing to the gauge registers

	// 0xF9 = 11111001:
	// see init_battery_gas_gauge()
	// Shutdown (1)
	buffer[1] = 0xF9;
	I2C_Master_Transmit(DEVICE_BATTERYGAUGE, buffer, 2);
}


void battery_gas_gauge_get_data(void)
{
	#ifdef OSTC_ON_DISCOVERY_HARDWARE
		return;
	#endif
	
	float battery_f_voltage_local;
	float battery_f_charge_percent_local;
	
	uint8_t bufferReceive[10];
	
	if(I2C_Master_Receive(DEVICE_BATTERYGAUGE, bufferReceive, 10) == HAL_OK)
	{
		battery_f_voltage_local =  (float)(bufferReceive[8] * 256);
		battery_f_voltage_local += (float)(bufferReceive[9]);
		battery_f_voltage_local *= (float)6 / (float)0xFFFF;
	
		// max/full: 0.085 mAh * 1 * 65535 = 5570 mAh
		battery_f_charge_percent_local =  (float)(bufferReceive[2] * 256);
		battery_f_charge_percent_local += (float)(bufferReceive[3]);
		battery_f_charge_percent_local -= BGG_BATTERY_OFFSET;		/* Because of the prescalar 128 the counter assumes a max value of 5570mAh => normalize to 3350mAh*/
		battery_f_charge_percent_local /= BGG_BATTERY_DIVIDER;		/* transform to percentage */

		if(battery_f_charge_percent_local < 0)
			battery_f_charge_percent_local = 0;

		battery_f_voltage = battery_f_voltage_local;
		battery_f_charge_percent = battery_f_charge_percent_local;
	}
}


void battery_gas_gauge_set_charge_full(void)
{
	disable_adc();
	#ifdef OSTC_ON_DISCOVERY_HARDWARE
		return;
	#endif
	
	uint8_t bufferSend[3];
	bufferSend[0] = 0x02;
	bufferSend[1] = 0xFF;
	bufferSend[2] = 0xFF;
	I2C_Master_Transmit(  DEVICE_BATTERYGAUGE, bufferSend, 3);
	init_battery_gas_gauge();
}


void battery_gas_gauge_set(float percentage)
{

	disable_adc();
	#ifdef OSTC_ON_DISCOVERY_HARDWARE
		return;
	#endif

	uint16_t mAhSend;
	
	if(percentage >= 100)
		mAhSend = 0xFFFF;
	else {
		mAhSend = (percentage * BGG_BATTERY_DIVIDER) + BGG_BATTERY_OFFSET;
	}
	
	uint8_t bufferSend[3];
	bufferSend[0] = 0x02;
	bufferSend[1] = (uint8_t)(mAhSend / 256);
	bufferSend[2] = (uint8_t)(mAhSend & 0xFF);
	I2C_Master_Transmit(  DEVICE_BATTERYGAUGE, bufferSend, 3);
	init_battery_gas_gauge();
}


/************************ (C) COPYRIGHT heinrichs weikamp *****END OF FILE****/