1 /*
2  * Copyright (c) 2017 - 2023, Nordic Semiconductor ASA
3  * All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  *    list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
18  *    contributors may be used to endorse or promote products derived from this
19  *    software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34 
35 /**
36  * @brief Module that defines the Thermometer Abstraction Layer for the 802.15.4 driver.
37  *
38  */
39 
40 #ifndef NRF_802154_TEMPERATURE_H_
41 #define NRF_802154_TEMPERATURE_H_
42 
43 #include <stdint.h>
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 /**
50  * @defgroup nrf_802154_temperature Thermometer Abstraction Layer for the 802.15.4 driver
51  * @{
52  * @ingroup nrf_802154_temperature
53  * @brief The Thermometer Abstraction Layer interface for the 802.15.4 driver.
54  *
55  * The Thermometer Abstraction Layer is an abstraction layer of the thermometer that is used
56  * to correct RSSI, LQI and ED measurements, and the CCA threshold value.
57  *
58  */
59 
60 /**
61  * @brief Initializes the thermometer.
62  */
63 void nrf_802154_temperature_init(void);
64 
65 /**
66  * @brief Deinitializes the thermometer.
67  */
68 void nrf_802154_temperature_deinit(void);
69 
70 /**
71  * @brief Gets the current temperature.
72  *
73  * @returns Current temperature, in centigrades (C).
74  */
75 int8_t nrf_802154_temperature_get(void);
76 
77 /**
78  * @brief Callback function executed when the temperature changes.
79  */
80 extern void nrf_802154_temperature_changed(void);
81 
82 /**
83  *@}
84  **/
85 
86 #ifdef __cplusplus
87 }
88 #endif
89 
90 #endif /* NRF_802154_TEMPERATURE_H_ */
91