optoencoder2.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 OPTOENCODER2_H
#define OPTOENCODER2_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define OPTOENCODER2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.b_pin = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.a_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
#define OPTOENCODER2_OK             0
#define OPTOENCODER2_ERROR         -1
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
    digital_in_t b_pin;
    digital_in_t a_pin;
 
    uint32_t timeout_counter;
    int32_t position_counter;
 
} optoencoder2_t;
 
typedef struct
{
    // Additional gpio pins 
    pin_name_t b_pin;
    pin_name_t a_pin;
 
} optoencoder2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void optoencoder2_cfg_setup ( optoencoder2_cfg_t *cfg );
 
err_t optoencoder2_init ( optoencoder2_t *ctx, optoencoder2_cfg_t *cfg );
 
uint8_t optoencoder2_pwm_get ( optoencoder2_t *ctx );
 
uint8_t optoencoder2_int_get ( optoencoder2_t *ctx );
 
int32_t optoencoder2_get_position ( optoencoder2_t *ctx );
 
void optoencoder2_zero_counter ( optoencoder2_t *ctx );
 
uint8_t optoencoder2_isr ( optoencoder2_t *ctx, uint8_t n_cycles );
 
#ifdef __cplusplus
}
#endif
#endif  // _OPTOENCODER2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END