ismrx2.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 ISMRX2_H
#define ISMRX2_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 ISMRX2_PIN_STATE_HIGH                   1
#define ISMRX2_PIN_STATE_LOW                    0
#define ISMRX2_DEFAULT_SYNC_BYTE                0xCE35
#define ISMRX2_FSK_DEFAULT_SYNC_BYTE            0xFF
 
 
 // ismrx2_set
 
#define ISMRX2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.stb = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.mst = MIKROBUS( mikrobus, MIKROBUS_INT ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX )
 
 // ismrx2_map
 // ismrx2
 
typedef struct
{
    digital_out_t rst;      
    digital_out_t stb;      
    digital_in_t rx_pin;    
    digital_in_t mst;       
} ismrx2_t;
 
typedef struct
{
    pin_name_t rst;     
    pin_name_t stb;     
    pin_name_t rx_pin;  
    pin_name_t mst;     
} ismrx2_cfg_t;
 
typedef enum
{
    ISMRX2_OK = 0,
    ISMRX2_ERROR = -1
 
} ismrx2_return_value_t;
 
void ismrx2_cfg_setup ( ismrx2_cfg_t *cfg );
 
err_t ismrx2_init ( ismrx2_t *ctx, ismrx2_cfg_t *cfg );
 
err_t ismrx2_default_cfg ( ismrx2_t *ctx );
 
void ismrx2_set_rst_pin_state ( ismrx2_t *ctx, uint8_t state );
 
void ismrx2_set_stb_pin_state ( ismrx2_t *ctx, uint8_t state );
 
uint8_t ismrx2_get_mst_pin_state ( ismrx2_t *ctx );
 
uint8_t ismrx2_get_data_pin_state ( ismrx2_t *ctx );
 
err_t ismrx2_read_manchester_data ( ismrx2_t *ctx, uint8_t *data_out );
 
err_t ismrx2_read_rf_data ( ismrx2_t *ctx, uint8_t *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // ISMRX2_H
 
 // ismrx2
 
// ------------------------------------------------------------------------ END