diff options
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_profiles/ant_bsc/pages/ant_bsc_page_4.h')
| -rw-r--r-- | thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_profiles/ant_bsc/pages/ant_bsc_page_4.h | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_profiles/ant_bsc/pages/ant_bsc_page_4.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_profiles/ant_bsc/pages/ant_bsc_page_4.h new file mode 100644 index 0000000..093ef57 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/ant/ant_profiles/ant_bsc/pages/ant_bsc_page_4.h @@ -0,0 +1,113 @@ +/** + * Copyright (c) 2015 - 2018, Nordic Semiconductor ASA + * + * All rights reserved. + * + * 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, except as embedded into a Nordic + * Semiconductor ASA integrated circuit in a product or a software update for + * such product, 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 Nordic Semiconductor ASA nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * 4. This software, with or without modification, must only be used with a + * Nordic Semiconductor ASA integrated circuit. + * + * 5. Any software provided in binary form under this license must not be reverse + * engineered, decompiled, modified and/or disassembled. + * + * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS + * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA 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. + * + */ +#ifndef ANT_BSC_PAGE_4_H__ +#define ANT_BSC_PAGE_4_H__ + +/** @file + * + * @defgroup ant_sdk_profiles_bsc_page4 BSC profile page 4 + * @{ + * @ingroup ant_sdk_profiles_bsc_pages + */ + +#include <stdint.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/**@brief BSC profile battery status. + * + * This enum represents possible battery status values for the ANT BSC profile. + */ +typedef enum +{ + RESERVED0 = 0, ///< Reserved. + BSC_BAT_STATUS_NEW = 1, ///< Battery status: new. + BSC_BAT_STATUS_GOOD = 2, ///< Battery status: good. + BSC_BAT_STATUS_OK = 3, ///< Battery status: ok. + BSC_BAT_STATUS_LOW = 4, ///< Battery status: low. + BSC_BAT_STATUS_CRITICAL = 5, ///< Battery status: critical. + RESERVED1 = 6, ///< Reserved. + BSC_BAT_STATUS_INVALID = 7 ///< Invalid battery status. +} ant_bsc_bat_status_t; + +/**@brief Data structure for BSC data page 4. + * + * This structure implements only page 4 specific data. + */ +typedef struct +{ + uint8_t fract_bat_volt; ///< Fractional battery voltage. + uint8_t coarse_bat_volt : 4; ///< Coarse battery voltage. + uint8_t bat_status : 3; ///< Battery status. +} ant_bsc_page4_data_t; + +/**@brief Initialize page 4. + */ +#define DEFAULT_ANT_BSC_PAGE4() \ + (ant_bsc_page4_data_t) \ + { \ + .fract_bat_volt = 0, \ + .coarse_bat_volt = 0, \ + .bat_status = BSC_BAT_STATUS_INVALID \ + } + +/**@brief Function for encoding page 4. + * + * @param[in] p_page_data Pointer to the page data. + * @param[out] p_page_buffer Pointer to the data buffer. + */ +void ant_bsc_page_4_encode(uint8_t * p_page_buffer, ant_bsc_page4_data_t const * p_page_data); + +/**@brief Function for decoding page 4. + * + * @param[in] p_page_buffer Pointer to the data buffer. + * @param[out] p_page_data Pointer to the page data. + */ +void ant_bsc_page_4_decode(uint8_t const * p_page_buffer, ant_bsc_page4_data_t * p_page_data); + + +#ifdef __cplusplus +} +#endif + +#endif // ANT_BSC_PAGE_4_H__ +/** @} */ |