force3 2.0.0.0
force3.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 FORCE3_H
36#define FORCE3_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 FORCE3_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
61#define FORCE3_RETVAL uint8_t
62
63#define FORCE3_OK 0x00
64#define FORCE3_INIT_ERROR 0xFF
71#define FORCE3_DEVICE_SLAVE_ADDR 0x4D // End group macro
75// --------------------------------------------------------------- PUBLIC TYPES
84typedef struct
85{
86 // Modules
87
88 i2c_master_t i2c;
89
90 // ctx variable
91
93
94} force3_t;
95
99typedef struct
100{
101 // Communication gpio pins
102
103 pin_name_t scl;
104 pin_name_t sda;
105
106 // static variable
107
108 uint32_t i2c_speed;
109 uint8_t i2c_address;
110
112 // End types group
114// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
115
121#ifdef __cplusplus
122extern "C"{
123#endif
124
134
143
154void force3_generic_write ( force3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
155
167void force3_generic_read ( force3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
168
177
178#ifdef __cplusplus
179}
180#endif
181#endif // _FORCE3_H_
182 // End public_function group
185
186// ------------------------------------------------------------------------- END
#define FORCE3_RETVAL
Definition: force3.h:61
void force3_generic_write(force3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
uint16_t force3_read_raw_data(force3_t *ctx)
Read 12bit raw data.
FORCE3_RETVAL force3_init(force3_t *ctx, force3_cfg_t *cfg)
Initialization function.
void force3_generic_read(force3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void force3_cfg_setup(force3_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition: force3.h:100
uint32_t i2c_speed
Definition: force3.h:108
pin_name_t scl
Definition: force3.h:103
pin_name_t sda
Definition: force3.h:104
uint8_t i2c_address
Definition: force3.h:109
Click ctx object definition.
Definition: force3.h:85
i2c_master_t i2c
Definition: force3.h:88
uint8_t slave_address
Definition: force3.h:92