连接设备¶
IoT驱动程序允许任何Odoo模块与连接到IoT Box的任何设备进行实时通信。与IoT Box的通信是双向的,因此Odoo客户端可以向支持的设备发送命令并接收信息。
要为设备添加支持,我们需要:
一个
接口
,用于检测特定类型的已连接设备一个
驱动程序
,用于与单个设备通信
每次启动时,IoT Box将加载连接的Odoo实例中可以找到的所有接口和驱动程序。每个模块都可以包含一个 iot_handlers
目录,该目录将被复制到IoT Box中。此目录的结构如下:
your_module
├── ...
└── iot_handlers
├── drivers
│ ├── DriverName.py
│ └── ...
│
└── interfaces
├── InterfaceName.py
└── ...
检测设备¶
通过 接口
检测连接到IoT Box的设备。每种受支持的连接类型(USB、蓝牙、视频、打印机、串口等)都有一个接口。接口维护检测到的设备列表,并将它们与正确的驱动程序关联。
受支持的设备将出现在通过其IP地址访问的IoT Box主页上,以及连接的Odoo实例的IoT模块中。
接口¶
接口的作用是维护通过某种确定连接类型连接的设备列表。创建新接口需要:
扩展
Interface
类设置
connection_type
类属性实现
get_devices
方法,该方法应返回一个包含每个检测到的设备数据的字典。这些数据将作为参数传递给驱动程序的构造函数和supported
方法。
注解
设置 _loop_delay
属性将修改调用 get_devices
之间的时间间隔。默认情况下,此间隔设置为3秒。
from odoo.addons.hw_drivers.interface import Interface
class InterfaceName(Interface):
connection_type = 'ConnectionType'
def get_devices(self):
return {
'device_identifier_1': {...},
...
}
驱动程序¶
一旦接口检索到检测到的设备列表,它将遍历所有具有相同 connection_type
属性的驱动程序,并在所有检测到的设备上测试它们各自的 supported
方法。如果某个驱动程序的 supported
方法返回 True
,则将为相应的设备创建该驱动程序的实例。
注解
驱动程序的 supported
方法具有优先级顺序。子类的 supported
方法总是在父类的方法之前被测试。可以通过修改驱动程序的 priority
属性来调整此优先级。
创建新的驱动程序需要:
扩展`Driver`
设置
connection_type
类属性。设置
device_type
、device_connection
和device_name
属性。定义
supported
方法
from odoo.addons.hw_drivers.driver import Driver
class DriverName(Driver):
connection_type = 'ConnectionType'
def __init__(self, identifier, device):
super(NewDriver, self).__init__(identifier, device)
self.device_type = 'DeviceType'
self.device_connection = 'DeviceConnection'
self.device_name = 'DeviceName'
@classmethod
def supported(cls, device):
...
与设备通信¶
一旦您的新设备被检测到并出现在IoT模块中,下一步就是与其通信。由于IoT Box只有本地IP地址,因此只能从同一局域网内访问。因此,通信需要在浏览器端使用JavaScript进行。
该过程取决于通信的方向:- 从浏览器到IoT Box,通过 操作 - 从IoT Box到浏览器,通过 长轮询
这两个通道都通过同一个JS对象访问,即 DeviceProxy
,它使用IoT Box的IP和设备标识符进行实例化。
var DeviceProxy = require('iot.DeviceProxy');
var iot_device = new DeviceProxy({
iot_ip: iot_ip,
identifier: device_identifier
});
操作¶
操作用于指示选定的设备执行特定的操作,例如拍照、打印收据等。
注解
需要注意的是,IoT Box不会通过此路径发送“响应”,只会返回请求状态。如果操作有响应,则需要通过长轮询获取。
可以在DeviceProxy对象上执行操作。
iot_device.action(data);
在您的驱动程序中,定义一个 action
方法,当从Odoo模块调用时将执行该方法。它将调用期间提供的数据作为参数。
def action(self, data):
...
长轮询¶
当Odoo中的任何模块希望从特定设备读取数据时,它会创建一个监听器,该监听器由IoT Box的IP/域名和设备标识符标识,并传递一个回调函数,每当设备状态发生变化时都会调用该回调函数。回调函数会以新数据作为参数被调用。
iot_device.add_listener(this._onValueChange.bind(this));
_onValueChange: function (result) {
...
}
在驱动程序中,通过调用 event_manager
中的 device_changed
函数来触发事件。监听器上设置的所有回调函数都会以 self.data
作为参数被调用。
from odoo.addons.hw_drivers.event_manager import event_manager
class DriverName(Driver):
connection_type = 'ConnectionType'
def methodName(self):
self.data = {
'value': 0.5,
...
}
event_manager.device_changed(self)