Files
Odoo-Modules/fusion_iot/iot/wizard/add_iot_box.py
gsinghpal 6e964c230f feat(iot): repackaged Odoo iot modules + Fusion Plating sensor wrapper
Phase A of the IoT initiative — gets the server-side infrastructure
in place before the Raspberry Pi hardware arrives, so the iot admin
UI + /fp/iot/ingest endpoint are ready to accept the first real
temperature reading as soon as the Pi is wired up.

New top-level folder: fusion_iot/

1. **iot_base/** — Odoo S.A. iot_base module, copied from
   RePackaged-Odoo verbatim. LGPL-3 upstream, no changes needed.

2. **iot/** — Odoo S.A. iot module, repackaged:
   - `models/update.py` neutralised (removed the publisher_warranty
     IoT-Box-counting report that phones home to odoo.com for
     enterprise licence enforcement)
   - `iot_handlers/lib/load_worldline_library.sh` deleted (proprietary
     Worldline payment lib fetch from download.odoo.com, not needed)
   - `wizard/add_iot_box.py._connect_iot_box_with_pairing_code` —
     upstream called odoo.com's iot-proxy to resolve pairing codes;
     replaced with a no-op. Pi-side iot_drivers proxy registers
     directly with this Odoo server instead.
   - Manifest rebranded with an explicit changelog preamble.

3. **fusion_plating_iot/** — new plating-specific wrapper:
   - `fp.tank.sensor` — maps an iot.device (or a direct-HTTP-ingest
     sensor) to a fusion.plating.tank + fusion.plating.bath.parameter.
     Supports DS18B20, PT100/1000, pH, conductivity, level. Per-sensor
     alert_min/max overrides.
   - `fp.tank.reading` — append-only time-series. On create, evaluates
     against sensor's alert range. On in-spec → out-of-spec TRANSITION,
     auto-raises a fusion.plating.quality.hold (once per excursion,
     no spam during sustained out-of-spec).
   - `POST /fp/iot/ingest` — shared-secret HTTP endpoint for sensors
     bypassing the Pi proxy. Token via X-FP-IOT-Token header OR body.
     Accepts single-reading or batch payloads.
   - Menu under Plating → Operations → Sensors & Readings.
   - Tank form inherits get a Sensors tab inline.

Deployed to entech. Verified end-to-end:
- Install: iot_base + iot + fusion_plating_iot all 'installed'
- Smoke test: in-spec → out-of-spec → hold raised (HOLD-0010);
  continued excursion → NO duplicate hold; back-in-spec → NEW
  excursion → NEW hold (HOLD-0011) ✓
- HTTP endpoint: correct token → 200 accepted; wrong token → 401;
  unknown device_serial → 404; batch payload → 200 accepted=N ✓

Phase B (when Raspberry Pi hardware arrives): DS18B20 iot_handler
driver for the Pi-side iot_drivers proxy + systemd service on
vanilla Raspberry Pi OS + first live reading from physical probe.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-19 10:46:45 -04:00

179 lines
6.7 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):
"""Community repackage — the upstream version called out to
Odoo S.A.'s iot-proxy service at odoo.com to resolve pairing
codes. That's phone-home for licensed IoT Boxes. In community
mode we pair directly: the Pi-side iot_drivers proxy registers
itself with this Odoo server using the shared token, so no
third-party resolution is needed.
If a user gets to this wizard path anyway, log + show the
"no box found" screen. The normal flow is for operators to
use the direct pairing (or the /fp/iot/ingest endpoint for
HTTP-only sensors).
"""
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
_logger.info(
'IoT pairing-code wizard invoked with code=%s, serial=%s'
'upstream odoo.com proxy call disabled in community repackage. '
'Use direct IoT Box registration instead.',
self.pairing_code, self.serial_number,
)
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': '#',
'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}"