oximeter3 2.0.0.0
oximeter3.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
33// ----------------------------------------------------------------------------
34
35#ifndef OXIMETER3_H
36#define OXIMETER3_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define OXIMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
62#define OXIMETER3_RETVAL uint8_t
63
64#define OXIMETER3_OK 0x00
65#define OXIMETER3_INIT_ERROR 0xFF
66#define OXIMETER3_ERROR 0xFF
73#define OXIMETER3_SLAVE_ADDRESS 0x13
74
79#define OXIMETER3_REG_COMMAND 0x80
80#define OXIMETER3_REG_PRODUCT_ID 0x81
81#define OXIMETER3_REG_PROX_RATE 0x82
82#define OXIMETER3_REG_LED_CURRENT 0x83
83#define OXIMETER3_REG_ALS_PARAMETER 0x84
84#define OXIMETER3_REG_ALS_RESULT_MSB 0x85
85#define OXIMETER3_REG_ALS_RESULT_LSB 0x86
86#define OXIMETER3_REG_PROX_RESULT_MSB 0x87
87#define OXIMETER3_REG_PROX_RESULT_LSB 0x88
88#define OXIMETER3_REG_INTERRUPT_CTRL 0x89
89#define OXIMETER3_REG_LOW_THRESHOLD_MSB 0x8A
90#define OXIMETER3_REG_LOW_THRESHOLD_LSB 0x8B
91#define OXIMETER3_REG_HIGH_THRESHOLD_MSB 0x8C
92#define OXIMETER3_REG_HIGH_THRESHOLD_LSB 0x8D
93#define OXIMETER3_REG_INTERRUPT_STATUS 0x8E
94#define OXIMETER3_REG_PROX_MODULATOR_TIMING 0x8F
101#define OXIMETER3_CMD_ALS_SINGLE_MEASUREMENT_ENABLE 0x10
102#define OXIMETER3_CMD_ALS_SINGLE_MEASUREMENT_DISABLE 0x00
103#define OXIMETER3_CMD_PROX_SINGLE_MEASUREMENT_ENABLE 0x08
104#define OXIMETER3_CMD_PROX_SINGLE_MEASUREMENT_DISABLE 0x00
105#define OXIMETER3_CMD_ALS_PERIODIC_MEASUREMENT_ENABLE 0x04
106#define OXIMETER3_CMD_ALS_PERIODIC_MEASUREMENT_DISABLE 0x00
107#define OXIMETER3_CMD_PROX_PERIODIC_MEASUREMENT_ENABLE 0x02
108#define OXIMETER3_CMD_PROX_PERIODIC_MEASUREMENT_DISABLE 0x00
109#define OXIMETER3_CMD_MEASUREMENT_ENABLE 0x01
110#define OXIMETER3_CMD_MEASUREMENT_DISABLE 0x00
111
112#define OXIMETER3_CMD_ALS_DATA_READY 0x40
113#define OXIMETER3_CMD_PROX_DATA_READY 0x20
120#define OXIMETER3_PROX_RATE_1p95_MPS 0x00
121#define OXIMETER3_PROX_RATE_3p90625_MPS 0x01
122#define OXIMETER3_PROX_RATE_7p8125_MPS 0x02
123#define OXIMETER3_PROX_RATE_16p625_MPS 0x03
124#define OXIMETER3_PROX_RATE_31p25_MPS 0x04
125#define OXIMETER3_PROX_RATE_62p5_MPS 0x05
126#define OXIMETER3_PROX_RATE_125_MPS 0x06
127#define OXIMETER3_PROX_RATE_250_MPS 0x07
134#define OXIMETER3_LED_CURR_MIN 1
135#define OXIMETER3_LED_CURR_MID 12
136#define OXIMETER3_LED_CURR_MAX 20
143#define OXIMETER3_ALS_PARAM_CONT_CONVERSION_ENABLE 0x80
144#define OXIMETER3_ALS_PARAM_CONT_CONVERSION_DISABLE 0x00
145#define OXIMETER3_ALS_PARAM_AUTO_OFSEN_ENABLE 0x08
146#define OXIMETER3_ALS_PARAM_AUTO_OFSEN_DISABLE 0x00
147#define OXIMETER3_ALS_PARAM_1_SAMPEL_PER_S 0x00
148#define OXIMETER3_ALS_PARAM_2_SAMPEL_PER_S 0x10
149#define OXIMETER3_ALS_PARAM_3_SAMPEL_PER_S 0x20
150#define OXIMETER3_ALS_PARAM_4_SAMPEL_PER_S 0x30
151#define OXIMETER3_ALS_PARAM_5_SAMPEL_PER_S 0x40
152#define OXIMETER3_ALS_PARAM_6_SAMPEL_PER_S 0x50
153#define OXIMETER3_ALS_PARAM_8_SAMPEL_PER_S 0x60
154#define OXIMETER3_ALS_PARAM_10_SAMPEL_PER_S 0x70
161#define OXIMETER3_INT_CTRL_1_CNT 0x00
162#define OXIMETER3_INT_CTRL_2_CNT 0x20
163#define OXIMETER3_INT_CTRL_4_CNT 0x40
164#define OXIMETER3_INT_CTRL_8_CNT 0x60
165#define OXIMETER3_INT_CTRL_16_CNT 0x80
166#define OXIMETER3_INT_CTRL_32_CNT 0xA0
167#define OXIMETER3_INT_CTRL_64_CNT 0xC0
168#define OXIMETER3_INT_CTRL_128_CNT 0xE0
169#define OXIMETER3_INT_CTRL_INT_ON_PROX_RDY 0x08
170#define OXIMETER3_INT_CTRL_INT_ON_ALS_RDY 0x04
171#define OXIMETER3_INT_CTRL_INT_ON_THRESHOLD 0x02
172#define OXIMETER3_INT_CTRL_INT_ON_THRESHOLD_PROX 0x00
173#define OXIMETER3_INT_CTRL_INT_ON_THRESHOLD_ALS 0x01
180#define OXIMETER3_INT_STATUS_PROX 0x08
181#define OXIMETER3_INT_STATUS_ALS 0x04
182#define OXIMETER3_INT_STATUS_LOW_THRESHOLD 0x02
183#define OXIMETER3_INT_STATUS_HIGH_THRESHOLD 0x01
190#define OXIMETER3_PROX_TIMING_FREQ_390p625_KHZ 0x00
191#define OXIMETER3_PROX_TIMING_FREQ_781p25_KHZ 0x01
192#define OXIMETER3_PROX_TIMING_FREQ_1p5625_MHZ 0x10
193#define OXIMETER3_PROX_TIMING_FREQ_3p125_MHZ 0x11
200#define OXIMETER3_ID_VAL 0x21
207#define OXIMETER3_ALS 0x11
208#define OXIMETER3_PROX 0x22
209#define OXIMETER3_HEART_RATE 0x33
216#define SHIFT_VALUE 8 // End group macro
220// --------------------------------------------------------------- PUBLIC TYPES
229typedef struct
230{
231 digital_in_t int_pin;
232
233 // Modules
234
235 i2c_master_t i2c;
236
237 // ctx variable
238
240
242
246typedef struct
247{
248 // Communication gpio pins
249
250 pin_name_t scl;
251 pin_name_t sda;
252
253 // Additional gpio pins
254
255 pin_name_t int_pin;
256
257 // static variable
258
259 uint32_t i2c_speed;
260 uint8_t i2c_address;
261
263 // End types group
265// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
266
272#ifdef __cplusplus
273extern "C"{
274#endif
275
285
294
305void oximeter3_generic_write ( oximeter3_t *ctx, uint8_t reg, uint8_t data_buf );
306
316uint8_t oximeter3_generic_read ( oximeter3_t *ctx, uint8_t reg );
317
326
337uint16_t oximeter3_read_value ( oximeter3_t *ctx, uint8_t type_macro );
338
339#ifdef __cplusplus
340}
341#endif
342#endif // _OXIMETER3_H_
343 // End public_function group
346
347// ------------------------------------------------------------------------- END
#define OXIMETER3_RETVAL
Definition: oximeter3.h:62
void oximeter3_generic_write(oximeter3_t *ctx, uint8_t reg, uint8_t data_buf)
Generic write function.
uint8_t oximeter3_generic_read(oximeter3_t *ctx, uint8_t reg)
Generic read function.
void oximeter3_cfg_setup(oximeter3_cfg_t *cfg)
Config Object Initialization function.
uint8_t oximeter3_get_int_status(oximeter3_t *ctx)
Gets state of the int pin.
uint16_t oximeter3_read_value(oximeter3_t *ctx, uint8_t type_macro)
Generic function for reading als and proximity values.
OXIMETER3_RETVAL oximeter3_init(oximeter3_t *ctx, oximeter3_cfg_t *cfg)
Initialization function.
Click configuration structure definition.
Definition: oximeter3.h:247
uint32_t i2c_speed
Definition: oximeter3.h:259
pin_name_t scl
Definition: oximeter3.h:250
pin_name_t int_pin
Definition: oximeter3.h:255
pin_name_t sda
Definition: oximeter3.h:251
uint8_t i2c_address
Definition: oximeter3.h:260
Click ctx object definition.
Definition: oximeter3.h:230
digital_in_t int_pin
Definition: oximeter3.h:231
i2c_master_t i2c
Definition: oximeter3.h:235
uint8_t slave_address
Definition: oximeter3.h:239