max313xx.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 Technische Universität Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include <time.h>
#include <stdbool.h>
 
#include "periph/i2c.h"
#include "kernel_defines.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    i2c_t i2c;     
} max313xx_t;

typedef enum {
    MAX313xx_SQW_1HZ = 0,
    MAX313xx_SQW_2HZ = 1,
    MAX313xx_SQW_4HZ = 2,
    MAX313xx_SQW_8HZ = 3,
    MAX313xx_SQW_16HZ = 4,
    MAX313xx_SQW_32HZ = 5,
} max313xx_sqw_freq_t;

typedef enum {
    MAX313xx_TTSINT_1S   = 0x0, 
    MAX313xx_TTSINT_2S   = 0x1, 
    MAX313xx_TTSINT_4S   = 0x2, 
    MAX313xx_TTSINT_8S   = 0x3, 
    MAX313xx_TTSINT_16S  = 0x4, 
    MAX313xx_TTSINT_32S  = 0x5, 
    MAX313xx_TTSINT_64S  = 0x6, 
    MAX313xx_TTSINT_128S = 0x7, 
} max313xx_ttsint_t;

typedef enum {
    MAX313xx_TRICKLE_RES_3K  = 0x0U,  
    MAX313xx_TRICKLE_RES_6K  = 0x2U,  
    MAX313xx_TRICKLE_RES_11K = 0x3U,  
} max313xx_trickle_res_t;

typedef struct {
    i2c_t i2c;                              
} max313xx_params_t;

int max313xx_init(max313xx_t *dev, const max313xx_params_t *params);

int max313xx_get_time(const max313xx_t *dev, struct tm *time);

int max313xx_set_time(const max313xx_t *dev, const struct tm *time);

int max313xx_poweron(const max313xx_t *dev);

int max313xx_poweroff(const max313xx_t *dev);

int max313xx_set_alarm(const max313xx_t *dev, const struct tm *time);

int max313xx_get_alarm(const max313xx_t *dev, struct tm *time);

int max313xx_set_alarm_int(const max313xx_t *dev, bool enable);

int max313xx_set_sqw(const max313xx_t *dev, max313xx_sqw_freq_t freq);

int max313xx_get_temp(const max313xx_t *dev, int16_t *temp_centi);

int max313xx_trickle_charge_enable(const max313xx_t *dev, bool diode,
                                   max313xx_trickle_res_t res);

int max313xx_trickle_charge_disable(const max313xx_t *dev);

int max313xx_temp_set_automode(const max313xx_t *dev, bool enable, max313xx_ttsint_t ttsint);

 
#ifdef __cplusplus
}
#endif