Demo the function of RTC module AM1805

Dependencies:   mbed-dev

Fork of I2C_HelloWorld_Mbed by mbed official

AM1805.h

Committer:
marcusC
Date:
2015-12-24
Revision:
2:16b8f527b5c7
Parent:
1:c45df8c46fa8

File content as of revision 2:16b8f527b5c7:

/* AM1805.h , AM1805 Sample code: external RTC module is used by host MCU */

typedef struct
{
    uint8_t hundredth;
    uint8_t second;
    uint8_t minute;
    uint8_t hour;
    uint8_t date;
    uint8_t weekday;
    uint8_t month;
    uint8_t year;
    uint8_t century;
    uint8_t mode;
} time_reg_struct_t;

typedef enum
{
    XT1_INTERRUPT = 0x01, /**< WDI input pin will generate XT1 interrupt  */
    XT2_INTERRUPT = 0x02  /**< EXTI input pin will generate XT2 interrupt */
} input_interrupt_t;

typedef enum
{
    DISABLE_ALARM = 0, /**< disable alarm */
    ONCE_PER_YEAR = 1, /**< once per year */
    ONCE_PER_MONTH = 2, /**< once per month */
    ONCE_PER_WEEK = 3, /**< once per week */
    ONCE_PER_DAY = 4, /**< once per day */
    ONCE_PER_HOUR = 5, /**< once per hour */
    ONCE_PER_MINUTE = 6, /**< once per minute */
    ONCE_PER_SECOND = 7, /**< once per second */
    ONCE_PER_10TH_SEC = 8, /**< once per 10th of a second */
    ONCE_PER_100TH_SEC = 9 /**< once per 100th of a second */
} alarm_repeat_t;

typedef enum
{
    PERIOD_US = 0, /**< period in us */
    PERIOD_SEC = 1 /**< period in seconds */
} count_down_range_t;

typedef enum
{
    SINGLE_LEVEL_INTERRUPT = 0, /**< single level interrupt */
    REPEAT_PULSE_1_4096_SEC = 1, /**< a repeated pulsed interrupt, 1/4096 s (XT mode), 1/128 s (RC mode) (range must be 0) */
    SINGLE_PULSE_1_4096_SEC = 2, /**< a single pulsed interrupt, 1/4096 s (XT mode), 1/128 s (RC mode) (range must be 0) */
    REPEAT_PLUSE_1_128_SEC = 3, /**< a repeated pulsed interrupt, 1/128 s (range must be 0) */
    SINGLE_PLUSE_1_128_SEC = 4, /**< a single pulsed interrupt, 1/128 s (range must be 0) */
    REPEAT_PLUSE_1_64_SEC = 5, /**< a repeated pulsed interrupt, 1/64 s (range must be 1) */
    SINGLE_PLUSE_1_64_SEC = 6 /**< a single pulsed interrupt, 1/64 s (range must be 1) */    
} count_down_repeat_t;

typedef enum
{
    LEVEL_INTERRUPT = 0x00, /**< level interrupt */
    PULSE_1_8192_SEC = 0x01, /**< pulse of 1/8192s (XT) or 1/128 s (RC) */
    PULSE_1_64_SEC = 0x10, /**< pulse of 1/64 s  */
    PULSE_1_4_SEC = 0x11 /**< pulse of 1/4 s  */
} interrupt_mode_t;

typedef enum
{
    INTERNAL_FLAG = 0, /**< internal flag only */
    PIN_FOUT_nIRQ = 1, /**< generate the interrupt on FOUT/nIRQ */
    PIN_PSW_nIRQ2 = 2, /**< generate the interrupt on PSW/nIRQ2 */
    PIN_nTIRQ = 3      /**< generate the interrupt on nTIRQ (not apply to ALARM) */
} interrupt_pin_t;

bool am1805_init(void);

void am1805_register_read(char register_address, char *destination, uint8_t number_of_bytes);

void am1805_register_write(char register_address, uint8_t value);

void am1805_burst_write(uint8_t *value, uint8_t number_of_bytes);

uint8_t am1805_read_ram(uint8_t address);

void am1805_write_ram(uint8_t address, uint8_t data);

void am1805_config_input_interrupt(input_interrupt_t index_Interrupt);

void am1805_set_time(time_reg_struct_t time_regs);

void am1805_get_time(time_reg_struct_t *time_regs);

void am1805_config_alarm(time_reg_struct_t time_regs, alarm_repeat_t repeat, interrupt_mode_t intmode, interrupt_pin_t pin);

void am1805_config_countdown_timer(count_down_range_t range, int32_t period, count_down_repeat_t repeat, interrupt_pin_t pin);

void am1805_set_sleep(uint8_t timeout, uint8_t mode);