hallswitch2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef HALLSWITCH2_H
#define HALLSWITCH2_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
 
#define HALLSWITCH2_NO_MAGNET_DETECTED       0
#define HALLSWITCH2_S_POLE_DETECTED          1
#define HALLSWITCH2_N_POLE_DETECTED          2
 
 // hallswitch2_set
 
#define HALLSWITCH2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.n = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.s = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hallswitch2_map
 // hallswitch2
 
typedef struct
{
    digital_in_t  n;        
    digital_in_t  s;        
} hallswitch2_t;
 
typedef struct
{
    pin_name_t  n;          
    pin_name_t  s;          
} hallswitch2_cfg_t;
 
typedef enum
{
    HALLSWITCH2_OK = 0,
    HALLSWITCH2_ERROR = -1
 
} hallswitch2_return_value_t;
 
void hallswitch2_cfg_setup ( hallswitch2_cfg_t *cfg );
 
err_t hallswitch2_init ( hallswitch2_t *ctx, hallswitch2_cfg_t *cfg );
 
uint8_t hallswitch2_check_state ( hallswitch2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HALLSWITCH2_H
 
 // hallswitch2
 
// ------------------------------------------------------------------------ END