Nordic Thingy:52 v2.2.0
drv_humidity.h
1 /*
2  Copyright (c) 2010 - 2017, Nordic Semiconductor ASA
3  All rights reserved.
4 
5  Redistribution and use in source and binary forms, with or without modification,
6  are permitted provided that the following conditions are met:
7 
8  1. Redistributions of source code must retain the above copyright notice, this
9  list of conditions and the following disclaimer.
10 
11  2. Redistributions in binary form, except as embedded into a Nordic
12  Semiconductor ASA integrated circuit in a product or a software update for
13  such product, must reproduce the above copyright notice, this list of
14  conditions and the following disclaimer in the documentation and/or other
15  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  4. This software, with or without modification, must only be used with a
22  Nordic Semiconductor ASA integrated circuit.
23 
24  5. Any software provided in binary form under this license must not be reverse
25  engineered, decompiled, modified and/or disassembled.
26 
27  THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
28  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
29  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
30  DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
31  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
33  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
36  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */
38 
48 #ifndef __DRV_HUMIDITY_H__
49 #define __DRV_HUMIDITY_H__
50 
51 #include "nrf_drv_twi.h"
52 #include <stdint.h>
53 
56 typedef enum
57 {
61 
65 
68 typedef struct
69 {
70  uint8_t twi_addr;
71  uint32_t pin_int;
72  nrf_drv_twi_t const * p_twi_instance;
73  nrf_drv_twi_config_t const * p_twi_cfg;
74  drv_humidity_evt_handler_t evt_handler;
76 
84 uint32_t drv_humidity_init(drv_humidity_init_t * p_params);
85 
90 uint32_t drv_humidity_enable(void);
91 
96 uint32_t drv_humidity_disable(void);
97 
103 uint32_t drv_humidity_reset(void);
104 
109 int16_t drv_humidity_get(void);
110 
115 float drv_humidity_temp_get(void);
116 
121 uint32_t drv_humidity_sample(void);
122 
123 #endif
124 
uint32_t drv_humidity_sample(void)
Function to start sampling.
int16_t drv_humidity_get(void)
Function for getting the humidity data.
Definition: drv_humidity.h:59
uint32_t drv_humidity_init(drv_humidity_init_t *p_params)
Function for initializing the humidity driver.
uint32_t drv_humidity_disable(void)
Function for disabling the humidity sensor.
Definition: drv_humidity.h:58
uint32_t drv_humidity_enable(void)
Function for enabling the humidity sensor.
nrf_drv_twi_config_t const * p_twi_cfg
The TWI configuration to use while the driver is enabled.
Definition: drv_humidity.h:73
drv_humidity_evt_t
Humidity driver event types.
Definition: drv_humidity.h:56
void(* drv_humidity_evt_handler_t)(drv_humidity_evt_t evt)
Humidity driver event handler callback type.
Definition: drv_humidity.h:64
uint32_t drv_humidity_reset(void)
Function for resetting the chip to all default register values.
Initialization struct for the humidity driver.
Definition: drv_humidity.h:68
nrf_drv_twi_t const * p_twi_instance
The instance of TWI master to be used for transactions.
Definition: drv_humidity.h:72
float drv_humidity_temp_get(void)
Function for getting the temperature data.