hallcurrent3 2.0.0.0
hallcurrent3.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 HALLCURRENT3_H
36#define HALLCURRENT3_H
37
38#include "drv_digital_out.h"
39#include "drv_i2c_master.h"
40
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define HALLCURRENT3_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
61#define HALLCURRENT3_RETVAL uint8_t
62
63#define HALLCURRENT3_OK 0x00
64#define HALLCURRENT3_INIT_ERROR 0xFF // End group macro
68// --------------------------------------------------------------- PUBLIC TYPES
77typedef struct
78{
79 // Modules
80
81 i2c_master_t i2c;
82
83 // ctx variable
84
86
88
92typedef struct
93{
94 // Communication gpio pins
95
96 pin_name_t scl;
97 pin_name_t sda;
98
99 // static variable
100
101 uint32_t i2c_speed;
102 uint8_t i2c_address;
103
105 // End variable group
107// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
108
114#ifdef __cplusplus
115extern "C"{
116#endif
117
127
137
148void hallcurrent3_generic_read ( hallcurrent3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
149
158uint16_t hallcurrent3_read_data ( hallcurrent3_t *ctx, uint8_t reg );
159
168
169#ifdef __cplusplus
170}
171#endif
172#endif // _HALLCURRENT3_H_
173 // End public_function group
176
177// ------------------------------------------------------------------------- END
#define HALLCURRENT3_RETVAL
Definition: hallcurrent3.h:61
float hallcurrent3_get_current(hallcurrent3_t *ctx)
Get current function.
void hallcurrent3_cfg_setup(hallcurrent3_cfg_t *cfg)
Config Object Initialization function.
void hallcurrent3_generic_read(hallcurrent3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
HALLCURRENT3_RETVAL hallcurrent3_init(hallcurrent3_t *ctx, hallcurrent3_cfg_t *cfg)
Initialization function.
uint16_t hallcurrent3_read_data(hallcurrent3_t *ctx, uint8_t reg)
Data read function.
Click configuration structure definition.
Definition: hallcurrent3.h:93
uint32_t i2c_speed
Definition: hallcurrent3.h:101
pin_name_t scl
Definition: hallcurrent3.h:96
pin_name_t sda
Definition: hallcurrent3.h:97
uint8_t i2c_address
Definition: hallcurrent3.h:102
Click ctx object definition.
Definition: hallcurrent3.h:78
i2c_master_t i2c
Definition: hallcurrent3.h:81
uint8_t slave_address
Definition: hallcurrent3.h:85