连接设备

IoT 驱动程序允许任何 Odoo 模块与连接到 IoT Box 的任何设备进行实时通信。与 IoT Box 的通信是双向的,因此 Odoo 客户端可以向任何支持的设备发送命令并从其接收信息。

要添加对设备的支持,我们需要的是:

  • Interface,用于检测特定类型的已连接设备

  • a Driver,与单个设备通信

每次启动时,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 方法。如果Driver支持的方法返回`True`,则将为相应的设备创建该Driver的实例。

注解

驱动程序的 supported 方法具有优先级顺序。子类的 supported 方法将始终在其父类的方法之前进行测试。这个优先级可以通过修改Driver的`priority`属性来调整。

创建新的驱动程序需要:

  • 扩展 Driver

  • 设置 connection_type 类属性。

  • 设置 device_typedevice_connectiondevice_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)