ecg4.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright (c) 2019, MikroElektronika - www.mikroe.com
 * All rights reserved.
 *
 * 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 ECG4_H
#define ECG4_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"
#include "drv_uart.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define ECG4_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
#define ECG4_RETVAL  uint8_t
 
#define ECG4_OK           0x00
#define ECG4_INIT_ERROR   0xFF
#define ECG4_SYNC_BYTE                  0xAA
#define ECG4_EXCODE_BYTE                0x55
#define ECG4_SIGNAL_QUALITY_CODE_BYTE   0x02
#define ECG4_HEART_RATE_CODE_BYTE       0x03
#define ECG4_RAW_DATA_CODE_BYTE         0x80
#define ECG4_RESPONSE_READY             0x01
#define ECG4_RESPONSE_NOT_READY         0x00
#define ECG4_ENABLE_LDO_CTRL            0x01
#define ECG4_DISABLE_LDO_CTRL           0x00
 
#define DRV_RX_BUFFER_SIZE 1000
#define DRV_TX_BUFFER_SIZE 50
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
 
typedef void ( *ecg4_hdl_t )( uint8_t*, uint8_t*, uint8_t*, uint8_t* );
 
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t cs;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
 
    ecg4_hdl_t driver_hdl;
    uint8_t response_ready;
 
} ecg4_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t rx_pin;
    pin_name_t tx_pin;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t cs;
 
    // static variable 
 
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.  
    uart_stop_bits_t  stop_bit;      // Stop bits.    
 
} ecg4_cfg_t;
 
typedef uint8_t ecg4_error_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void ecg4_cfg_setup ( ecg4_cfg_t *cfg );
 
ECG4_RETVAL ecg4_init ( ecg4_t *ctx, ecg4_cfg_t *cfg );
 
void ecg4_module_reset ( ecg4_t *ctx );
 
void ecg4_generic_write ( ecg4_t *ctx, char *data_buf, uint16_t len );
 
int32_t ecg4_generic_read ( ecg4_t *ctx, char *data_buf, uint16_t max_len );
 
void ecg4_enable_ldo_ctrl ( ecg4_t *ctx, uint8_t state );
 
void ecg4_uart_isr( ecg4_t *ctx, uint8_t rx_dat );
 
uint8_t ecg4_responseReady( ecg4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _ECG4_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END