uv.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 UV_H
#define UV_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_analog_in.h"
#include "drv_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS
#define UV_MAP_MIKROBUS( cfg, mikrobus )            \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS );   \
   cfg.an    = MIKROBUS( mikrobus, MIKROBUS_AN );   \
   cfg.en    = MIKROBUS( mikrobus, MIKROBUS_RST )
 // End group macro
// --------------------------------------------------------------- PUBLIC TYPES
typedef void ( *uv_callback_t )( uint8_t* );
 
typedef struct
{
    // Digital Output pins.
    digital_out_t en;
 
    // Analog Input pins.
    analog_in_t an;
 
    // Comm Modules.
    spi_master_t spi;
    pin_name_t chip_select;
 
    // Callback handler.
    uv_callback_t handler;
 
} uv_t;
 
typedef struct
{
    // Communication gpio pins.
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins.
    pin_name_t an;
    pin_name_t en;
 
    // Static variables.
    uint32_t spi_speed;                 
    spi_master_mode_t spi_mode;         
    spi_master_chip_select_polarity_t cs_polarity; 
    analog_in_resolution_t resolution;  
    float vref_value;                   
} uv_cfg_t;
 
 // End group type
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void uv_cfg_setup ( uv_cfg_t *cfg );
 
err_t uv_init ( uv_t *ctx, uv_cfg_t *cfg );
 
void uv_set_callback_handler ( uv_t *ctx, uv_callback_t handler );
 
err_t uv_read_adc_value ( uv_t *ctx, uint16_t *data_out );
 
err_t uv_read_adc_voltage ( uv_t *ctx, float *data_out );
 
err_t uv_read_an_pin_value ( uv_t *ctx, uint16_t *data_out );
 
err_t uv_read_an_pin_voltage ( uv_t *ctx, float *data_out );
 
void uv_calc_index ( uv_t *ctx, float data_in, uint8_t *data_out );
 
void uv_device_enable ( uv_t *ctx );
 
void uv_device_disable ( uv_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // UV_H
 
 // End public_function group
 
// ------------------------------------------------------------------------- END