piezodriver.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 PIEZODRIVER_H
#define PIEZODRIVER_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_pwm.h"
 
#define PIEZODRIVER_DEF_FREQ                5000
 
#define PIEZODRIVER_NOTE_C2                 65
#define PIEZODRIVER_NOTE_DB2                69
#define PIEZODRIVER_NOTE_D2                 73
#define PIEZODRIVER_NOTE_EB2                78
#define PIEZODRIVER_NOTE_E2                 82
#define PIEZODRIVER_NOTE_F2                 87
#define PIEZODRIVER_NOTE_GB2                93
#define PIEZODRIVER_NOTE_G2                 98
#define PIEZODRIVER_NOTE_AB2                104
#define PIEZODRIVER_NOTE_A2                 110
#define PIEZODRIVER_NOTE_BB2                117
#define PIEZODRIVER_NOTE_B2                 123
#define PIEZODRIVER_NOTE_C3                 131
#define PIEZODRIVER_NOTE_DB3                139
#define PIEZODRIVER_NOTE_D3                 147
#define PIEZODRIVER_NOTE_EB3                156
#define PIEZODRIVER_NOTE_E3                 165
#define PIEZODRIVER_NOTE_F3                 175
#define PIEZODRIVER_NOTE_GB3                185
#define PIEZODRIVER_NOTE_G3                 196
#define PIEZODRIVER_NOTE_AB3                208
#define PIEZODRIVER_NOTE_A3                 220
#define PIEZODRIVER_NOTE_AS3                233
#define PIEZODRIVER_NOTE_B3                 247
#define PIEZODRIVER_NOTE_C4                 262
#define PIEZODRIVER_NOTE_DB4                277
#define PIEZODRIVER_NOTE_D4                 294
#define PIEZODRIVER_NOTE_EB4                311
#define PIEZODRIVER_NOTE_E4                 330
#define PIEZODRIVER_NOTE_F4                 349
#define PIEZODRIVER_NOTE_GB4                370
#define PIEZODRIVER_NOTE_G4                 392
#define PIEZODRIVER_NOTE_AB4                415
#define PIEZODRIVER_NOTE_A4                 440
#define PIEZODRIVER_NOTE_BB4                466
#define PIEZODRIVER_NOTE_B4                 494
#define PIEZODRIVER_NOTE_C5                 523
#define PIEZODRIVER_NOTE_DB5                554
#define PIEZODRIVER_NOTE_D5                 587
#define PIEZODRIVER_NOTE_EB5                622
#define PIEZODRIVER_NOTE_E5                 659
#define PIEZODRIVER_NOTE_F5                 698
#define PIEZODRIVER_NOTE_GB5                740
#define PIEZODRIVER_NOTE_G5                 784
#define PIEZODRIVER_NOTE_AB5                831
#define PIEZODRIVER_NOTE_A5                 880
#define PIEZODRIVER_NOTE_BB5                932
#define PIEZODRIVER_NOTE_B5                 988
#define PIEZODRIVER_NOTE_C6                 1047
#define PIEZODRIVER_NOTE_DB6                1109
#define PIEZODRIVER_NOTE_D6                 1175
#define PIEZODRIVER_NOTE_EB6                1245
#define PIEZODRIVER_NOTE_E6                 1319
#define PIEZODRIVER_NOTE_F6                 1397
#define PIEZODRIVER_NOTE_GB6                1480
#define PIEZODRIVER_NOTE_G6                 1568
#define PIEZODRIVER_NOTE_AB6                1661
#define PIEZODRIVER_NOTE_A6                 1760
#define PIEZODRIVER_NOTE_BB6                1865
#define PIEZODRIVER_NOTE_B6                 1976
#define PIEZODRIVER_NOTE_C7                 2093
#define PIEZODRIVER_NOTE_DB7                2217
#define PIEZODRIVER_NOTE_D7                 2349
#define PIEZODRIVER_NOTE_EB7                2489
#define PIEZODRIVER_NOTE_E7                 2637
#define PIEZODRIVER_NOTE_F7                 2794
#define PIEZODRIVER_NOTE_GB7                2960
#define PIEZODRIVER_NOTE_G7                 3136
#define PIEZODRIVER_NOTE_AB7                3322
#define PIEZODRIVER_NOTE_A7                 3520
#define PIEZODRIVER_NOTE_BB7                3729
#define PIEZODRIVER_NOTE_B7                 3951
#define PIEZODRIVER_NOTE_C8                 4186
#define PIEZODRIVER_NOTE_DB8                4435
#define PIEZODRIVER_NOTE_D8                 4699
#define PIEZODRIVER_NOTE_EB8                4978
 
 // piezodriver_cfg
 
#define PIEZODRIVER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); 
    
 // piezodriver_map
 // piezodriver
 
typedef struct
{
    // Modules
    pwm_t pwm;                 
    // ctx variable
    uint32_t pwm_freq;         
} piezodriver_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t pwm;            
    // Static variable
    uint32_t dev_pwm_freq;     
} piezodriver_cfg_t;
 
typedef enum
{
    PIEZODRIVER_OK = 0,
    PIEZODRIVER_ERROR = -1
 
} piezodriver_return_value_t;
 
void piezodriver_cfg_setup ( piezodriver_cfg_t *cfg );
 
err_t piezodriver_init ( piezodriver_t *ctx, piezodriver_cfg_t *cfg );
 
err_t piezodriver_default_cfg ( piezodriver_t *ctx );
 
err_t piezodriver_set_duty_cycle ( piezodriver_t *ctx, float duty_cycle );
 
err_t piezodriver_pwm_stop ( piezodriver_t *ctx );
 
err_t piezodriver_pwm_start ( piezodriver_t *ctx );
 
void piezodriver_play_sound ( piezodriver_t *ctx, uint16_t freq, uint8_t level, uint16_t duration );
 
#ifdef __cplusplus
}
#endif
#endif // PIEZODRIVER_H
 
 // piezodriver
 
// ------------------------------------------------------------------------ END