motion3.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 MOTION3_H
#define MOTION3_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 MOTION3_MODULE_ENABLE     0x00
#define MOTION3_MODULE_DISABLE    0x01
#define MOTION3_NO_DETECT_OBJECT  0x00
#define MOTION3_DETECT_OBJECT     0x01
 
 // motion3_set
 
#define MOTION3_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // motion3_map
 // motion3
 
typedef struct
{
      // Output pins 
    
    digital_out_t en;
    
      // Input pins 
    
    digital_in_t int_pin;
 
} motion3_t;
 
typedef struct
{
      // Additional gpio pins 
    
    pin_name_t  en;    
    pin_name_t  int_pin;    
} motion3_cfg_t;
 
typedef enum
{
   MOTION3_OK = 0,
   MOTION3_ERROR = -1
 
} motion3_return_value_t;
 
typedef enum
{
    MOTION3_NO_DETECT = 0,
    MOTION3_DETECTED
 
} motion3_detect_state_t;
 
typedef enum
{
    MOTION3_PIN_STATE_LOW = 0,
    MOTION3_PIN_STATE_HIGH
 
} motion3_pin_state_t;
 
void motion3_cfg_setup ( motion3_cfg_t *cfg );
 
err_t motion3_init ( motion3_t *ctx, motion3_cfg_t *cfg );
 
void motion3_enable ( motion3_t *ctx, uint8_t state );
 
uint8_t motion3_detect_state ( motion3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // MOTION3_H
 
 // motion3
 
// ------------------------------------------------------------------------ END