irbeacon 2.0.0.0
irbeacon.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 IRBEACON_H
36#define IRBEACON_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_pwm.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define IRBEACON_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
54 cfg.mod = MIKROBUS( mikrobus, MIKROBUS_AN );
61#define IRBEACON_RETVAL uint8_t
62
63#define IRBEACON_OK 0x00
64#define IRBEACON_INIT_ERROR 0xFF
71#define IRBEACON_DEF_FREQ 5000 // End group macro
75// --------------------------------------------------------------- PUBLIC TYPES
84typedef struct
85{
86
87 // Output pins
88
89 digital_out_t mod;
90
91 // Modules
92
93 pwm_t pwm;
94
95 // ctx variable
96
97 uint16_t pwm_period;
98 uint32_t pwm_freq;
99
100} irbeacon_t;
101
105typedef struct
106{
107 // Communication gpio pins
108
109 pin_name_t pwm;
110
111 // Additional gpio pins
112
113 pin_name_t mod;
114
115
116 // static variable
117
118 uint32_t dev_pwm_freq;
119
121 // End types group
123// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
124
130#ifdef __cplusplus
131extern "C"{
132#endif
133
143
152
162void irbeacon_set_duty_cycle ( irbeacon_t *ctx, float duty_cycle );
163
172
181
190
199
209
210#ifdef __cplusplus
211}
212#endif
213#endif // _IRBEACON_H_
214 // End public_function group
217
218// ------------------------------------------------------------------------- END
#define IRBEACON_RETVAL
Definition: irbeacon.h:61
void irbeacon_pwm_stop(irbeacon_t *ctx)
Stop PWM module.
void irbeacon_cfg_setup(irbeacon_cfg_t *cfg)
Config Object Initialization function.
IRBEACON_RETVAL irbeacon_init(irbeacon_t *ctx, irbeacon_cfg_t *cfg)
Initialization function.
void irbeacon_reset_mod(irbeacon_t *ctx)
Reset MOD function.
void irbeacon_enable_mod(irbeacon_t *ctx)
Enable MOD function.
void irbeacon_set_duty_cycle(irbeacon_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
void irbeacon_disable_mod(irbeacon_t *ctx)
Disable MOD function.
void irbeacon_pwm_start(irbeacon_t *ctx)
Start PWM module.
Click configuration structure definition.
Definition: irbeacon.h:106
pin_name_t mod
Definition: irbeacon.h:113
uint32_t dev_pwm_freq
Definition: irbeacon.h:118
pin_name_t pwm
Definition: irbeacon.h:109
Click ctx object definition.
Definition: irbeacon.h:85
digital_out_t mod
Definition: irbeacon.h:89
uint32_t pwm_freq
Definition: irbeacon.h:98
pwm_t pwm
Definition: irbeacon.h:93
uint16_t pwm_period
Definition: irbeacon.h:97