10.3. 事件回调机制
10.3.1. 概述
PikaPython 内核中提供了事件回调机制，可以支持在 C 的事件/中断中触发 Python 定义的回调函数。
注意
需要内核版本不低于:
v1.8.7
10.3.2. 头文件
#include "PikaObj.h"
10.3.3. 数据类型
typedef PikaObj PikaEventListener;
事件回调机制主要依靠 PikaEventListener 事件监听器，事件监听器中记录了每个被注册的事件 ID，当有信号发送至事件监听器时，事件监听器将根据 事件 ID 将调用相应的 Python 回调函数，并传递信号量。
10.3.4. 事件模型
事件模型的核心是 PikaEventListener 事件监听器。
PikaEventListener 的模型如上图所示，向事件监听器中注册事件后，将会在 PikaEventListener 内部记录下一个事件项 Event Item，包括：
Event ID事件的唯一 IDEvent Handler Object事件对象，记录了事件项的全部信息Event CallBack事件回调函数 ( Python 函数 )
当 Event Signal 事件信号到来时，事件监听器将会匹配 Event ID 找到相应的事件项，然后再将信号代码Event Code传递给 Event CallBak 然后触发回调函数。
10.3.5. 事件回调机制流程
初始化事件监听器
在 Python 中注册回调函数
在 C 中向事件监听器发送信号 （通常在中断或 C 的回调中）
Python 中注册的回调函数被执行
10.3.6. 通过 PikaStdDevice 支持事件回调
继承 PikaStdDevice 是支持事件回调的最简单方式，PikaStdDevice.BaseDev 设备基本类已经支持了事件注册方法 addEventCallBack。
class BaseDev:
def addEventCallBack(self, eventCallback: any): ...
# need override
def platformGetEventId(self):...
PikaStdDevice中的设备类（如 GPIO）都继承了BaseDev，因此都获得了addEventCallBack的方法，能够注册回调。
/package/PikaStdDevice/PikaStdDevice.pyi
class GPIO(BaseDev):
...
平台驱动从 PikaStdDevice.GPIO 继承后，也获得了 addEventCallBack 方法。
/package/TemplateDevice/TemplateDevice.pyi
# TemplateDevice.pyi
class GPIO(PikaStdDevice.GPIO):
# overrid
···
def platformGetEventId(self): ...
···
只需要重写 platformGetEventId 平台方法，就能够支持注册回调。
例如：
/package/TemplateDevice/TemplateDevice_GPIO.c
const uint32_t GPIO_PA8_EVENT_ID = 0x08;
void TemplateDevice_GPIO_platformGetEventId(PikaObj* self) {
char* pin = obj_getStr(self, "pin");
if (strEqu(pin, "PA8")) {
obj_setInt(self, "eventId", GPIO_PA8_EVENT_ID);
}
}
10.3.7. 在 Python 注册回调函数
定义一个回调函数
callBack1，接收一个输入参数signal，signal能够接收传入的信号码。
/examples/TemplateDevice/gpio_cb.py
import TemplateDevice
io1 = TemplateDevice.GPIO()
io1.setPin('PA8')
io1.setMode('in')
io1.enable()
EVENT_SIGAL_IO_RISING_EDGE = 0x01
EVENT_SIGAL_IO_FALLING_EDGE = 0x02
def callBack1(signal):
if signal == EVENT_SIGAL_IO_RISING_EDGE:
print('get rising edge!')
elif signal == EVENT_SIGAL_IO_FALLING_EDGE:
print('get falling edge!')
io1.addEventCallBack(callBack1)
10.3.8. 信号触发
在需要触发事件回调时向 PikaEventListener 发送信号。
例如：/port/linux/test/event-test.cpp
通过
extern PikaEventListener* g_pika_device_event_listener得到PikaStdDevice提供的事件监听器。通过
pks_eventLisener_sendSignal发送eventID和signal code。
extern PikaEventListener* g_pika_device_event_listener;
#define EVENT_SIGAL_IO_RISING_EDGE 0x01
#define EVENT_SIGAL_IO_FALLING_EDGE 0x02
#define GPIO_PA8_EVENT_ID 0x08
TEST(event, gpio) {
/* init */
PikaObj* pikaMain = newRootObj("pikaMain", New_PikaMain);
/* run */
pikaVM_runFile(pikaMain, "../../examples/TemplateDevice/gpio_cb.py");
/* simulate run in the call back */
pks_eventLisener_sendSignal(g_pika_device_event_listener, GPIO_PA8_EVENT_ID,
EVENT_SIGAL_IO_RISING_EDGE);
pks_eventLisener_sendSignal(g_pika_device_event_listener, GPIO_PA8_EVENT_ID,
EVENT_SIGAL_IO_FALLING_EDGE);
...
}
运行结果：
get rising edge!
get falling edge!
10.3.8.1. 等待返回值
事件回调函数可以有返回值，如直接返回 signal。
def callBack1(signal):
return signal
io1.addEventCallBack(callBack1)
这个功能需要 OS 的支持， 需要重写 __platform_thread_delay() 方法，才能够在等待返回值时调度到主进程执行事件。
如果需要返回值，触发事件可以使用 pks_eventLisener_sendSignalAwaitResult 获得回调函数的返回值，返回值是一个 Arg* 类型。
Arg* res_123 = pks_eventLisener_sendSignalAwaitResult(
g_pika_device_event_listener, GPIO_PA8_EVENT_ID, 123);
int res = arg_getInt(res_123);
注意：需要内核版本
>= v1.11.7
10.3.9. 进阶：自定义事件注册函数
除了通过 PikaStdDevice 支持事件回调外，还可以自定义事件注册函数，这部分属于进阶内容。
自定义事件注册需要比较了解 PikaPython 的 C 模块机制和对象机制。
定义一个 C 模块的 Python 接口，接收传入的事件回调函数。
例如：
/package/PikaStdDevice/PikaStdDevice.pyi
class BaseDev:
def addEventCallBack(self, eventCallback: any): ...
事件回调函数的类型注解是 any。
在 C 模块的实现中注册事件
例如：/package/PikaStdDevice/PikaStdDevice_BaseDev.c
PikaEventListener* g_pika_device_event_listener;
void PikaStdDevice_BaseDev_addEventCallBack(PikaObj* self, Arg* eventCallBack) {
obj_setArg(self, "eventCallBack", eventCallBack);
/* init event_listener for the first time */
if (NULL == g_pika_device_event_listener) {
pks_eventLisener_init(&g_pika_device_event_listener);
}
if (PIKA_RES_OK != obj_runNativeMethod(self, "platformGetEventId", NULL)) {
obj_setErrorCode(self, 1);
__platform_printf("Error: Method %s no found.\r\n",
"platformGetEventId");
}
uint32_t eventId = obj_getInt(self, "eventId");
pks_eventLicener_registEvent(g_pika_device_event_listener, eventId, self);
}
创建一个全局的
PikaEventListener：g_pika_device_event_listener。将
self作为Event Handler Object，将evnetCallBack传入self。获取
evnetID这个例子中通过调用
platformGetEventId()平台函数来获得eventID，需要BaseDev继承，然后重写platformGetEventId()，在重写后的platformGetEventId()中设置self.eventId。
调用
pks_eventLicener_registEvent，将eventId和self注册进事件监听器。