ooktx.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 OOKTX_H
#define OOKTX_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 OOKTX_TRAINING_BYTES      { 0xAA, 0xAA, 0xAA, 0xAA }
#define OOKTX_MAN_MSB               0x8000
#define OOKTX_MAN_BIT_LEN_US        2000
#define OOKTX_MAX_DATA_LEN          255
#define OOKTX_CALIB_ENABLE          0x01
#define OOKTX_CALIB_DISABLE         0x00
#define OOKTX_CFG_ENABLE            0x01
#define OOKTX_CFG_DISABLE           0x00
#define OOKTX_CFG_DEFAULT           0xF6F0
#define OOKTX_CFG_F_433MHZ          0xF000
#define OOKTX_CFG_CX_18PF           0x0600
#define OOKTX_CFG_P_13DB            0x00F0
#define OOKTX_CFG_P_10DB            0x00C0
#define OOKTX_CFG_P_7DB             0x0090
#define OOKTX_CFG_P_3DB             0x0050
#define OOKTX_CFG_P_0DB             0x0020
#define OOKTX_CFG_CT_0PF            0x0000
 
 // ooktx_cfg
 
#define OOKTX_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.sck = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // ooktx_map
 // ooktx
 
typedef struct
{
    digital_out_t sda;      
    digital_out_t sck;      
} ooktx_t;
 
typedef struct
{
    pin_name_t sda;         
    pin_name_t sck;         
} ooktx_cfg_t;
 
typedef enum
{
    OOKTX_OK = 0,
    OOKTX_ERROR = -1
 
} ooktx_return_value_t;
 
void ooktx_cfg_setup ( ooktx_cfg_t *cfg );
 
err_t ooktx_init ( ooktx_t *ctx, ooktx_cfg_t *cfg );
 
void ooktx_set_data_pin ( ooktx_t *ctx );
 
void ooktx_clear_data_pin ( ooktx_t *ctx );
 
void ooktx_set_clock_pin ( ooktx_t *ctx );
 
void ooktx_clear_clock_pin ( ooktx_t *ctx );
 
void ooktx_start ( ooktx_t *ctx, uint8_t calib_en, uint8_t cfg_en, uint16_t cfg );
 
void ooktx_stop ( ooktx_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // OOKTX_H
 
 // ooktx
 
// ------------------------------------------------------------------------ END