77 lines
2.7 KiB
C
77 lines
2.7 KiB
C
|
/**
|
||
|
|
* Copyright (c) 2016 - 2020, 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 ES_TLM_H__
|
||
|
|
#define ES_TLM_H__
|
||
|
|
|
||
|
|
#include "es.h"
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @file
|
||
|
|
* @defgroup eddystone_tlm TLM
|
||
|
|
* @brief Functions for the Eddystone telemetry (TLM) manager.
|
||
|
|
* @ingroup eddystone_adv
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**@brief Function for initializing the TLM manager.
|
||
|
|
*
|
||
|
|
* @return See @ref app_timer_start for possible return values.
|
||
|
|
*/
|
||
|
|
void es_tlm_init(void);
|
||
|
|
|
||
|
|
/**@brief Function for getting the current TLM.
|
||
|
|
*
|
||
|
|
* @param[in] p_tlm_frame Pointer to the TLM frame to which the frame is retrieved.
|
||
|
|
*/
|
||
|
|
void es_tlm_tlm_get(es_tlm_frame_t * p_tlm_frame);
|
||
|
|
|
||
|
|
/**@brief Function for incrementing the ADV_CNT field of the TLM frame.
|
||
|
|
*
|
||
|
|
* @details This function should be called every time a frame is advertised.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
void es_tlm_adv_cnt_inc(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
#endif // ES_TLM_H__
|