thunderemu.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 THUNDEREMU_H
#define THUNDEREMU_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_i2c_master.h"
 
#define THUNDEREMU_MODE_CLOSE                   0
#define THUNDEREMU_MODE_MID                     1
#define THUNDEREMU_MODE_FAR                     2
 
#define THUNDEREMU_DAC_MODE_FAST_NORMAL         0x00
#define THUNDEREMU_DAC_MODE_FAST_PDOWN_1K       0x10
#define THUNDEREMU_DAC_MODE_FAST_PDOWN_100K     0x20
#define THUNDEREMU_DAC_MODE_FAST_PDOWN_500K     0x30
#define THUNDEREMU_DAC_MODE_EEPROM_NORMAL       0x60
#define THUNDEREMU_DAC_MODE_EEPROM_PDOWN_1K     0x62
#define THUNDEREMU_DAC_MODE_EEPROM_PDOWN_100K   0x64
#define THUNDEREMU_DAC_MODE_EEPROM_PDOWN_500K   0x66
 
#define THUNDEREMU_DAC_OUT_MIN                  0x0000
#define THUNDEREMU_DAC_OUT_MAX                  0x0FFF
 
#define THUNDEREMU_DEVICE_ADDRESS_0             0x60
#define THUNDEREMU_DEVICE_ADDRESS_1             0x61
 
 // thunderemu_set
 
#define THUNDEREMU_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.close = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.led = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.mid = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.far_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // thunderemu_map
 // thunderemu
 
typedef struct
{
    // Output pins
    digital_out_t led;          
    // Input pins
    digital_in_t close;         
    digital_in_t mid;           
    digital_in_t far_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} thunderemu_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t led;             
    pin_name_t close;           
    pin_name_t mid;             
    pin_name_t far_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} thunderemu_cfg_t;
 
typedef enum
{
    THUNDEREMU_OK = 0,
    THUNDEREMU_ERROR = -1
 
} thunderemu_return_value_t;
 
void thunderemu_cfg_setup ( thunderemu_cfg_t *cfg );
 
err_t thunderemu_init ( thunderemu_t *ctx, thunderemu_cfg_t *cfg );
 
err_t thunderemu_default_cfg ( thunderemu_t *ctx );
 
err_t thunderemu_set_dac_output ( thunderemu_t *ctx, uint8_t mode, uint16_t dac_data );
 
err_t thunderemu_generate_thunder ( thunderemu_t *ctx, uint8_t mode );
 
void thunderemu_led_enable ( thunderemu_t *ctx );
 
void thunderemu_led_disable ( thunderemu_t *ctx );
 
uint8_t thunderemu_get_close_pin ( thunderemu_t *ctx );
 
uint8_t thunderemu_get_mid_pin ( thunderemu_t *ctx );
 
uint8_t thunderemu_get_far_pin ( thunderemu_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // THUNDEREMU_H
 
 // thunderemu
 
// ------------------------------------------------------------------------ END