MEASUREMENT Module Sources


meas.c

/**
 *
 * @copyright © 2010 - 2019, Fraunhofer-Gesellschaft zur Foerderung der
 *  angewandten Forschung e.V. All rights reserved.
 *
 * BSD 3-Clause License
 * 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 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 the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
 *
 * We kindly request you to use one or more of the following phrases to refer
 * to foxBMS in your hardware, software, documentation or advertising
 * materials:
 *
 * ″This product uses parts of foxBMS®″
 *
 * ″This product includes parts of foxBMS®″
 *
 * ″This product is derived from foxBMS®″
 *
 */

/**
 * @file    meas.c
 * @author  foxBMS Team
 * @date    11.11.2016 (date of creation)
 * @ingroup DRIVERS
 * @prefix  MEAS
 *
 * @brief   Driver for the measurements needed by the BMS (e.g., I,V,T).
 *
 */

/*================== Includes =============================================*/
#include "meas.h"
#include "ltc.h"

/*================== Macros and Definitions ===============================*/

/*================== Constant and Variable Definitions ====================*/


/*================== Function Prototypes ==================================*/

/*================== Function Implementations =============================*/


void MEAS_Ctrl(void) {
}


extern uint8_t MEAS_Request_IO_Write(void) {
    STD_RETURN_TYPE_e retval = E_NOT_OK;

#if LTC_PORTEXPANDER_VERSION == 1

    if (LTC_SetStateRequest(LTC_STATE_USER_IO_WRITE_REQUEST_TI) == LTC_OK) {
        retval = E_OK;
    }

#else

    if (LTC_SetStateRequest(LTC_STATE_USER_IO_WRITE_REQUEST) == LTC_OK) {
        retval = E_OK;
    }

#endif

    return (retval);
}

extern uint8_t MEAS_Request_IO_Read(void) {
    STD_RETURN_TYPE_e retval = E_NOT_OK;

#if LTC_PORTEXPANDER_VERSION == 1

    if (LTC_SetStateRequest(LTC_STATE_USER_IO_READ_REQUEST_TI) == LTC_OK) {
        retval = E_OK;
    }

#else

    if (LTC_SetStateRequest(LTC_STATE_USER_IO_READ_REQUEST) == LTC_OK) {
        retval = E_OK;
    }

#endif

    return (retval);
}

extern uint8_t MEAS_Request_Temperature_Read(void) {
    STD_RETURN_TYPE_e retval = E_NOT_OK;

    if (LTC_SetStateRequest(LTC_STATE_TEMP_SENS_READ_REQUEST) == LTC_OK) {
        retval = E_OK;
    }

    return (retval);
}

extern uint8_t MEAS_Request_BalancingFeedback_Read(void) {
    STD_RETURN_TYPE_e retval = E_NOT_OK;

    if (LTC_SetStateRequest(LTC_STATE_BALANCEFEEDBACK_REQUEST) == LTC_OK) {
        retval = E_OK;
    }

    return (retval);
}


extern uint8_t MEAS_Request_EEPROM_Read(void) {
    STD_RETURN_TYPE_e retval = E_NOT_OK;

    if (LTC_SetStateRequest(LTC_STATE_EEPROM_READ_REQUEST) == LTC_OK) {
        retval = E_OK;
    }

    return (retval);
}

extern uint8_t MEAS_Request_EEPROM_Write(void) {
    STD_RETURN_TYPE_e retval = E_NOT_OK;

    if (LTC_SetStateRequest(LTC_STATE_EEPROM_WRITE_REQUEST) == LTC_OK) {
        retval = E_OK;
    }

    return (retval);
}

extern uint8_t MEAS_Request_OpenWireCheck(void) {
    STD_RETURN_TYPE_e retval = E_NOT_OK;

    if (LTC_SetStateRequest(LTC_STATE_OPENWIRE_CHECK_REQUEST) == LTC_OK) {
        retval = E_OK;
    }

    return (retval);
}


extern STD_RETURN_TYPE_e MEAS_IsFirstMeasurementCycleFinished(void) {
    uint8_t retval = FALSE;

    retval    = LTC_IsFirstMeasurementCycleFinished();

    return (retval);
}


extern STD_RETURN_TYPE_e MEAS_StartMeasurement(void) {
    STD_RETURN_TYPE_e retval = E_NOT_OK;

    if (LTC_SetStateRequest(LTC_STATE_INIT_REQUEST) == LTC_OK) {
        retval = E_OK;
    }

    return retval;
}

meas.h

/**
 *
 * @copyright © 2010 - 2019, Fraunhofer-Gesellschaft zur Foerderung der
 *  angewandten Forschung e.V. All rights reserved.
 *
 * BSD 3-Clause License
 * 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 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 the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
 *
 * We kindly request you to use one or more of the following phrases to refer
 * to foxBMS in your hardware, software, documentation or advertising
 * materials:
 *
 * ″This product uses parts of foxBMS®″
 *
 * ″This product includes parts of foxBMS®″
 *
 * ″This product is derived from foxBMS®″
 *
 */

/**
 * @file    meas.h
 * @author  foxBMS Team
 * @date    02.10.2015 (date of creation)
 * @ingroup DRIVERS
 * @prefix  MEAS
 *
 * @brief   Headers for the driver for the measurements needed by the BMS (e.g., I,V,T).
 *
 */

#ifndef MEAS_H_
#define MEAS_H_

/*================== Includes =============================================*/
#include "meas_cfg.h"

/*================== Macros and Definitions ===============================*/

/*================== Constant and Variable Definitions ====================*/

/*================== Function Prototypes ==================================*/

extern void MEAS_Ctrl(void);

/**
 * @brief   Checks if the first LTC measurement cycle was made
 *
 * @return  TURE is the first measurement cycle was made, FALSE otherwise
 *
 */
extern STD_RETURN_TYPE_e MEAS_IsFirstMeasurementCycleFinished(void);

/**
 * @brief   Makes the initialization request to the LTC state machine
 *
 */
extern STD_RETURN_TYPE_e MEAS_StartMeasurement(void);

/**
 * @brief   Makes the request to the LTC state machine to write to the IO port-expander
 *
 */
extern uint8_t MEAS_Request_IO_Write(void);

/**
 * @brief   Makes the request to the LTC state machine to read from the IO port-expander
 *
 */
extern uint8_t MEAS_Request_IO_Read(void);

/**
 * @brief   Makes the request to the LTC state machine to read from the external temperature sensor on slaves
 *
 */
extern uint8_t MEAS_Request_Temperature_Read(void);

/**
 * @brief   Makes the request to the LTC state machine to read balancing feedback from the slaves
 *
 */
extern uint8_t MEAS_Request_BalancingFeedback_Read(void);

/**
 * @brief   Makes the request to the LTC state machine to read from the external EEPROM on slaves
 *
 */
extern uint8_t MEAS_Request_EEPROM_Read(void);

/**
 * @brief   Makes the request to the LTC state machine to write to the external EEPROM on slaves
 *
 */
extern uint8_t MEAS_Request_EEPROM_Write(void);

/**
 * @brief   Makes the request to the LTC state machine to perform open-wire check
 *
 */
extern uint8_t MEAS_Request_OpenWireCheck(void);

/*================== Function Implementations =============================*/


#endif /* MEAS_H_ */

meas_cfg.c

/**
 *
 * @copyright © 2010 - 2019, Fraunhofer-Gesellschaft zur Foerderung der
 *  angewandten Forschung e.V. All rights reserved.
 *
 * BSD 3-Clause License
 * 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 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 the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
 *
 * We kindly request you to use one or more of the following phrases to refer
 * to foxBMS in your hardware, software, documentation or advertising
 * materials:
 *
 * ″This product uses parts of foxBMS®″
 *
 * ″This product includes parts of foxBMS®″
 *
 * ″This product is derived from foxBMS®″
 *
 */

/**
 * @file    meas_cfg.c
 * @author  foxBMS Team
 * @date    11.11.2016 (date of creation)
 * @ingroup MODULE_CONF
 * @prefix  MEAS
 *
 * @brief   Bmscontrol configuration
 *
 * Configuration implementation of the MEAS module, empty
 *
 */



/*================== Includes =============================================*/
#include "meas_cfg.h"

/*================== Macros and Definitions ===============================*/



/*================== Constant and Variable Definitions ====================*/



/*================== Function Prototypes ==================================*/



/*================== Function Implementations =============================*/

meas_cfg.h

/**
 *
 * @copyright © 2010 - 2019, Fraunhofer-Gesellschaft zur Foerderung der
 *  angewandten Forschung e.V. All rights reserved.
 *
 * BSD 3-Clause License
 * 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 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 the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
 *
 * We kindly request you to use one or more of the following phrases to refer
 * to foxBMS in your hardware, software, documentation or advertising
 * materials:
 *
 * ″This product uses parts of foxBMS®″
 *
 * ″This product includes parts of foxBMS®″
 *
 * ″This product is derived from foxBMS®″
 *
 */

/**
 * @file    meas_cfg.h
 * @author  foxBMS Team
 * @date    04.12.2015 (date of creation)
 * @ingroup MODULE_CONF
 * @prefix  MEAS
 *
 * @brief   meas configuration header
 *
 */

#ifndef MEAS_CFG_H_
#define MEAS_CFG_H_

/*================== Includes =============================================*/
#include "general.h"

/*================== Macros and Definitions ===============================*/


/*================== Constant and Variable Definitions ====================*/


/*================== Function Prototypes ==================================*/


/*================== Function Implementations =============================*/


#endif /* MEAS_CFG_H_ */

meas_cfg.c

/**
 *
 * @copyright © 2010 - 2019, Fraunhofer-Gesellschaft zur Foerderung der
 *  angewandten Forschung e.V. All rights reserved.
 *
 * BSD 3-Clause License
 * 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 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 the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
 *
 * We kindly request you to use one or more of the following phrases to refer
 * to foxBMS in your hardware, software, documentation or advertising
 * materials:
 *
 * ″This product uses parts of foxBMS®″
 *
 * ″This product includes parts of foxBMS®″
 *
 * ″This product is derived from foxBMS®″
 *
 */

/**
 * @file    meas_cfg.c
 * @author  foxBMS Team
 * @date    11.11.2016 (date of creation)
 * @ingroup MODULE_CONF
 * @prefix  MEAS
 *
 * @brief   Bmscontrol configuration
 *
 * Configuration implementation of the MEAS module, empty
 *
 */



/*================== Includes =============================================*/
#include "meas_cfg.h"

/*================== Macros and Definitions ===============================*/



/*================== Constant and Variable Definitions ====================*/



/*================== Function Prototypes ==================================*/



/*================== Function Implementations =============================*/

meas_cfg.h

/**
 *
 * @copyright © 2010 - 2019, Fraunhofer-Gesellschaft zur Foerderung der
 *  angewandten Forschung e.V. All rights reserved.
 *
 * BSD 3-Clause License
 * 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 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 the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
 *
 * We kindly request you to use one or more of the following phrases to refer
 * to foxBMS in your hardware, software, documentation or advertising
 * materials:
 *
 * ″This product uses parts of foxBMS®″
 *
 * ″This product includes parts of foxBMS®″
 *
 * ″This product is derived from foxBMS®″
 *
 */

/**
 * @file    meas_cfg.h
 * @author  foxBMS Team
 * @date    04.12.2015 (date of creation)
 * @ingroup MODULE_CONF
 * @prefix  MEAS
 *
 * @brief   meas configuration header
 *
 */

#ifndef MEAS_CFG_H_
#define MEAS_CFG_H_

/*================== Includes =============================================*/
#include "general.h"

/*================== Macros and Definitions ===============================*/


/*================== Constant and Variable Definitions ====================*/


/*================== Function Prototypes ==================================*/


/*================== Function Implementations =============================*/


#endif /* MEAS_CFG_H_ */