hallswitch2 2.0.0.0
hallswitch2.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef HALLSWITCH2_H
29#define HALLSWITCH2_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37
58#define HALLSWITCH2_NO_MAGNET_DETECTED 0
59#define HALLSWITCH2_S_POLE_DETECTED 1
60#define HALLSWITCH2_N_POLE_DETECTED 2
61 // hallswitch2_set
63
78#define HALLSWITCH2_MAP_MIKROBUS( cfg, mikrobus ) \
79 cfg.n = MIKROBUS( mikrobus, MIKROBUS_CS ); \
80 cfg.s = MIKROBUS( mikrobus, MIKROBUS_INT )
81 // hallswitch2_map // hallswitch2
84
89typedef struct
90{
91 digital_in_t n;
92 digital_in_t s;
95
100typedef struct
101{
102 pin_name_t n;
103 pin_name_t s;
106
111typedef enum
112{
115
117
134
150
162
163#ifdef __cplusplus
164}
165#endif
166#endif // HALLSWITCH2_H
167 // hallswitch2
169
170// ------------------------------------------------------------------------ END
void hallswitch2_cfg_setup(hallswitch2_cfg_t *cfg)
Hall Switch 2 configuration object setup function.
uint8_t hallswitch2_check_state(hallswitch2_t *ctx)
Hall Switch 2 check state function.
err_t hallswitch2_init(hallswitch2_t *ctx, hallswitch2_cfg_t *cfg)
Hall Switch 2 initialization function.
hallswitch2_return_value_t
Hall Switch 2 Click return value data.
Definition: hallswitch2.h:112
@ HALLSWITCH2_ERROR
Definition: hallswitch2.h:114
@ HALLSWITCH2_OK
Definition: hallswitch2.h:113
Hall Switch 2 Click configuration object.
Definition: hallswitch2.h:101
pin_name_t n
Definition: hallswitch2.h:102
pin_name_t s
Definition: hallswitch2.h:103
Hall Switch 2 Click context object.
Definition: hallswitch2.h:90
digital_in_t s
Definition: hallswitch2.h:92
digital_in_t n
Definition: hallswitch2.h:91