Alarm
优质
小牛编辑
143浏览
2023-12-01
闹钟设备接口
结构体 | |
| struct | rt_rtc_wkalarm |
| 闹钟时间参数 更多... | |
| struct | rt_alarm |
| 闹钟管理控制块 更多... | |
| struct | rt_alarm_setup |
| 闹钟设置参数 更多... | |
| struct | rt_alarm_container |
| 闹钟管理容器控制块 更多... | |
宏定义 | |
| #define | RT_ALARM_TM_NOW -1 |
| 设置闹钟的时间参数为现在的时间 | |
| #define | RT_ALARM_ONESHOT 0x000 |
| 单次闹钟 | |
| #define | RT_ALARM_DAILY 0x100 |
| 每天闹钟 | |
| #define | RT_ALARM_WEEKLY 0x200 |
| 每周闹钟 | |
| #define | RT_ALARM_MONTHLY 0x400 |
| 每月闹钟 | |
| #define | RT_ALARM_YAERLY 0x800 |
| 每年闹钟 | |
| #define | RT_ALARM_CTRL_MODIFY 1 |
| 修改闹钟时间或参数命令 | |
类型定义 | |
| typedef struct rt_alarm * | rt_alarm_t |
| 闹钟类型指针定义 | |
| typedef void(* | rt_alarm_callback_t) (rt_alarm_t alarm, time_t timestamp) |
| 闹钟定时回调函数指针定义 | |
函数 | |
| rt_alarm_t | rt_alarm_create (rt_alarm_callback_t callback, struct rt_alarm_setup *setup) |
| 创建闹钟 | |
| rt_err_t | rt_alarm_control (rt_alarm_t alarm, int cmd, void *arg) |
| 修改闹钟设置 | |
| void | rt_alarm_update (rt_device_t dev, rt_uint32_t event) |
| 发送闹钟事件 | |
| rt_err_t | rt_alarm_delete (rt_alarm_t alarm) |
| 删除闹钟 | |
| rt_err_t | rt_alarm_start (rt_alarm_t alarm) |
| 启动闹钟 | |
| rt_err_t | rt_alarm_stop (rt_alarm_t alarm) |
| 停止闹钟 | |
| void | rt_alarm_system_init (void) |
| 初始化闹钟服务系统 | |
详细描述
闹钟设备接口
宏定义说明
| #define RT_ALARM_TM_NOW -1 |
设置闹钟的时间参数为现在的时间
闹钟类型宏定义
函数说明
| rt_alarm_t rt_alarm_create | ( | rt_alarm_callback_t | callback, |
| struct rt_alarm_setup * | setup | ||
| ) |
创建闹钟
调用此函数可以根据设定的参数创建一个闹钟，并指定闹钟的回调函数。
- 参数
callback 闹钟回调函数 setup 闹钟的设置参数
- 返回
- 成功则返回闹钟句柄，失败则返回RT_NULL。
| rt_err_t rt_alarm_control | ( | rt_alarm_t | alarm, |
| int | cmd, | ||
| void * | arg | ||
| ) |
修改闹钟设置
- 参数
alarm 闹钟控制块 cmd 闹钟的设置命令 arg 设置命令相关的参数
- 返回
- 错误号
| void rt_alarm_update | ( | rt_device_t | dev, |
| rt_uint32_t | event | ||
| ) |
发送闹钟事件
- 参数
dev 指向闹钟设备的指针（当前未使用，可以忽略） event RTC事件（当前未使用）
| rt_err_t rt_alarm_delete | ( | rt_alarm_t | alarm | ) |
删除闹钟
调用此函数可以删除指定的闹钟并释放其占用的系统内存空间。
- 参数
alarm 闹钟句柄
- 返回
- 错误号
| rt_err_t rt_alarm_start | ( | rt_alarm_t | alarm | ) |
启动闹钟
- 参数
alarm 闹钟控制块
- 返回
- 错误号
| rt_err_t rt_alarm_stop | ( | rt_alarm_t | alarm | ) |
停止闹钟
- 参数
alarm 闹钟控制块
- 返回
- RT_EOK 成功；错误号 失败。