vibromotor.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 VIBROMOTOR_H
#define VIBROMOTOR_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 VIBROMOTOR_DEF_FREQ     5000
 
 // vibromotor_cfg
 
#define VIBROMOTOR_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // vibromotor_map
 // vibromotor
 
typedef struct
{
    // Modules
    pwm_t pwm;                                      
    // ctx variable
    uint32_t pwm_freq;                              
} vibromotor_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t pwm;                                 
    // Static variable
    uint32_t dev_pwm_freq;                          
} vibromotor_cfg_t;
 
typedef enum
{
   VIBROMOTOR_OK = 0,
   VIBROMOTOR_ERROR = -1
 
} vibromotor_return_value_t;
 
void vibromotor_cfg_setup ( vibromotor_cfg_t *cfg );
 
err_t vibromotor_init ( vibromotor_t *ctx, vibromotor_cfg_t *cfg );
 
err_t vibromotor_set_duty_cycle ( vibromotor_t *ctx, float duty_cycle );
 
err_t vibromotor_pwm_stop ( vibromotor_t *ctx );
 
err_t vibromotor_pwm_start ( vibromotor_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // VIBROMOTOR_H
 
 // vibromotor
 
// ------------------------------------------------------------------------ END