ibutton.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 IBUTTON_H
#define IBUTTON_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_one_wire.h"
 
#define IBUTTON_CMD_WRITE_SCRATCHPAD      0x4E
#define IBUTTON_CMD_READ_SCRATCHPAD       0xBE
 
 // ibutton_cmd
 
#define IBUTTON_FAMILY_CODE             0x01
 
#define IBUTTON_MAX_KEY_NUMBER          5
 
 // ibutton_set
 
#define IBUTTON_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.st1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.st2 = MIKROBUS( mikrobus, MIKROBUS_CS );
 
 // ibutton_map
 // ibutton
 
typedef enum
{
    IBUTTON_GPIO_0,                 
    IBUTTON_GPIO_1                  
} ibutton_gpio_sel_t;
 
typedef struct
{
    // Output pins
    digital_out_t st2;              
    digital_out_t st1;              
    // Modules
    one_wire_t ow;                  
    one_wire_rom_address_t key_rom[ IBUTTON_MAX_KEY_NUMBER ];   
    uint8_t num_keys;               
} ibutton_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;                 
    pin_name_t gp1;                 
    // Additional gpio pins
    pin_name_t st2;                 
    pin_name_t st1;                 
    ibutton_gpio_sel_t gpio_sel;    
} ibutton_cfg_t;
 
typedef enum
{
    IBUTTON_OK = 0,
    IBUTTON_ERROR = -1,
    IBUTTON_KEY_ALREADY_EXIST = -2,
    IBUTTON_KEY_NO_MATCH = -3
 
} ibutton_return_value_t;
 
typedef enum
{
    IBUTTON_LED_DISABLE,
    IBUTTON_LED_WAIT_KEY,
    IBUTTON_LED_SUCCESS,
    IBUTTON_LED_WRONG_KEY
 
} ibutton_led_state_t;
 
void ibutton_cfg_setup ( ibutton_cfg_t *cfg );
 
void ibutton_gpio_selection ( ibutton_cfg_t *cfg, ibutton_gpio_sel_t gpio_sel );
 
err_t ibutton_init ( ibutton_t *ctx, ibutton_cfg_t *cfg );
 
err_t ibutton_add_key ( ibutton_t *ctx );
 
void ibutton_remove_keys ( ibutton_t *ctx );
 
err_t ibutton_check_key ( ibutton_t *ctx );
 
void ibutton_enable_red_led ( ibutton_t *ctx );
 
void ibutton_disable_red_led ( ibutton_t *ctx );
 
void ibutton_enable_green_led ( ibutton_t *ctx );
 
void ibutton_disable_green_led ( ibutton_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // IBUTTON_H
 
 // ibutton
 
// ------------------------------------------------------------------------ END