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
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
68 #define HALLSWITCH2_NO_MAGNET_DETECTED 0
69 #define HALLSWITCH2_S_POLE_DETECTED 1
70 #define HALLSWITCH2_N_POLE_DETECTED 2
71  // hallswitch2_set
73 
88 #define HALLSWITCH2_MAP_MIKROBUS( cfg, mikrobus ) \
89  cfg.n = MIKROBUS( mikrobus, MIKROBUS_CS ); \
90  cfg.s = MIKROBUS( mikrobus, MIKROBUS_INT )
91  // hallswitch2_map // hallswitch2
94 
99 typedef struct
100 {
101  digital_in_t n;
102  digital_in_t s;
104 } hallswitch2_t;
105 
110 typedef struct
111 {
112  pin_name_t n;
113  pin_name_t s;
116 
121 typedef enum
122 {
124  HALLSWITCH2_ERROR = -1
125 
127 
144 
160 
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 #endif // HALLSWITCH2_H
177  // hallswitch2
179 
180 // ------------------------------------------------------------------------ END
hallswitch2_cfg_t
Hall Switch 2 Click configuration object.
Definition: hallswitch2.h:111
hallswitch2_init
err_t hallswitch2_init(hallswitch2_t *ctx, hallswitch2_cfg_t *cfg)
Hall Switch 2 initialization function.
hallswitch2_t
Hall Switch 2 Click context object.
Definition: hallswitch2.h:100
hallswitch2_return_value_t
hallswitch2_return_value_t
Hall Switch 2 Click return value data.
Definition: hallswitch2.h:122
hallswitch2_check_state
uint8_t hallswitch2_check_state(hallswitch2_t *ctx)
Hall Switch 2 check state function.
hallswitch2_cfg_t::n
pin_name_t n
Definition: hallswitch2.h:112
hallswitch2_cfg_setup
void hallswitch2_cfg_setup(hallswitch2_cfg_t *cfg)
Hall Switch 2 configuration object setup function.
hallswitch2_cfg_t::s
pin_name_t s
Definition: hallswitch2.h:113
HALLSWITCH2_ERROR
@ HALLSWITCH2_ERROR
Definition: hallswitch2.h:124
hallswitch2_t::s
digital_in_t s
Definition: hallswitch2.h:102
HALLSWITCH2_OK
@ HALLSWITCH2_OK
Definition: hallswitch2.h:123
hallswitch2_t::n
digital_in_t n
Definition: hallswitch2.h:101