max17048 i2c conflicting declaration (AEGHB-1107)

[michaelboeding]

Answers checklist.

• I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
• I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
• I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

When trying to use the max17048 component the below pops up and prevents me from building. There seems to be a setting but I can't seem to toggle it in the Bus Config - see image below.

I am running ESP-IDF version 5.3.1 so I think it should allow me to turn this on?

../managed_components/espressif__i2c_bus/include/i2c_bus.h: At global scope:
../managed_components/espressif__i2c_bus/include/i2c_bus.h:53:3: error: conflicting declaration 'typedef struct i2c_config_t i2c_config_t'
   53 | } i2c_config_t;

[michaelboeding]

I made the below changes to make this compile....still will need to test

Modified the i2c_bus Kconfig file to pull the version differently

menu "Bus Options"

    menu "I2C Bus Options"
        config ESP_IDF_VERSION
            string
            option env="ESP_IDF_VERSION"

        config I2C_BUS_DYNAMIC_CONFIG
            bool "enable dynamic configuration"
            default y
            help
                If enable, i2c_bus will dynamically check configs and re-install i2c driver before each transfer,
                hence multiple devices with different configs on a single bus can be supported.

        config I2C_MS_TO_WAIT
            int "mutex block time"
            default 200
            range 50 5000
            help
                task block time when try to take the bus, unit:milliseconds

        config I2C_BUS_BACKWARD_CONFIG
            bool "Enable backward compatibility for the I2C driver (force use of the old i2c_driver above v5.3)"
            default n
            depends on IDF_VERSION_MAJOR > 5 \
                    || (IDF_VERSION_MAJOR = 5 && IDF_VERSION_MINOR >= 3)
            help
                Enable this option for backward compatibility with the old I2C driver
    endmenu

endmenu

Modified the i2c_bus.h file

/*
 * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#ifndef _I2C_BUS_H_
#define _I2C_BUS_H_

#include "esp_idf_version.h"

// Always include driver/i2c.h to ensure i2c_config_t is defined
#include "driver/i2c.h"
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0) && !CONFIG_I2C_BUS_BACKWARD_CONFIG
#include "driver/i2c_master.h"
#endif

#define NULL_I2C_MEM_ADDR 0xFF          /*!< set mem_address to NULL_I2C_MEM_ADDR if i2c device has no internal address during read/write */
#define NULL_I2C_MEM_16BIT_ADDR 0XFFFF  /*!< set 16bit mem_address to NULL_I2C_MEM_16BIT_ADDR if i2c device has no internal address during read/write */
#define NULL_I2C_DEV_ADDR 0xFF          /*!< invalid i2c device address */
typedef void *i2c_bus_handle_t;         /*!< i2c bus handle */
typedef void *i2c_bus_device_handle_t;  /*!< i2c device handle */

#ifdef __cplusplus
extern "C"
{
#endif

#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0))
#define gpio_pad_select_gpio esp_rom_gpio_pad_select_gpio
#define portTICK_RATE_MS portTICK_PERIOD_MS
#endif

#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
#if !CONFIG_I2C_BUS_BACKWARD_CONFIG
/**
 * @brief I2C initialization parameters
 */
typedef struct {
    i2c_mode_t mode;                    /*!< I2C mode */
    int sda_io_num;                     /*!< GPIO number for I2C sda signal */
    int scl_io_num;                     /*!< GPIO number for I2C scl signal */
    bool sda_pullup_en;                 /*!< Internal GPIO pull mode for I2C sda signal*/
    bool scl_pullup_en;                 /*!< Internal GPIO pull mode for I2C scl signal*/
    struct {
        uint32_t clk_speed;             /*!< I2C clock frequency for master mode, (no higher than 1MHz for now) */
    } master;                           /*!< I2C master config */
    uint32_t clk_flags;                 /*!< Bitwise of ``I2C_SCLK_SRC_FLAG_**FOR_DFS**`` for clk source choice*/
} i2c_config_t;
#endif

typedef void *i2c_cmd_handle_t;         /*!< I2C command handle  */
#endif

/**************************************** Public Functions (Application level)*********************************************/

/**
 * @brief Create an I2C bus instance then return a handle if created successfully. Each I2C bus works in a singleton mode,
 * which means for an i2c port only one group parameter works. When i2c_bus_create is called more than one time for the
 * same i2c port, following parameter will override the previous one.
 *
 * @param port I2C port number
 * @param conf Pointer to I2C bus configuration
 * @return i2c_bus_handle_t Return the I2C bus handle if created successfully, return NULL if failed.
 */
i2c_bus_handle_t i2c_bus_create(i2c_port_t port, const i2c_config_t *conf);

/**
 * @brief Delete and release the I2C bus resource.
 *
 * @param p_bus_handle Point to the I2C bus handle, if delete succeed handle will set to NULL.
 * @return
 *     - ESP_OK Success
 *     - ESP_FAIL Fail
 */
esp_err_t i2c_bus_delete(i2c_bus_handle_t *p_bus_handle);

/**
 * @brief Scan i2c devices attached on i2c bus
 *
 * @param bus_handle I2C bus handle
 * @param buf Pointer to a buffer to save devices' address, if NULL no address will be saved.
 * @param num Maximum number of addresses to save, invalid if buf set to NULL,
 * higher addresses will be discarded if num less-than the total number found on the I2C bus.
 * @return uint8_t Total number of devices found on the I2C bus
 */
uint8_t i2c_bus_scan(i2c_bus_handle_t bus_handle, uint8_t *buf, uint8_t num);

/**
 * @brief Get current active clock speed.
 *
 * @param bus_handle I2C bus handle
 * @return uint32_t current clock speed
 */
uint32_t i2c_bus_get_current_clk_speed(i2c_bus_handle_t bus_handle);

/**
 * @brief Get created device number of the bus.
 *
 * @param bus_handle I2C bus handle
 * @return uint8_t created device number of the bus
 */
uint8_t i2c_bus_get_created_device_num(i2c_bus_handle_t bus_handle);

/**
 * @brief Create an I2C device on specific bus.
 *        Dynamic configuration must be enable to achieve multiple devices with different configs on a single bus.
 *        menuconfig:Bus Options->I2C Bus Options->enable dynamic configuration
 *
 * @param bus_handle Point to the I2C bus handle
 * @param dev_addr i2c device address
 * @param clk_speed device specified clock frequency the i2c_bus will switch to during each transfer. 0 if use current bus speed.
 * @return i2c_bus_device_handle_t return a device handle if created successfully, return NULL if failed.
 */
i2c_bus_device_handle_t i2c_bus_device_create(i2c_bus_handle_t bus_handle, uint8_t dev_addr, uint32_t clk_speed);

/**
 * @brief Delete and release the I2C device resource, i2c_bus_device_delete should be used in pairs with i2c_bus_device_create.
 *
 * @param p_dev_handle Point to the I2C device handle, if delete succeed handle will set to NULL.
 * @return
 *     - ESP_OK Success
 *     - ESP_FAIL Fail
 */
esp_err_t i2c_bus_device_delete(i2c_bus_device_handle_t *p_dev_handle);

/**
 * @brief Get device's I2C address
 *
 * @param dev_handle I2C device handle
 * @return uint8_t I2C address, return NULL_I2C_DEV_ADDR if dev_handle is invalid.
 */
uint8_t i2c_bus_device_get_address(i2c_bus_device_handle_t dev_handle);

/**
 * @brief Read single byte from i2c device with 8-bit internal register/memory address
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal reg/mem address to read from, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param data Pointer to a buffer to save the data that was read
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_read_byte(i2c_bus_device_handle_t dev_handle, uint8_t mem_address, uint8_t *data);

/**
 * @brief Read multiple bytes from i2c device with 8-bit internal register/memory address.
 * If internal reg/mem address is 16-bit, please refer i2c_bus_read_reg16
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal reg/mem address to read from, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param data_len Number of bytes to read
 * @param data Pointer to a buffer to save the data that was read
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_read_bytes(i2c_bus_device_handle_t dev_handle, uint8_t mem_address, size_t data_len, uint8_t *data);

/**
 * @brief Read single bit of a byte from i2c device with 8-bit internal register/memory address
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal reg/mem address to read from, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param bit_num The bit number 0 - 7 to read
 * @param data Pointer to a buffer to save the data that was read. *data == 0 -> bit = 0, *data !=0 -> bit = 1.
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_read_bit(i2c_bus_device_handle_t dev_handle, uint8_t mem_address, uint8_t bit_num, uint8_t *data);

/**
 * @brief Read multiple bits of a byte from i2c device with 8-bit internal register/memory address
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal reg/mem address to read from, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param bit_start The bit to start from, 0 - 7, MSB at 0
 * @param length The number of bits to read, 1 - 8
 * @param data Pointer to a buffer to save the data that was read
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_read_bits(i2c_bus_device_handle_t dev_handle, uint8_t mem_address, uint8_t bit_start, uint8_t length, uint8_t *data);

/**
 * @brief Write single byte to i2c device with 8-bit internal register/memory address
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal reg/mem address to write to, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param data The byte to write.
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_write_byte(i2c_bus_device_handle_t dev_handle, uint8_t mem_address, uint8_t data);

/**
 * @brief Write multiple byte to i2c device with 8-bit internal register/memory address
 * If internal reg/mem address is 16-bit, please refer i2c_bus_write_reg16
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal reg/mem address to write to, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param data_len Number of bytes to write
 * @param data Pointer to the bytes to write.
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_write_bytes(i2c_bus_device_handle_t dev_handle, uint8_t mem_address, size_t data_len, const uint8_t *data);

/**
 * @brief Write single bit of a byte to an i2c device with 8-bit internal register/memory address
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal reg/mem address to write to, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param bit_num The bit number 0 - 7 to write
 * @param data The bit to write, data == 0 means set bit = 0, data !=0 means set bit = 1.
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_write_bit(i2c_bus_device_handle_t dev_handle, uint8_t mem_address, uint8_t bit_num, uint8_t data);

/**
 * @brief Write multiple bits of a byte to an i2c device with 8-bit internal register/memory address
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal reg/mem address to write to, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param bit_start The bit to start from, 0 - 7, MSB at 0
 * @param length The number of bits to write, 1 - 8
 * @param data The bits to write.
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_write_bits(i2c_bus_device_handle_t dev_handle, uint8_t mem_address, uint8_t bit_start, uint8_t length, uint8_t data);

/**************************************** Public Functions (Low level)*********************************************/

/**
 * @brief I2C master send queued commands create by ``i2c_cmd_link_create`` .
 *        This function will trigger sending all queued commands.
 *        The task will be blocked until all the commands have been sent out.
 *        If I2C_BUS_DYNAMIC_CONFIG enable, i2c_bus will dynamically check configs and re-install i2c driver before each transfer,
 *        hence multiple devices with different configs on a single bus can be supported.
 *        @note
 *        Only call this function when ``i2c_bus_read/write_xx`` do not meet the requirements
 *
 * @param dev_handle I2C device handle
 * @param cmd I2C command handler
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_cmd_begin(i2c_bus_device_handle_t dev_handle, i2c_cmd_handle_t cmd);

/**
 * @brief Write date to an i2c device with 16-bit internal reg/mem address
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal 16-bit reg/mem address to write to, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param data_len Number of bytes to write
 * @param data Pointer to the bytes to write.
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_write_reg16(i2c_bus_device_handle_t dev_handle, uint16_t mem_address, size_t data_len, const uint8_t *data);

/**
 * @brief Read date from i2c device with 16-bit internal reg/mem address
 *
 * @param dev_handle I2C device handle
 * @param mem_address The internal 16-bit reg/mem address to read from, set to NULL_I2C_MEM_ADDR if no internal address.
 * @param data_len Number of bytes to read
 * @param data Pointer to a buffer to save the data that was read
 * @return esp_err_t
 *     - ESP_OK Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_FAIL Sending command error, slave doesn't ACK the transfer.
 *     - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode.
 *     - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.
 */
esp_err_t i2c_bus_read_reg16(i2c_bus_device_handle_t dev_handle, uint16_t mem_address, size_t data_len, uint8_t *data);

#ifdef __cplusplus
}
#endif

#endif

[YanKE01]

Hi, @michaelboeding .I tested the 'Enable Backward I2C' feature on the latest master branch and with ESP-IDF v5.3.1, and there were no issues. You can perform the test in the test_apps directory (components/sensors/battery_fuel_gauge/max17048/test_apps).

➜  test_apps git:(master) idf.py --version                          
ESP-IDF v5.3.1
➜  test_apps git:(master) idf.py menuconfig 
Executing action: menuconfig
Running ninja in directory /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/build
Executing "ninja menuconfig"...
[0/1] cd /home/yanke/project/esp-iot-solution/components/sensors/battery_...lution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig
Loading defaults file /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults...
/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults:8 CONFIG_ESP32S3_DEFAULT_CPU_FREQ_240 was replaced with CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240 
/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults:9 CONFIG_ESP_TASK_WDT was replaced with CONFIG_ESP_TASK_WDT_INIT 
warning: unknown kconfig symbol 'ESP32S2_DEFAULT_CPU_FREQ_240' assigned to 'y' in /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults
TERM environment variable is set to "xterm-256color"
Loaded configuration '/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig'
No changes to save (for '/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig')
Loading defaults file /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults...
/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults:8 CONFIG_ESP32S3_DEFAULT_CPU_FREQ_240 was replaced with CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240 
/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults:9 CONFIG_ESP_TASK_WDT was replaced with CONFIG_ESP_TASK_WDT_INIT 
warning: unknown kconfig symbol 'ESP32S2_DEFAULT_CPU_FREQ_240' assigned to 'y' in /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults
➜  test_apps git:(master) 
➜  test_apps git:(master) 
➜  test_apps git:(master) 
➜  test_apps git:(master) 
➜  test_apps git:(master) 
➜  test_apps git:(master) idf.py build      
Executing action: all (aliases: build)
Running ninja in directory /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/build
Executing "ninja all"...
[0/1] Re-running CMake...
-- Building ESP-IDF components for target esp32s3
NOTICE: Using component placed at /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048 for dependency "max17048", specified in /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/main/idf_component.yml
NOTICE: Processing 4 dependencies:
NOTICE: [1/4] espressif/cmake_utilities (0.5.3)
NOTICE: [2/4] espressif/i2c_bus (1.1.0)
NOTICE: [3/4] max17048 (0.1.1) (/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048)
NOTICE: [4/4] idf (5.3.1)
-- Project sdkconfig file /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig
Loading defaults file /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults...
/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults:8 CONFIG_ESP32S3_DEFAULT_CPU_FREQ_240 was replaced with CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240 
/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults:9 CONFIG_ESP_TASK_WDT was replaced with CONFIG_ESP_TASK_WDT_INIT 
warning: unknown kconfig symbol 'ESP32S2_DEFAULT_CPU_FREQ_240' assigned to 'y' in /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig.defaults
-- Compiler supported targets: xtensa-esp-elf
-- App "max17048_test" version: 7af24e9f
-- Adding linker script /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/build/esp-idf/esp_system/ld/memory.ld
-- Adding linker script /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/build/esp-idf/esp_system/ld/sections.ld.in
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.api.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.libgcc.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.wdt.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.version.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.newlib.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/soc/esp32s3/ld/esp32s3.peripherals.ld
-- I2C_BUS: 1.1.0
-- MAX17048: 0.1.1
-- Components: app_trace app_update bootloader bootloader_support bt cmock console cxx driver efuse esp-tls esp_adc esp_app_format esp_bootloader_format esp_coex esp_common esp_driver_ana_cmpr esp_driver_cam esp_driver_dac esp_driver_gpio esp_driver_gptimer esp_driver_i2c esp_driver_i2s esp_driver_isp esp_driver_jpeg esp_driver_ledc esp_driver_mcpwm esp_driver_parlio esp_driver_pcnt esp_driver_ppa esp_driver_rmt esp_driver_sdio esp_driver_sdm esp_driver_sdmmc esp_driver_sdspi esp_driver_spi esp_driver_touch_sens esp_driver_tsens esp_driver_uart esp_driver_usb_serial_jtag esp_eth esp_event esp_gdbstub esp_hid esp_http_client esp_http_server esp_https_ota esp_https_server esp_hw_support esp_lcd esp_local_ctrl esp_mm esp_netif esp_netif_stack esp_partition esp_phy esp_pm esp_psram esp_ringbuf esp_rom esp_system esp_timer esp_vfs_console esp_wifi espcoredump espressif__cmake_utilities espressif__i2c_bus esptool_py fatfs freertos hal heap http_parser idf_test ieee802154 json log lwip main max17048 mbedtls mqtt newlib nvs_flash nvs_sec_provider openthread partition_table perfmon protobuf-c protocomm pthread sdmmc soc spi_flash spiffs tcp_transport test_utils touch_element ulp unity usb vfs wear_levelling wifi_provisioning wpa_supplicant xtensa
-- Component paths: /home/yanke/esp/esp-idf-53/esp-idf/components/app_trace /home/yanke/esp/esp-idf-53/esp-idf/components/app_update /home/yanke/esp/esp-idf-53/esp-idf/components/bootloader /home/yanke/esp/esp-idf-53/esp-idf/components/bootloader_support /home/yanke/esp/esp-idf-53/esp-idf/components/bt /home/yanke/esp/esp-idf-53/esp-idf/components/cmock /home/yanke/esp/esp-idf-53/esp-idf/components/console /home/yanke/esp/esp-idf-53/esp-idf/components/cxx /home/yanke/esp/esp-idf-53/esp-idf/components/driver /home/yanke/esp/esp-idf-53/esp-idf/components/efuse /home/yanke/esp/esp-idf-53/esp-idf/components/esp-tls /home/yanke/esp/esp-idf-53/esp-idf/components/esp_adc /home/yanke/esp/esp-idf-53/esp-idf/components/esp_app_format /home/yanke/esp/esp-idf-53/esp-idf/components/esp_bootloader_format /home/yanke/esp/esp-idf-53/esp-idf/components/esp_coex /home/yanke/esp/esp-idf-53/esp-idf/components/esp_common /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_ana_cmpr /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_cam /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_dac /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_gpio /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_gptimer /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_i2c /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_i2s /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_isp /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_jpeg /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_ledc /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_mcpwm /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_parlio /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_pcnt /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_ppa /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_rmt /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_sdio /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_sdm /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_sdmmc /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_sdspi /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_spi /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_touch_sens /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_tsens /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_uart /home/yanke/esp/esp-idf-53/esp-idf/components/esp_driver_usb_serial_jtag /home/yanke/esp/esp-idf-53/esp-idf/components/esp_eth /home/yanke/esp/esp-idf-53/esp-idf/components/esp_event /home/yanke/esp/esp-idf-53/esp-idf/components/esp_gdbstub /home/yanke/esp/esp-idf-53/esp-idf/components/esp_hid /home/yanke/esp/esp-idf-53/esp-idf/components/esp_http_client /home/yanke/esp/esp-idf-53/esp-idf/components/esp_http_server /home/yanke/esp/esp-idf-53/esp-idf/components/esp_https_ota /home/yanke/esp/esp-idf-53/esp-idf/components/esp_https_server /home/yanke/esp/esp-idf-53/esp-idf/components/esp_hw_support /home/yanke/esp/esp-idf-53/esp-idf/components/esp_lcd /home/yanke/esp/esp-idf-53/esp-idf/components/esp_local_ctrl /home/yanke/esp/esp-idf-53/esp-idf/components/esp_mm /home/yanke/esp/esp-idf-53/esp-idf/components/esp_netif /home/yanke/esp/esp-idf-53/esp-idf/components/esp_netif_stack /home/yanke/esp/esp-idf-53/esp-idf/components/esp_partition /home/yanke/esp/esp-idf-53/esp-idf/components/esp_phy /home/yanke/esp/esp-idf-53/esp-idf/components/esp_pm /home/yanke/esp/esp-idf-53/esp-idf/components/esp_psram /home/yanke/esp/esp-idf-53/esp-idf/components/esp_ringbuf /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom /home/yanke/esp/esp-idf-53/esp-idf/components/esp_system /home/yanke/esp/esp-idf-53/esp-idf/components/esp_timer /home/yanke/esp/esp-idf-53/esp-idf/components/esp_vfs_console /home/yanke/esp/esp-idf-53/esp-idf/components/esp_wifi /home/yanke/esp/esp-idf-53/esp-idf/components/espcoredump /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/managed_components/espressif__cmake_utilities /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/managed_components/espressif__i2c_bus /home/yanke/esp/esp-idf-53/esp-idf/components/esptool_py /home/yanke/esp/esp-idf-53/esp-idf/components/fatfs /home/yanke/esp/esp-idf-53/esp-idf/components/freertos /home/yanke/esp/esp-idf-53/esp-idf/components/hal /home/yanke/esp/esp-idf-53/esp-idf/components/heap /home/yanke/esp/esp-idf-53/esp-idf/components/http_parser /home/yanke/esp/esp-idf-53/esp-idf/components/idf_test /home/yanke/esp/esp-idf-53/esp-idf/components/ieee802154 /home/yanke/esp/esp-idf-53/esp-idf/components/json /home/yanke/esp/esp-idf-53/esp-idf/components/log /home/yanke/esp/esp-idf-53/esp-idf/components/lwip /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/main /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048 /home/yanke/esp/esp-idf-53/esp-idf/components/mbedtls /home/yanke/esp/esp-idf-53/esp-idf/components/mqtt /home/yanke/esp/esp-idf-53/esp-idf/components/newlib /home/yanke/esp/esp-idf-53/esp-idf/components/nvs_flash /home/yanke/esp/esp-idf-53/esp-idf/components/nvs_sec_provider /home/yanke/esp/esp-idf-53/esp-idf/components/openthread /home/yanke/esp/esp-idf-53/esp-idf/components/partition_table /home/yanke/esp/esp-idf-53/esp-idf/components/perfmon /home/yanke/esp/esp-idf-53/esp-idf/components/protobuf-c /home/yanke/esp/esp-idf-53/esp-idf/components/protocomm /home/yanke/esp/esp-idf-53/esp-idf/components/pthread /home/yanke/esp/esp-idf-53/esp-idf/components/sdmmc /home/yanke/esp/esp-idf-53/esp-idf/components/soc /home/yanke/esp/esp-idf-53/esp-idf/components/spi_flash /home/yanke/esp/esp-idf-53/esp-idf/components/spiffs /home/yanke/esp/esp-idf-53/esp-idf/components/tcp_transport /home/yanke/esp/esp-idf-53/esp-idf/tools/unit-test-app/components/test_utils /home/yanke/esp/esp-idf-53/esp-idf/components/touch_element /home/yanke/esp/esp-idf-53/esp-idf/components/ulp /home/yanke/esp/esp-idf-53/esp-idf/components/unity /home/yanke/esp/esp-idf-53/esp-idf/components/usb /home/yanke/esp/esp-idf-53/esp-idf/components/vfs /home/yanke/esp/esp-idf-53/esp-idf/components/wear_levelling /home/yanke/esp/esp-idf-53/esp-idf/components/wifi_provisioning /home/yanke/esp/esp-idf-53/esp-idf/components/wpa_supplicant /home/yanke/esp/esp-idf-53/esp-idf/components/xtensa
-- Configuring done
-- Generating done
-- Build files have been written to: /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/build
[0/1] Re-running CMake...
-- Building ESP-IDF components for target esp32s3
-- Project sdkconfig file /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/sdkconfig
-- Compiler supported targets: xtensa-esp-elf
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/soc/esp32s3/ld/esp32s3.peripherals.ld
-- Bootloader project name: "bootloader" version: 1
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.api.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.libgcc.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.wdt.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.version.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom/esp32s3/ld/esp32s3.rom.newlib.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/bootloader/subproject/main/ld/esp32s3/bootloader.ld
-- Adding linker script /home/yanke/esp/esp-idf-53/esp-idf/components/bootloader/subproject/main/ld/esp32s3/bootloader.rom.ld
-- Components: bootloader bootloader_support efuse esp_app_format esp_bootloader_format esp_common esp_hw_support esp_rom esp_system esptool_py freertos hal log main micro-ecc newlib partition_table soc spi_flash xtensa
-- Component paths: /home/yanke/esp/esp-idf-53/esp-idf/components/bootloader /home/yanke/esp/esp-idf-53/esp-idf/components/bootloader_support /home/yanke/esp/esp-idf-53/esp-idf/components/efuse /home/yanke/esp/esp-idf-53/esp-idf/components/esp_app_format /home/yanke/esp/esp-idf-53/esp-idf/components/esp_bootloader_format /home/yanke/esp/esp-idf-53/esp-idf/components/esp_common /home/yanke/esp/esp-idf-53/esp-idf/components/esp_hw_support /home/yanke/esp/esp-idf-53/esp-idf/components/esp_rom /home/yanke/esp/esp-idf-53/esp-idf/components/esp_system /home/yanke/esp/esp-idf-53/esp-idf/components/esptool_py /home/yanke/esp/esp-idf-53/esp-idf/components/freertos /home/yanke/esp/esp-idf-53/esp-idf/components/hal /home/yanke/esp/esp-idf-53/esp-idf/components/log /home/yanke/esp/esp-idf-53/esp-idf/components/bootloader/subproject/main /home/yanke/esp/esp-idf-53/esp-idf/components/bootloader/subproject/components/micro-ecc /home/yanke/esp/esp-idf-53/esp-idf/components/newlib /home/yanke/esp/esp-idf-53/esp-idf/components/partition_table /home/yanke/esp/esp-idf-53/esp-idf/components/soc /home/yanke/esp/esp-idf-53/esp-idf/components/spi_flash /home/yanke/esp/esp-idf-53/esp-idf/components/xtensa
-- Configuring done
-- Generating done
-- Build files have been written to: /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/build/bootloader
[1/1] cd /home/yanke/project/esp-iot-solution/components/sensors/battery_...ors/battery_fuel_gauge/max17048/test_apps/build/bootloader/bootloader.bin
Bootloader binary size 0x4f60 bytes. 0x30a0 bytes (38%) free.
[4/5] Generating binary image from built executable
esptool.py v4.8.1
Creating esp32s3 image...
Merged 2 ELF sections
Successfully created esp32s3 image.
Generated /home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/build/max17048_test.bin
[5/5] cd /home/yanke/project/esp-iot-solution/components/sensors/battery_...nts/sensors/battery_fuel_gauge/max17048/test_apps/build/max17048_test.bin
max17048_test.bin binary size 0x3a200 bytes. Smallest app partition is 0x100000 bytes. 0xc5e00 bytes (77%) free.

Project build complete. To flash, run:
 idf.py flash
or
 idf.py -p PORT flash
or
 python -m esptool --chip esp32s3 -b 460800 --before default_reset --after hard_reset write_flash --flash_mode dio --flash_size 2MB --flash_freq 80m 0x0 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin 0x10000 build/max17048_test.bin
or from the "/home/yanke/project/esp-iot-solution/components/sensors/battery_fuel_gauge/max17048/test_apps/build" directory
 python -m esptool --chip esp32s3 -b 460800 --before default_reset --after hard_reset write_flash "@flash_args"

[michaelboeding]

Seems my idf environment locally was not set - so that was the problem there. Would it be more robust to use the menuconfig patch I added to make sure it always finds the environment?

I still had issues getting it working after I did that some other includes conflicted. Going to try and work through that now

[michaelboeding]

I reworked all my i2c devices other than use the same i2c_bus and this fixed the problem - so will close. But I do think updating the menuconfig to match what I added above would be more robust.

[michaelboeding]

Just as a note also I would recommend adding the following code:

/**
 * @brief Enable or disable the 'State of Charge 1% Change' alert.
 *
 * @param sensor Handle for the MAX17048 sensor.
 * @param enabled True to enable the alert, false to disable.
 * @return ESP_OK on success, ESP_FAIL on failure.
 */
esp_err_t max17048_set_soc_change_alert_enabled(max17048_handle_t sensor, bool enabled);

/**
 * @brief Check if the 'State of Charge 1% Change' alert is enabled.
 *
 * @param sensor Handle for the MAX17048 sensor.
 * @param enabled Pointer to store the result (true if enabled, false if disabled).
 * @return ESP_OK on success, ESP_FAIL on failure.
 */
esp_err_t max17048_is_soc_change_alert_enabled(max17048_handle_t sensor, bool *enabled);

/**
 * @brief Set the low state-of-charge alert threshold.
 *
 * @param sensor Handle for the MAX17048 sensor.
 * @param threshold_percent The desired alert threshold (1 to 32 percent).
 * @return ESP_OK on success, ESP_FAIL on failure.
 */
esp_err_t max17048_set_soc_low_alert_threshold(max17048_handle_t sensor, uint8_t threshold_percent);

/**
 * @brief Get the configured low state-of-charge alert threshold.
 *
 * @param sensor Handle for the MAX17048 sensor.
 * @param threshold_percent Pointer to store the configured threshold (1 to 32 percent).
 * @return ESP_OK on success, ESP_FAIL on failure.
 */
esp_err_t max17048_get_soc_low_alert_threshold(max17048_handle_t sensor, uint8_t *threshold_percent);


/**
 * @brief Forces the fuel gauge to restart its calculation algorithm.
 *
 * This should be used when an external event provides a more accurate
 * indication of the battery's state, such as a charger indicating "charge complete".
 *
 * @param sensor Handle for the MAX17048 sensor.
 * @return ESP_OK on success, ESP_FAIL on failure.
 */
esp_err_t max17048_quick_start(max17048_handle_t sensor);

esp_err_t max17048_set_soc_change_alert_enabled(max17048_handle_t sensor, bool enabled)
{
    if (sensor == NULL) {
        return ESP_ERR_INVALID_ARG;
    }

    max17048_sensor_t *sens = (max17048_sensor_t *)sensor;
    uint8_t buf[2];
    esp_err_t ret = i2c_bus_read_bytes(sens->i2c_dev, MAX17048_CONFIG_REG, 2, buf);
    if (ret != ESP_OK) {
        return ESP_FAIL;
    }

    uint16_t result = ((uint16_t)buf[0] << 8) | buf[1];

    if (enabled) {
        result |= (1 << 6); // Set ALSC bit (bit 6 of the 16-bit register)
    } else {
        result &= ~(1 << 6); // Clear ALSC bit
    }

    buf[0] = (uint8_t)(result >> 8);
    buf[1] = (uint8_t)(result & 0xFF);
    return i2c_bus_write_bytes(sens->i2c_dev, MAX17048_CONFIG_REG, 2, buf);
}


esp_err_t max17048_is_soc_change_alert_enabled(max17048_handle_t sensor, bool *enabled)
{
    if (sensor == NULL || enabled == NULL) {
        return ESP_ERR_INVALID_ARG;
    }

    max17048_sensor_t *sens = (max17048_sensor_t *)sensor;
    uint8_t buf[2];
    esp_err_t ret = i2c_bus_read_bytes(sens->i2c_dev, MAX17048_CONFIG_REG, 2, buf);
    if (ret != ESP_OK) {
        return ESP_FAIL;
    }

    uint16_t result = ((uint16_t)buf[0] << 8) | buf[1];
    *enabled = (result & (1 << 6)) ? true : false;
    return ESP_OK;
}


/**
 * @brief Set the low state-of-charge alert threshold.
 *
 * @param sensor Handle for the MAX17048 sensor.
 * @param threshold_percent The desired alert threshold (1 to 32 percent).
 * @return ESP_OK on success, ESP_FAIL on failure.
 */
esp_err_t max17048_set_soc_low_alert_threshold(max17048_handle_t sensor, uint8_t threshold_percent)
{
    if (sensor == NULL) {
        return ESP_ERR_INVALID_ARG;
    }
    // Clamp the input value to the allowed range of 1-32%
    if (threshold_percent > 32) {
        threshold_percent = 32;
    }
    if (threshold_percent < 1) {
        threshold_percent = 1;
    }

    // Convert percentage to the register value using the datasheet formula: ATHD = 32 - threshold
    uint8_t athd_val = 32 - threshold_percent;

    max17048_sensor_t *sens = (max17048_sensor_t *)sensor;
    uint8_t buf[2];
    esp_err_t ret = i2c_bus_read_bytes(sens->i2c_dev, MAX17048_CONFIG_REG, 2, buf);
    if (ret != ESP_OK) {
        return ESP_FAIL;
    }

    uint16_t result = ((uint16_t)buf[0] << 8) | buf[1];

    // Clear the old ATHD bits (bits 0-4)
    result &= ~0x001F;
    // Set the new ATHD bits
    result |= athd_val;

    buf[0] = (uint8_t)(result >> 8);
    buf[1] = (uint8_t)(result & 0xFF);
    return i2c_bus_write_bytes(sens->i2c_dev, MAX17048_CONFIG_REG, 2, buf);
}

/**
 * @brief Get the configured low state-of-charge alert threshold.
 *
 * @param sensor Handle for the MAX17048 sensor.
 * @param threshold_percent Pointer to store the configured threshold (1 to 32 percent).
 * @return ESP_OK on success, ESP_FAIL on failure.
 */
esp_err_t max17048_get_soc_low_alert_threshold(max17048_handle_t sensor, uint8_t *threshold_percent)
{
    if (sensor == NULL || threshold_percent == NULL) {
        return ESP_ERR_INVALID_ARG;
    }

    max17048_sensor_t *sens = (max17048_sensor_t *)sensor;
    uint8_t buf[2];
    esp_err_t ret = i2c_bus_read_bytes(sens->i2c_dev, MAX17048_CONFIG_REG, 2, buf);
    if (ret != ESP_OK) {
        return ESP_FAIL;
    }

    uint16_t result = ((uint16_t)buf[0] << 8) | buf[1];

    // Mask out the ATHD bits (0-4)
    uint8_t athd_val = result & 0x1F;

    // Convert the register value back to a percentage
    *threshold_percent = 32 - athd_val;
    return ESP_OK;
}


esp_err_t max17048_quick_start(max17048_handle_t sensor)
{
    if (sensor == NULL) {
        return ESP_ERR_INVALID_ARG;
    }

    max17048_sensor_t *sens = (max17048_sensor_t *)sensor;
    uint8_t buf[2];
    // Read the current contents of the MODE register to preserve other settings
    esp_err_t ret = i2c_bus_read_bytes(sens->i2c_dev, MAX17048_MODE_REG, 2, buf);
    if (ret != ESP_OK) {
        return ESP_FAIL;
    }

    uint16_t result = ((uint16_t)buf[0] << 8) | buf[1];

    // Set the Quick-Start bit (bit 14 of the 16-bit register)
    result |= (1 << 14);

    buf[0] = (uint8_t)(result >> 8);
    buf[1] = (uint8_t)(result & 0xFF);
    
    // Write the modified value back to the MODE register to trigger the quick-start
    return i2c_bus_write_bytes(sens->i2c_dev, MAX17048_MODE_REG, 2, buf);
}

It seems the ability to configure some of the intterupt/alert settings were missing. The above is my implementation

[YanKE01]

Thank you very much for your suggestion. We will evaluate this part of the content and consider adding it to the next version.