ir2.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 IR2_H
#define IR2_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"
#include "drv_pwm.h"
 
#define IR2_STATE_HIGH          0x01
#define IR2_STATE_LOW           0x00
 
#define IR2_DEF_FREQ            38000
#define IR2_DEF_DUTY_CYCLE      0.25
 
 // ir2_cfg
 
#define IR2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // ir2_map
 // ir2
 
typedef enum
{
    IR2_DRV_SEL_GPIO,        
    IR2_DRV_SEL_UART         
} ir2_drv_t;
typedef struct
{
    // Input pins
    digital_in_t out_pin;   
    // Modules
    pwm_t pwm;              
    // ctx variable
    uint32_t pwm_freq;      
    ir2_drv_t  drv_sel;     
} ir2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t pwm;         
    pin_name_t int_pin;     
    pin_name_t rx_pin;      
    pin_name_t tx_pin;      
    uint32_t dev_pwm_freq;  
    ir2_drv_t  drv_sel;     
} ir2_cfg_t;
 
typedef enum
{
    IR2_OK = 0,
    IR2_ERROR = -1
 
} ir2_return_value_t;
 
void ir2_cfg_setup ( ir2_cfg_t *cfg );
 
void ir2_drv_interface_selection ( ir2_cfg_t *cfg, ir2_drv_t drv_sel );
 
err_t ir2_init ( ir2_t *ctx, ir2_cfg_t *cfg );
 
uint8_t ir2_get_out_pin ( ir2_t *ctx );
 
void ir2_nec_send_data ( ir2_t *ctx, uint8_t address, uint8_t data_in );
 
err_t ir2_nec_read_data ( ir2_t *ctx, uint8_t *address, uint8_t *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // IR2_H
 
 // ir2
 
// ------------------------------------------------------------------------ END