lighthz.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 LIGHTHZ_H
#define LIGHTHZ_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 LIGHTHZ_PIN_STATE_LOW                   0
#define LIGHTHZ_PIN_STATE_HIGH                  1
 
#define LIGHTHZ_SENS_POWER_DOWN                 0
#define LIGHTHZ_SENS_1X                         1
#define LIGHTHZ_SENS_10X                        2
#define LIGHTHZ_SENS_100X                       3
 
#define LIGHTHZ_FSCALE_1                        0
#define LIGHTHZ_FSCALE_2                        1
#define LIGHTHZ_FSCALE_10                       2
#define LIGHTHZ_FSCALE_100                      3
 
#define LIGHTHZ_DELAY_US                        10
#define LIGHTHZ_MAX_COUNTS_PER_S                100000ul
#define LIGHTHZ_SAMPLE_COUNTS                   100
 
 // lighthz_set
 
#define LIGHTHZ_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.s3 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.s2 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.s0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.freq = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // lighthz_map
 // lighthz
 
typedef struct
{
    digital_out_t s1;           
    digital_out_t s3;           
    digital_out_t s2;           
    digital_out_t s0;           
    digital_in_t freq;          
} lighthz_t;
 
typedef struct
{
    pin_name_t s1;              
    pin_name_t s3;              
    pin_name_t s2;              
    pin_name_t s0;              
    pin_name_t freq;            
} lighthz_cfg_t;
 
typedef enum
{
    LIGHTHZ_OK = 0,
    LIGHTHZ_ERROR = -1
 
} lighthz_return_value_t;
 
void lighthz_cfg_setup ( lighthz_cfg_t *cfg );
 
err_t lighthz_init ( lighthz_t *ctx, lighthz_cfg_t *cfg );
 
void lighthz_set_s0_pin ( lighthz_t *ctx, uint8_t state );
 
void lighthz_set_s1_pin ( lighthz_t *ctx, uint8_t state );
 
void lighthz_set_s2_pin ( lighthz_t *ctx, uint8_t state );
 
void lighthz_set_s3_pin ( lighthz_t *ctx, uint8_t state );
 
void lighthz_set_sensitivity ( lighthz_t *ctx, uint8_t mode );
 
void lighthz_set_frequency_scaling ( lighthz_t *ctx, uint8_t mode );
 
uint8_t lighthz_get_freq_pin ( lighthz_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // LIGHTHZ_H
 
 // lighthz
 
// ------------------------------------------------------------------------ END