hztov.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 HZTOV_H
#define HZTOV_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_pwm.h"
#include "drv_analog_in.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define HZTOV_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.vo = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
#define HZTOV_RETVAL  uint8_t
 
#define HZTOV_OK           0x00
#define HZTOV_INIT_ERROR   0xFF
#define HZTOV_DEF_FREQ     5000
#define HZTOV_ENABLE        1
#define HZTOV_DISABLE       0
 
#define HZTOV_MAX_FREQ      10000
#define HZTOV_MIN_FREQ      1000
 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef uint16_t hztov_data_t;
 
typedef struct
{
    // Output pins 
 
    digital_out_t en;
    
    // Modules 
 
    pwm_t pwm;
    analog_in_t adc;
 
    // ctx variable 
    
    uint32_t pwm_freq;
    
} hztov_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t pwm;
    pin_name_t vo;
    
    // Additional gpio pins 
 
    pin_name_t en;
 
    // static variable 
 
    analog_in_resolution_t  resolution;   // Resolution
    float vref;                           // VRef 
    uint32_t dev_pwm_freq;
} hztov_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void hztov_cfg_setup ( hztov_cfg_t *cfg );
 
HZTOV_RETVAL hztov_init ( hztov_t *ctx, hztov_cfg_t *cfg );
 
hztov_data_t hztov_generic_read ( hztov_t *ctx );
 
float hztov_read_voltage ( hztov_t *ctx );
 
void hztov_set_enable ( hztov_t *ctx, uint8_t state );
 
void hztov_set_duty_cycle ( hztov_t *ctx, float duty_cycle );
 
void hztov_pwm_stop ( hztov_t *ctx );
 
void hztov_pwm_start ( hztov_t *ctx );
 
void hztov_set_input_frequency ( hztov_t *ctx, uint16_t freq );
 
#ifdef __cplusplus
}
#endif
#endif  // _HZTOV_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END