连接设备¶
物联网驱动程序允许任何 Odoo 模块与连接到物联网箱的任何设备进行实时通信。与物联网箱的通信是双向的,因此 Odoo 客户端可以向支持的设备发送命令并接收信息。
要添加对设备的支持,我们只需要:
一个
接口
,用于检测特定类型的连接设备一个
驱动程序
,用于与单个设备进行通信
每次启动时,IoT Box 会加载连接的 Odoo 实例上可以找到的所有接口和驱动程序。每个模块可以包含一个 iot_handlers
目录,该目录将被复制到 IoT Box 中。此目录的结构如下:
your_module
├── ...
└── iot_handlers
├── drivers
│ ├── DriverName.py
│ └── ...
│
└── interfaces
├── InterfaceName.py
└── ...
检测设备¶
通过 `Interfaces`(接口)可以检测连接到 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
方法总是会在其父类的 supported
方法之前被测试。此优先级可以通过修改 Driver
的 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 模块中显示,下一步就是与它进行沟通。由于该设备仅具有本地 IP 地址,因此只能从同一本地网络中访问。因此,通信需要在浏览器端通过 JavaScript 实现。
通信过程取决于沟通方向: - 从浏览器到设备,通过 Actions - 从设备到浏览器,通过 Longpolling
两个通道都通过同一个 JS 对象 DeviceProxy
进行访问,该对象使用 IoT Box 的 IP 地址和设备标识符进行实例化。
var DeviceProxy = require('iot.DeviceProxy');
var iot_device = new DeviceProxy({
iot_ip: iot_ip,
identifier: device_identifier
});
操作¶
动作用于指示选定的设备执行特定操作,例如拍照、打印收据等。
注解
必须注意,在此路由上,盒子不会发送任何“响应”,仅返回请求状态。如果有的话,对该动作的响应必须通过长轮询获取。
可以对 DeviceProxy 对象执行一个动作。
iot_device.action(data);
在您的驱动程序中,定义一个 action
方法,该方法将在从 Odoo 模块调用时执行。它会将调用期间提供的数据作为参数传入。
def action(self, data):
...
长轮询¶
当 Odoo 中的任何模块需要从特定设备读取数据时,它会创建一个由盒子的 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)