ir.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 IR_H
#define IR_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_uart.h"
#include "drv_pwm.h"
 
#define IR_STATE_HIGH           0x01
#define IR_STATE_LOW            0x00
 
#define DRV_BUFFER_SIZE         200
 
#define IR_DEF_FREQ             38000
 
 // ir_cmd
 
#define IR_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.an     = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.pwm    = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // ir_map
 // ir
 
typedef enum
{
   IR_DRV_SEL_GPIO,      
   IR_DRV_SEL_UART       
} ir_drv_t;
 
typedef struct
{
 
    // Input pins
    digital_in_t an;         
    // Modules
    uart_t uart;             
    pwm_t pwm;               
    // ctx variable
    uint32_t pwm_freq;       
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];         
    ir_drv_t  drv_sel;     
} ir_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;          
    pin_name_t tx_pin;          
    // Additional gpio pins
    pin_name_t an;              
    pin_name_t pwm;             
    // Static variable
    uint32_t          baud_rate;        
    bool              uart_blocking;    
    uart_data_bits_t  data_bit;         
    uart_parity_t     parity_bit;       
    uart_stop_bits_t  stop_bit;         
    uint32_t dev_pwm_freq;              
    ir_drv_t  drv_sel;                  
} ir_cfg_t;
 
typedef enum
{
    IR_OK = 0,
    IR_ERROR = -1
 
} ir_return_value_t;
 
void ir_cfg_setup ( ir_cfg_t *cfg );
 
void ir_drv_interface_selection ( ir_cfg_t *cfg, ir_drv_t drv_sel );
 
err_t ir_init ( ir_t *ctx, ir_cfg_t *cfg );
 
err_t ir_generic_write ( ir_t *ctx, char *data_buf, uint16_t len );
 
err_t ir_generic_read ( ir_t *ctx, char *data_buf, uint16_t max_len );
 
uint8_t ir_get_an_state ( ir_t *ctx );
 
void ir_nec_send_command ( ir_t *ctx, uint8_t address, uint8_t command );
 
err_t ir_nec_read_command ( ir_t *ctx, uint8_t *address, uint8_t *command );
 
#ifdef __cplusplus
}
#endif
#endif // IR_H
 
 // ir
 
// ------------------------------------------------------------------------ END