Calendar驱动API描述
Calendar驱动的API主要如下：
| API类别 | API名称 | 描述 |
|---|---|---|
|
初始化 |
hal_calendar_init() |
初始化Calendar外设，以回环中断方式启动Calendar。 |
|
hal_calendar_deinit() |
反初始化Calendar外设。 |
|
|
IO操作 |
hal_calendar_init_time() |
初始化Calendar当前时间。 |
|
hal_calendar_get_time() |
获取Calendar当前时间。 |
|
|
hal_calendar_set_alarm() |
设置Calendar闹铃时间，并启动闹铃功能。 |
|
|
hal_calendar_set_tick() |
设置calendar闹铃的毫秒计数，并启动闹铃功能 |
|
|
hal_calendar_disable_event() |
停止Calendar闹铃功能。 |
|
|
中断处理及回调函数 |
hal_calendar_irq_handler() |
中断处理函数。 |
|
hal_calendar_alarm_callback() |
闹铃的中断回调函数。 |
|
|
hal_calendar_tick_callback() |
闹铃毫秒计数的中断回调函数 |
下面章节将对各API进行详细描述。
hal_calendar_init
| 函数原型 | hal_status_t hal_calendar_init(calendar_handle_t *p_calendar) |
|---|---|
| 功能说明 | 初始化Calendar外设，以回环中断方式启动Calendar。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 |
| 返回值 | HAL状态。 |
| 备注 |
hal_calendar_deinit
| 函数原型 | hal_status_t hal_calendar_deinit(calendar_handle_t *p_calendar) |
|---|---|
| 功能说明 | 反初始化Calendar外设。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量。包含指定的Calendar模块的配置信息。 |
| 返回值 | HAL状态。 |
| 备注 |
hal_calendar_init_time
| 函数原型 | hal_status_t hal_calendar_init_time(calendar_handle_t *p_calendar, calendar_time_t *p_time) |
|---|---|
| 功能说明 | 初始化Calendar当前时间。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 p_time：指向calendar_time_t结构体变量的指针，该结构体变量包含指定的Calendar的时间配置信息。 |
| 返回值 | HAL状态 |
| 备注 | 调用该接口时，其中year的最小值为10，即2010年。 |
hal_calendar_get_time
| 函数原型 | hal_status_t hal_calendar_get_time(calendar_handle_t *p_calendar, calendar_time_t *p_time) |
|---|---|
| 功能说明 | 获取Calendar当前时间。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 p_time：指向calendar_time_t结构体变量的指针，该结构体变量包含当前Calendar的时间信息。 |
| 返回值 | HAL状态。 |
| 备注 |
hal_calendar_set_alarm
| 函数原型 | hal_status_t hal_calendar_set_alarm(calendar_handle_t *p_calendar, calendar_alarm_t *p_alarm) |
|---|---|
| 功能说明 | 根据p_alarm配置Calendar闹铃时间，并启动闹铃功能。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 p_alarm：指向calendar_alarm_t结构体变量的指针，该结构体变量包含指定的闹铃时间的配置信息。 |
| 返回值 | HAL状态。 |
| 备注 | 该API将使能calendar中断，计时到闹铃时间时回调函数hal_calendar_alarm _callback()会被调用。 |
hal_calendar_set_tick
| 函数原型 | hal_status_t hal_hal_calendar_set_tick(calendar_handle_t *p_calendar, uint32_t interval) |
|---|---|
| 功能说明 | 设置闹钟的毫秒计数。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 |
| 返回值 | HAL状态。 |
| 备注 | 最小值是5 ms，最大值为3600*1000 ms。 |
hal_calendar_disable_event
| 函数原型 | hal_status_t hal_calendar_disable_event(calendar_handle_t *p_calendar, uint32_t disable_mode) |
|---|---|
| 功能说明 | 停止Calendar闹铃功能。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 disable_mode:选择关闭哪类闹钟，参数可以配置为CALENDAR_ALARM_DISABLE_DATE、 CALENDAR_ALARM_DISABLE_TICK、CALENDAR_ALARM_DISABLE_ALL。 |
| 返回值 | HAL状态。 |
| 备注 | 该API禁止Calendar闹铃功能，可与hal_calendar_set_alarm()配合使用。 |
hal_calendar_irq_handler
| 函数原型 | void hal_calendar_irq_handler(calendar_handle_t *p_calendar) |
|---|---|
| 功能说明 | Calendar中断处理函数。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 |
| 返回值 | 无 |
| 备注 |
hal_calendar_alarm_callback
| 函数原型 | void hal_calendar_alarm_callback(calendar_handle_t *p_calendar) |
|---|---|
| 功能说明 | 闹铃的中断回调函数。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 |
| 返回值 | 无 |
| 备注 | 该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。 |
hal_calendar_tick_callback
| 函数原型 | void hal_calendar_tick_callback(calendar_handle_t *p_calendar) |
|---|---|
| 功能说明 | 毫秒闹铃的中断回调函数。 |
| 输入参数 | p_calendar：指向calendar_handle_t结构体变量的指针，该结构体变量包含指定的Calendar模块的配置信息。 |
| 返回值 | 无 |
| 备注 | 该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。 |
