c7seg2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2023 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 C7SEG2_H
#define C7SEG2_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_i2c_master.h"
 
#define C7SEG2_REG_DEVICE_ID                0x00
#define C7SEG2_REG_DEVICE_EN                0x01
#define C7SEG2_REG_CH_EN_LOW                0x02
#define C7SEG2_REG_CH_EN_HIGH               0x03
#define C7SEG2_REG_CONFIG                   0x04
#define C7SEG2_REG_FAULT_MASK               0x05
#define C7SEG2_REG_FAULT_INT                0x06
#define C7SEG2_REG_OPEN_LED_LOW             0x07
#define C7SEG2_REG_OPEN_LED_HIGH            0x08
#define C7SEG2_REG_CUR_LED_CS0              0x09
#define C7SEG2_REG_CUR_LED_CS1              0x0A
#define C7SEG2_REG_CUR_LED_CS2              0x0B
#define C7SEG2_REG_CUR_LED_CS3              0x0C
#define C7SEG2_REG_CUR_LED_CS4              0x0D
#define C7SEG2_REG_CUR_LED_CS5              0x0E
#define C7SEG2_REG_CUR_LED_CS6              0x0F
#define C7SEG2_REG_CUR_LED_CS7              0x10
#define C7SEG2_REG_CUR_LED_CS8              0x11
#define C7SEG2_REG_CUR_LED_CS9              0x12
#define C7SEG2_REG_CUR_LED_CS10             0x13
#define C7SEG2_REG_CUR_LED_CS11             0x14
#define C7SEG2_REG_PATTERN_SEQ_REP          0x15
#define C7SEG2_REG_PATTERN_0_DUR            0x16
#define C7SEG2_REG_PATTERN_1_DUR            0x17
#define C7SEG2_REG_PATTERN_2_DUR            0x18
#define C7SEG2_REG_PATTERN_3_DUR            0x19
#define C7SEG2_REG_PATTERN_4_DUR            0x1A
#define C7SEG2_REG_PATTERN_5_DUR            0x1B
#define C7SEG2_REG_PATTERN_6_DUR            0x1C
#define C7SEG2_REG_PATTERN_7_DUR            0x1D
#define C7SEG2_REG_PWMREG_OFFSET            0x1E
#define C7SEG2_REG_CLOCK_CONFIG             0xE0
 
 // c7seg2_reg
 
#define C7SEG2_SEGMENT_0                    0
#define C7SEG2_SEGMENT_1                    1
#define C7SEG2_SEGMENT_2                    2
#define C7SEG2_SEGMENTS_NUMBER              3
#define C7SEG2_SEGMENTS_DISABLED            0x0000u
 
#define C7SEG2_DP_NONE                      0
#define C7SEG2_DP_AT_SEGMENT_0              1
#define C7SEG2_DP_AT_SEGMENT_1              2
#define C7SEG2_DP_AT_SEGMENT_2              3
#define C7SEG2_DP_MASK                      0x03
#define C7SEG2_DP_PIN_MASK                  0x0010u
 
#define C7SEG2_REFRESH_RATE_US              7500
#define C7SEG2_REFRESH_RATE_DELAY           ( C7SEG2_REFRESH_RATE_US / 50 )
 
#define C7SEG2_DIGIT_0                      0
#define C7SEG2_DIGIT_1                      1
#define C7SEG2_DIGIT_2                      2
#define C7SEG2_DIGIT_3                      3
#define C7SEG2_DIGIT_4                      4
#define C7SEG2_DIGIT_5                      5
#define C7SEG2_DIGIT_6                      6
#define C7SEG2_DIGIT_7                      7
#define C7SEG2_DIGIT_8                      8
#define C7SEG2_DIGIT_9                      9
#define C7SEG2_DIGITS_NUMBER                10
#define C7SEG2_MAX_NUMBER                   999
 
#define C7SEG2_DEVICE_ID                    0x12
 
#define C7SEG2_SW_RESET                     0x80
#define C7SEG2_ENABLE                       0x01
 
#define C7SEG2_CURRENT_DEFAULT              15.0f
#define C7SEG2_CURRENT_STEP_TO_HEX          12.75f
 
#define C7SEG2_DEVICE_ADDRESS               0x58
 
 // c7seg2_set
 
#define C7SEG2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // c7seg2_map
 // c7seg2
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} c7seg2_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
    float      current;         
} c7seg2_cfg_t;
 
typedef enum
{
    C7SEG2_OK = 0,
    C7SEG2_ERROR = -1
 
} c7seg2_return_value_t;
 
void c7seg2_cfg_setup ( c7seg2_cfg_t *cfg );
 
err_t c7seg2_init ( c7seg2_t *ctx, c7seg2_cfg_t *cfg );
 
err_t c7seg2_sw_reset ( c7seg2_t *ctx );
 
err_t c7seg2_default_cfg ( c7seg2_t *ctx );
 
err_t c7seg2_generic_write ( c7seg2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t c7seg2_generic_read ( c7seg2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t c7seg2_get_int_pin ( c7seg2_t *ctx );
 
err_t c7seg2_write_reg ( c7seg2_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t c7seg2_read_reg ( c7seg2_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t c7seg2_set_segments_current ( c7seg2_t *ctx, float current_val );
 
err_t c7seg2_write_segment ( c7seg2_t *ctx, uint8_t segment, uint8_t number, uint8_t dpt );
 
err_t c7seg2_disable_segments ( c7seg2_t *ctx );
 
err_t c7seg2_write_number ( c7seg2_t *ctx, uint16_t number, uint8_t dpt );
 
#ifdef __cplusplus
}
#endif
#endif // C7SEG2_H
 
 // c7seg2
 
// ------------------------------------------------------------------------ END