tamper2 2.0.0.0
tamper2.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 TAMPER2_H
36#define TAMPER2_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define TAMPER2_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.ncl= MIKROBUS( mikrobus, MIKROBUS_AN ); \
53 cfg.nop= MIKROBUS( mikrobus, MIKROBUS_INT );
60#define TAMPER2_RETVAL uint8_t
61
62#define TAMPER2_OK 0x00
63#define TAMPER2_INIT_ERROR 0xFF // End group macro
67// --------------------------------------------------------------- PUBLIC TYPES
76typedef struct
77{
78 // Input pins
79
80 digital_in_t ncl;
81 digital_in_t nop;
82
83} tamper2_t;
84
88typedef struct
89{
90 // Additional gpio pins
91
92 pin_name_t ncl;
93 pin_name_t nop;
94
96 // End types group
98// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
99
105#ifdef __cplusplus
106extern "C"{
107#endif
108
118
127
135
143
144#ifdef __cplusplus
145}
146#endif
147#endif // _TAMPER2_H_
148 // End public_function group
151
152// ------------------------------------------------------------------------- END
#define TAMPER2_RETVAL
Definition: tamper2.h:60
uint8_t tamper2_get_off_state(tamper2_t *ctx)
Switch OFF detect.
uint8_t tamper2_get_on_state(tamper2_t *ctx)
Switch ON detect.
TAMPER2_RETVAL tamper2_init(tamper2_t *ctx, tamper2_cfg_t *cfg)
Initialization function.
void tamper2_cfg_setup(tamper2_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition: tamper2.h:89
pin_name_t nop
Definition: tamper2.h:93
pin_name_t ncl
Definition: tamper2.h:92
Click ctx object definition.
Definition: tamper2.h:77
digital_in_t nop
Definition: tamper2.h:81
digital_in_t ncl
Definition: tamper2.h:80