templog7.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 TEMPLOG7_H
#define TEMPLOG7_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 TEMPLOG7_CMD_CONVERT_TEMP               0x44
#define TEMPLOG7_CMD_ALERT_SEARCH               0xEC
#define TEMPLOG7_CMD_WRITE_SCRATCHPAD_1         0x4E
#define TEMPLOG7_CMD_READ_SCRATCHPAD_1          0xBE
#define TEMPLOG7_CMD_COPY_SCRATCHPAD_1          0x48
#define TEMPLOG7_CMD_WRITE_SCRATCHPAD_2         0x0F
#define TEMPLOG7_CMD_READ_SCRATCHPAD_2          0xAA
#define TEMPLOG7_CMD_COPY_SCRATCHPAD_2          0x55
#define TEMPLOG7_CMD_READ_EEPROM                0xF0
#define TEMPLOG7_CMD_GPIO_WRITE                 0xA5
#define TEMPLOG7_CMD_GPIO_READ                  0xF5
 
 // templog7_cmd
 
#define TEMPLOG7_TEMP_RES_16BIT                 0.0078125f
#define TEMPLOG7_TEMP_RES_12BIT                 0.0625f
 
#define TEMPLOG7_STATUS_ALERT_HIGH              0x80
#define TEMPLOG7_STATUS_ALERT_LOW               0x40
#define TEMPLOG7_STATUS_RESERVED                0x30
#define TEMPLOG7_STATUS_DATA_VALID              0x08
#define TEMPLOG7_STATUS_POWER_MODE              0x04
#define TEMPLOG7_STATUS_ARB_DONE                0x02
#define TEMPLOG7_STATUS_LOCK_STATUS             0x01
 
#define TEMPLOG7_CFG1_TEMP_FMT_12_BIT           0x00
#define TEMPLOG7_CFG1_TEMP_FMT_16_BIT           0x80
#define TEMPLOG7_CFG1_TEMP_FMT_MASK             0x80
#define TEMPLOG7_CFG1_RESERVED                  0x40
#define TEMPLOG7_CFG1_CONV_TIME_SEL_3MS         0x00
#define TEMPLOG7_CFG1_CONV_TIME_SEL_5p5MS       0x20
#define TEMPLOG7_CFG1_CONV_TIME_SEL_MASK        0x20
#define TEMPLOG7_CFG1_ALERT_MODE_ALERT          0x00
#define TEMPLOG7_CFG1_ALERT_MODE_COMPARATOR     0x10
#define TEMPLOG7_CFG1_ALERT_MODE_MASK           0x10
#define TEMPLOG7_CFG1_AVG_SEL_NO_AVG            0x00
#define TEMPLOG7_CFG1_AVG_SEL_8_B2B_CONV        0x08
#define TEMPLOG7_CFG1_AVG_SEL_MASK              0x08
#define TEMPLOG7_CFG1_CONV_MODE_SEL_ONE_SHOT    0x00
#define TEMPLOG7_CFG1_CONV_MODE_SEL_STACKED     0x01
#define TEMPLOG7_CFG1_CONV_MODE_SEL_AUTO        0x02
#define TEMPLOG7_CFG1_CONV_MODE_SEL_MASK        0x07
 
#define TEMPLOG7_CFG2_OD_DIS                    0x00
#define TEMPLOG7_CFG2_OD_EN                     0x80
#define TEMPLOG7_CFG2_OD_MASK                   0x80
#define TEMPLOG7_CFG2_FLEX_ADDR_MODE_HOST       0x00
#define TEMPLOG7_CFG2_FLEX_ADDR_MODE_IO         0x20
#define TEMPLOG7_CFG2_FLEX_ADDR_MODE_RES        0x40
#define TEMPLOG7_CFG2_FLEX_ADDR_MODE_IO_RES     0x60
#define TEMPLOG7_CFG2_FLEX_ADDR_MODE_MASK       0x60
#define TEMPLOG7_CFG2_ARB_MODE_DIS              0x00
#define TEMPLOG7_CFG2_ARB_MODE_SOFT_EN          0x10
#define TEMPLOG7_CFG2_ARB_MODE_FAST_EN          0x18
#define TEMPLOG7_CFG2_ARB_MODE_MASK             0x18
#define TEMPLOG7_CFG2_HYSTERESIS_5_C            0x00
#define TEMPLOG7_CFG2_HYSTERESIS_10_C           0x02
#define TEMPLOG7_CFG2_HYSTERESIS_15_C           0x04
#define TEMPLOG7_CFG2_HYSTERESIS_20_C           0x06
#define TEMPLOG7_CFG2_HYSTERESIS_MASK           0x06
#define TEMPLOG7_CFG2_LOCK_DIS                  0x00
#define TEMPLOG7_CFG2_LOCK_EN                   0x01
#define TEMPLOG7_CFG2_LOCK_MASK                 0x01
 
#define TEMPLOG7_TEMP_ALERT_LOW                 5.0f
#define TEMPLOG7_TEMP_ALERT_HIGH                40.0f
#define TEMPLOG7_TEMP_OFFSET                    0.0f
 
#define TEMPLOG7_IO_READ_NIO3_STATE             0x80
#define TEMPLOG7_IO_READ_NIO2_STATE             0x40
#define TEMPLOG7_IO_READ_NIO1_STATE             0x20
#define TEMPLOG7_IO_READ_NIO0_STATE             0x10
#define TEMPLOG7_IO_READ_IO3_STATE              0x08
#define TEMPLOG7_IO_READ_IO2_STATE              0x04
#define TEMPLOG7_IO_READ_IO1_STATE              0x02
#define TEMPLOG7_IO_READ_IO0_STATE              0x01
 
#define TEMPLOG7_IO_CFG_IO3_SEL_INPUT           0x00
#define TEMPLOG7_IO_CFG_IO3_SEL_OUTPUT_LOW      0x80
#define TEMPLOG7_IO_CFG_IO3_SEL_OUTPUT_HIGH     0xC0
#define TEMPLOG7_IO_CFG_IO3_SEL_MASK            0xC0
#define TEMPLOG7_IO_CFG_IO2_SEL_INPUT           0x00
#define TEMPLOG7_IO_CFG_IO2_SEL_ALERT           0x10
#define TEMPLOG7_IO_CFG_IO2_SEL_OUTPUT_LOW      0x20
#define TEMPLOG7_IO_CFG_IO2_SEL_OUTPUT_HIGH     0x30
#define TEMPLOG7_IO_CFG_IO2_SEL_MASK            0x30
#define TEMPLOG7_IO_CFG_IO1_SEL_INPUT           0x00
#define TEMPLOG7_IO_CFG_IO1_SEL_OUTPUT_LOW      0x08
#define TEMPLOG7_IO_CFG_IO1_SEL_OUTPUT_HIGH     0x0C
#define TEMPLOG7_IO_CFG_IO1_SEL_MASK            0x0C
#define TEMPLOG7_IO_CFG_IO0_SEL_INPUT           0x00
#define TEMPLOG7_IO_CFG_IO0_SEL_OUTPUT_LOW      0x02
#define TEMPLOG7_IO_CFG_IO0_SEL_OUTPUT_HIGH     0x03
#define TEMPLOG7_IO_CFG_IO0_SEL_MASK            0x03
#define TEMPLOG7_IO_CHECK_CODE_OK               0xAA
 
#define TEMPLOG7_EEPROM_ADDR_MIN                0x00
#define TEMPLOG7_EEPROM_ADDR_MAX                0xFF
#define TEMPLOG7_EEPROM_ADDR_BLOCK              8
#define TEMPLOG7_EEPROM_ADDR_MASK               0xFFF8u
 
#define TEMPLOG7_COPY_SCRATCHPAD_2_QUALIFIER    0xA5
 
#define TEMPLOG7_FAMILY_CODE                    0x26
 
#define TEMPLOG7_ADDRESS_0                      0x00
#define TEMPLOG7_ADDRESS_ALL                    0xFF
 
 // templog7_set
 
#define TEMPLOG7_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.alert = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // templog7_map
 // templog7
 
typedef enum
{
    TEMPLOG7_GPIO_0,          
    TEMPLOG7_GPIO_1           
} templog7_gpio_sel_t;
 
typedef struct
{
    int16_t temperature;        
    uint8_t status;             
    uint8_t config_1;           
    uint8_t config_2;           
    uint8_t short_addr;         
    int16_t temp_limit_low;     
    int16_t temp_limit_high;    
    int16_t temp_offset;        
} templog7_scratchpad_1_t;
 
typedef struct
{
    uint16_t address;           
    uint8_t data_buf[ TEMPLOG7_EEPROM_ADDR_BLOCK ];   
} templog7_scratchpad_2_t;
 
typedef struct
{
    // Input pins
    digital_in_t alert;         
    // Modules
    one_wire_t ow;              
    one_wire_rom_address_t rom_addr;    
    uint8_t address;            
} templog7_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;             
    pin_name_t gp1;             
    // Additional gpio pins
    pin_name_t alert;           
    templog7_gpio_sel_t gpio_sel;     
} templog7_cfg_t;
 
typedef enum
{
    TEMPLOG7_OK = 0,
    TEMPLOG7_ERROR = -1
 
} templog7_return_value_t;
 
void templog7_cfg_setup ( templog7_cfg_t *cfg );
 
void templog7_gpio_selection ( templog7_cfg_t *cfg, templog7_gpio_sel_t gpio_sel );
 
err_t templog7_init ( templog7_t *ctx, templog7_cfg_t *cfg );
 
err_t templog7_default_cfg ( templog7_t *ctx );
 
err_t templog7_check_communication ( templog7_t *ctx );
 
err_t templog7_select_device ( templog7_t *ctx );
 
err_t templog7_write_scratchpad_1 ( templog7_t *ctx, templog7_scratchpad_1_t *scratchpad );
 
err_t templog7_read_scratchpad_1 ( templog7_t *ctx, templog7_scratchpad_1_t *scratchpad );
 
err_t templog7_copy_scratchpad_1 ( templog7_t *ctx );
 
err_t templog7_write_scratchpad_2 ( templog7_t *ctx, templog7_scratchpad_2_t *scratchpad );
 
err_t templog7_read_scratchpad_2 ( templog7_t *ctx, templog7_scratchpad_2_t *scratchpad );
 
err_t templog7_copy_scratchpad_2 ( templog7_t *ctx );
 
err_t templog7_start_measurement ( templog7_t *ctx );
 
err_t templog7_read_temperature ( templog7_t *ctx, float *temperature );
 
err_t templog7_write_eeprom ( templog7_t *ctx, uint16_t address, uint8_t *data_in, uint16_t len );
 
err_t templog7_read_eeprom ( templog7_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );
 
err_t templog7_clear_eeprom ( templog7_t *ctx );
 
err_t templog7_write_gpio ( templog7_t *ctx, uint8_t data_in );
 
err_t templog7_read_gpio ( templog7_t *ctx, uint8_t *data_out );
 
uint8_t templog7_get_alert_pin ( templog7_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPLOG7_H
 
 // templog7
 
// ------------------------------------------------------------------------ END