Files
enterprise-addons/iot/wizard/add_iot_box.py
T

198 lines
7.8 KiB
Python

# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
from odoo import _, fields, models
import logging
import requests
_logger = logging.getLogger(__name__)
class AddIotBox(models.TransientModel):
_name = 'add.iot.box'
_description = 'Add IoT Box wizard'
# Depending on the stage different window actions are available
stage = fields.Selection([
('start', 'Start'),
('connect', 'Connect'),
('manual', 'Manual'),
('pair_offline', 'Offline Pairing'),
], string='Stage', default='start')
discovered_box_ids = fields.One2many("iot.discovered.box", "add_iot_box_wizard_id")
iot_box_to_connect = fields.Many2one("iot.discovered.box")
serial_number = fields.Char(string='Serial Number')
pairing_code = fields.Char(string='Pairing Code')
offline_pairing_token = fields.Char(
"Token", default=lambda self: self._compute_pairing_token(), readonly=True, store=False
)
# ------------------------- IOT-PROXY CALLING METHODS -------------------------
def _connect_iot_box_with_pairing_code(self):
"""
Calls the route /odoo-enterprise/iot/connect-db to connect the IoT Box with the provided pairing code
:return: the action to open the wizard view with the next step
"""
# Pairing code can be entered manually or recovered from the selected IoT Box
if self.iot_box_to_connect:
self.pairing_code = self.iot_box_to_connect.pairing_code
self.serial_number = self.iot_box_to_connect.serial_number
try:
icp_sudo = self.env['ir.config_parameter'].sudo()
response = requests.post(
'https://iot-proxy.odoo.com/odoo-enterprise/iot/connect-db',
json={
'params': {
'pairing_code': self.pairing_code,
'database_url': self.get_base_url(),
'token': self.env['iot.box']._default_token(),
'db_uuid': icp_sudo.get_param('database.uuid'),
'enterprise_code': icp_sudo.get_param('database.enterprise_code'),
},
},
timeout=5
)
response.raise_for_status()
json = response.json()
# Typically occurs when the used pairing code wasn't found on iot proxy
error = json.get('error') # e.g {'code': 404, 'message': '404: Not Found', ...}
if error:
_logger.warning("Error when using pairing code %s. IoT Proxy responded with an error message: %s", self.pairing_code, error)
return self._open_no_iot_box_found_action()
result = json.get('result') # e.g [{'id': 1, 'serial_number': '12345'}]}
if result and result[0]:
return self._open_connecting_action()
else:
_logger.warning("Failed to connect the IoT Box with pairing code %s: %s", self.pairing_code, json)
except (requests.exceptions.RequestException, ValueError):
_logger.exception("Failed to use the provided pairing code %s to connect an iot box", self.pairing_code)
return self._open_no_iot_box_found_action()
# ------------------------- WIZARD OPEN ACTIONS -------------------------
def _open_select_box_to_connect_action(self):
self.stage = 'connect'
return {
'type': 'ir.actions.act_window',
'res_model': 'add.iot.box',
'res_id': self.id,
'name': _("Several IoT's detected"),
'views': [[self.env.ref('iot.view_select_box_to_connect').id, 'form']],
'target': 'new',
}
def _open_enter_pairing_code_action(self):
self.stage = 'connect'
return {
'type': 'ir.actions.act_window',
'res_model': 'add.iot.box',
'res_id': self.id,
'name': _("Searching for an IoT Box..."),
'views': [[self.env.ref('iot.view_enter_pairing_code').id, 'form']],
'target': 'new',
}
def _open_no_iot_box_found_action(self):
self.stage = 'manual'
return {
'type': 'ir.actions.act_window',
'res_model': 'add.iot.box',
'res_id': self.id,
'name': _("Searching for an IoT Box..."),
'views': [[self.env.ref('iot.view_no_iot_box_found').id, 'form']],
'target': 'new',
'no_iot_found_found': True,
}
def _open_connecting_action(self):
if self.serial_number:
name = _('IoT Box %s found. Connecting...', self.serial_number)
else:
name = _('IoT Box found. Connecting...')
return {
'type': 'ir.actions.act_window',
'res_model': 'add.iot.box',
'res_id': self.id,
'name': name,
'views': [[self.env.ref('iot.view_add_iot_box').id, 'form']],
'target': 'new',
}
def open_documentation_url(self):
return {
'type': 'ir.actions.act_url',
'url': 'https://www.odoo.com/documentation/latest/applications/general/iot/iot_box.html',
'target': 'new',
}
# ------------------------- WIZARD STAGE ACTIONS -------------------------
def _start_stage(self):
"""
Make a request to discover local IoT Boxes
If none are found, open the pairing code wizard
If only 1 is found, attempt to connect it directly
If > 1 is found, open the select box wizard
"""
n_detected_iot_boxes = len(self.discovered_box_ids)
# If multiple IoT Boxes are found, ask the user to select one
if n_detected_iot_boxes > 1:
return self._open_select_box_to_connect_action()
# If only one IoT Box is found, connect it directly without showing the wizard to the user
elif n_detected_iot_boxes == 1:
self.pairing_code = self.discovered_box_ids[0].pairing_code
self.serial_number = self.discovered_box_ids[0].serial_number
return self._connect_iot_box_with_pairing_code()
# If no IoT Boxes are found, ask the user to enter the pairing code manually
else:
return self._open_no_iot_box_found_action()
def add_iot_box_wizard_action(self):
"""
Base action for the wizard used to connect IoT Boxes
Depending on the stage of the wizard, different actions are available
"""
match self.stage:
case 'start':
return self._start_stage()
case 'manual':
return self._open_enter_pairing_code_action()
case 'connect':
return self._connect_iot_box_with_pairing_code()
return None
def pair_offline(self):
"""Use the token to pair an IoT Box.
Allows to pair an IoT Box that is not connected to the internet
"""
if self.stage == 'pair_offline':
self.stage = 'start'
return self._start_stage()
self.stage = 'pair_offline'
return {
'type': 'ir.actions.act_window',
'res_model': 'add.iot.box',
'res_id': self.id,
'name': _("Pair an IoT Box offline"),
'views': [[self.env.ref('iot.view_pair_offline').id, 'form']],
'target': 'new',
}
def _compute_pairing_token(self):
icp_sudo = self.env['ir.config_parameter'].sudo()
token = self.env['iot.box']._default_token()
url = self.get_base_url()
db_uuid = icp_sudo.get_param('database.uuid', default='')
db_name = self.env.cr.dbname
enterprise_code = icp_sudo.get_param('database.enterprise_code', default='')
return f"{url}?token={token}&db_uuid={db_uuid}&enterprise_code={enterprise_code}&db_name={db_name}"