speedsense.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 SPEEDSENSE_H
#define SPEEDSENSE_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 SPEEDSENSE_CNV_MIN_TO_MS          60000.0f
 
#define SPEEDSENSE_DIR_STATE_FWD          0
#define SPEEDSENSE_DIR_STATE_RVS          1
#define SPEEDSENSE_SPEED_STATE_LOW        0
#define SPEEDSENSE_SPEED_STATE_HIGH       1
 
#define SPEEDSENSE_STOP_MEASURE           0
#define SPEEDSENSE_START_NEW_MEASURE      1
 
 // speedsense_set
 
#define SPEEDSENSE_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.chb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.cha = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // speedsense_map
 // speedsense
 
typedef struct
{
    digital_in_t chb;    
    digital_in_t cha;    
} speedsense_t;
 
typedef struct
{
    pin_name_t chb;    
    pin_name_t cha;    
} speedsense_cfg_t;
 
typedef enum
{
    SPEEDSENSE_OK = 0,
    SPEEDSENSE_ERROR = -1
 
} speedsense_return_value_t;
 
void speedsense_cfg_setup ( speedsense_cfg_t *cfg );
 
err_t speedsense_init ( speedsense_t *ctx, speedsense_cfg_t *cfg );
 
uint8_t speedsense_get_speed ( speedsense_t *ctx );
 
uint8_t speedsense_get_direction ( speedsense_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SPEEDSENSE_H
 
 // speedsense
 
// ------------------------------------------------------------------------ END