/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2024 Eric Gionet (gionet.c.eric@gmail.com)
 *
 * 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.
 */

/**
 * Copyright (c) 2024 Eric Gionet (gionet.c.eric@gmail.com)
 *
 * MIT Licensed as described in the file LICENSE
 */

#ifndef __BME680_FW_VERSION_H__
#define __BME680_FW_VERSION_H__

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif


/**
 * public constant definitions
 */

#define BME680_COMPONENT_NAME              "esp_bme680"
/** Version release date  */
#define BME680_FW_VERSION_DATE             "2025-04-02"
/** Major version number (X.x.x) */
#define BME680_FW_VERSION_MAJOR            1
/** Minor version number (x.X.x) */
#define BME680_FW_VERSION_MINOR            2
/** Patch version number (x.x.X) */
#define BME680_FW_VERSION_PATCH            5
/** Semantic version number (X.X.X-X) */
#define BME680_FW_SEMANTIC_VERSION         "1.2.5-1"
/** Git version hash */
#define BME680_FW_GIT_SHORT_SHA            "82602db"


/**
 * public macro definitions
 */

/** 
 * Macro to print x parameter as a string i.e. enclose x in double quotes. 
 */
#define STR_QUOTES( x ) #x

/** 
 * Macro to create a string of x parameter with all macros fully expanded. 
 */                 
#define STR( x ) STR_QUOTES( x )

/** 
 * Macro to generate current firmware version numbers (major, minor, patch) into a string that is formatted as X.X.X (e.g. 4.0.0). 
 */
#define BME680_FW_VERSION_STR                        \
        STR( BME680_FW_VERSION_MAJOR ) "." \
        STR( BME680_FW_VERSION_MINOR ) "." \
        STR( BME680_FW_VERSION_PATCH )

/** 
 * Macro to convert firmware version parameters (major, minor, patch numbers) into an integer (`int32_t`) 
 * value that can be used for comparison purposes.
 * 
 * As an example, FW_VERSION_INT32 >= FW_VERSION_PARAMS_INT32(4, 0, 0).
 */
#define BME680_FW_VERSION_PARAMS_INT32( major, minor, patch )        \
        ((major << 16) | (minor << 8) | (patch))

/**
 * Macro to generate current firmware version numbers (major, minor, patch) as an integer (`int32_t`) value that can 
 * be used for comparison purposes.
 * 
 * As an example, FW_VERSION_INT32 >= FW_VERSION_PARAMS_INT32(4, 0, 0).
 */
#define BME680_FW_VERSION_INT32            \
        BME680_FW_VERSION_PARAMS_INT32(    \
                BME680_FW_VERSION_MAJOR,   \
                BME680_FW_VERSION_MINOR,   \
                BME680_FW_VERSION_PATCH)

#ifdef __cplusplus
}
#endif

/**@}*/

#endif //__BME680_FW_VERSION_H__
