c1wireswitch.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 C1WIRESWITCH_H
#define C1WIRESWITCH_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 C1WIRESWITCH_CMD_WRITE_SCRATCHPAD      0x5A
#define C1WIRESWITCH_CMD_READ_SCRATCHPAD       0xF5
 
#define C1WIRESWITCH_CMD_WRITE_PIO             0x5A
#define C1WIRESWITCH_CMD_READ_PIO              0xF5
 
#define C1WIRESWITCH_PIOB_STATE_MASK           0x04
#define C1WIRESWITCH_PIOA_STATE_MASK           0x01
#define C1WIRESWITCH_PIOB_LATCH_STATE_MASK     0x08
#define C1WIRESWITCH_PIOA_LATCH_STATE_MASK     0x02
 
#define C1WIRESWITCH_PIOA_HIGH                 0x01
#define C1WIRESWITCH_PIOA_LOW                  0x00
#define C1WIRESWITCH_PIOB_HIGH                 0x04
#define C1WIRESWITCH_PIOB_LOW                  0x00
 
#define C1WIRESWITCH_PIOB_ON                   0x02
#define C1WIRESWITCH_PIOB_OFF                  0x00
#define C1WIRESWITCH_PIOA_ON                   0x00
#define C1WIRESWITCH_PIOA_OFF                  0x01
 
#define C1WIRESWITCH_PIOB_LATCH_LOW            0x00
#define C1WIRESWITCH_PIOB_LATCH_HIGH           0x08
#define C1WIRESWITCH_PIOA_LATCH_LOW            0x00
#define C1WIRESWITCH_PIOA_LATCH_HIGH           0x02
 
 // c1wireswitch_cmd
 
#define C1WIRESWITCH_FAMILY_CODE               0x3A
 
#define C1WIRESWITCH_ADDRESS                   0x33
#define C1WIRESWITCH_ADDRESS_ALL               0xFF
 
 // c1wireswitch_set
 
#define C1WIRESWITCH_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_AN ); 
 
 // c1wireswitch_map
 // c1wireswitch
 
typedef enum
{
    C1WIRESWITCH_GPIO_0,      
    C1WIRESWITCH_GPIO_1       
} c1wireswitch_gpio_sel_t;
 
typedef struct
{
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t address;                    
} c1wireswitch_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;                     
    pin_name_t gp1;                     
    c1wireswitch_gpio_sel_t gpio_sel;      
} c1wireswitch_cfg_t;
 
typedef enum
{
    C1WIRESWITCH_OK = 0,
    C1WIRESWITCH_ERROR = -1
 
} c1wireswitch_return_value_t;
 
void c1wireswitch_cfg_setup ( c1wireswitch_cfg_t *cfg );
 
void c1wireswitch_gpio_selection ( c1wireswitch_cfg_t *cfg, c1wireswitch_gpio_sel_t gpio_sel );
 
err_t c1wireswitch_init ( c1wireswitch_t *ctx, c1wireswitch_cfg_t *cfg );
 
err_t c1wireswitch_default_cfg ( c1wireswitch_t *ctx );
 
err_t c1wireswitch_check_communication ( c1wireswitch_t *ctx );
 
err_t c1wireswitch_select_device ( c1wireswitch_t *ctx );
 
err_t c1wireswitch_read_scratchpad ( c1wireswitch_t *ctx, uint8_t *scratchpad, uint8_t scratchpad_len );
 
err_t c1wireswitch_write_scratchpad ( c1wireswitch_t *ctx, uint8_t *scratchpad, uint8_t scratchpad_len );
 
err_t c1wireswitch_write_pio ( c1wireswitch_t *ctx, uint8_t state );
 
err_t c1wireswitch_read_pio ( c1wireswitch_t *ctx, uint8_t *state );
 
err_t c1wireswitch_set_pio_state ( c1wireswitch_t *ctx, uint8_t pio_a, uint8_t pio_b );
 
err_t c1wireswitch_get_pio_state ( c1wireswitch_t *ctx, uint8_t *pio_a, uint8_t *pio_b );
 
err_t c1wireswitch_get_pio_latch_state ( c1wireswitch_t *ctx, uint8_t *pio_a_latch, uint8_t *pio_b_latch );
 
#ifdef __cplusplus
}
#endif
#endif // C1WIRESWITCH_H
 
 // c1wireswitch
 
// ------------------------------------------------------------------------ END