zerocross  2.1.0.0
zerocross.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 ZEROCROSS_H
29 #define ZEROCROSS_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
72 #define ZEROCROSS_PIN_STATE_LOW 0x00
73 #define ZEROCROSS_PIN_STATE_HIGH 0x01
74  // zerocross_set
76 
91 #define ZEROCROSS_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.zc = MIKROBUS( mikrobus, MIKROBUS_INT )
93  // zerocross_map // zerocross
96 
101 typedef struct
102 {
103  digital_in_t zc;
105 } zerocross_t;
106 
111 typedef struct
112 {
113  pin_name_t zc;
116 
121 typedef enum
122 {
124  ZEROCROSS_ERROR = -1
125 
127 
144 
159 
171 
183 void zerocross_get_freq ( zerocross_t *ctx, float *freq );
184 
185 #ifdef __cplusplus
186 }
187 #endif
188 #endif // ZEROCROSS_H
189  // zerocross
191 
192 // ------------------------------------------------------------------------ END
zerocross_cfg_setup
void zerocross_cfg_setup(zerocross_cfg_t *cfg)
Zero-Cross configuration object setup function.
zerocross_return_value_t
zerocross_return_value_t
Zero-Cross Click return value data.
Definition: zerocross.h:122
ZEROCROSS_OK
@ ZEROCROSS_OK
Definition: zerocross.h:123
zerocross_cfg_t::zc
pin_name_t zc
Definition: zerocross.h:113
zerocross_pin_read
uint8_t zerocross_pin_read(zerocross_t *ctx)
Zero-Cross pin reading function.
zerocross_get_freq
void zerocross_get_freq(zerocross_t *ctx, float *freq)
Zero-Cross frequency reading function.
zerocross_cfg_t
Zero-Cross Click configuration object.
Definition: zerocross.h:112
zerocross_t
Zero-Cross Click context object.
Definition: zerocross.h:102
ZEROCROSS_ERROR
@ ZEROCROSS_ERROR
Definition: zerocross.h:124
zerocross_init
err_t zerocross_init(zerocross_t *ctx, zerocross_cfg_t *cfg)
Zero-Cross initialization function.
zerocross_t::zc
digital_in_t zc
Definition: zerocross.h:103