Files
Odoo-Modules/fusion_iot/fusion_plating_iot/controllers/fp_iot_ingest.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

144 lines
5.2 KiB
Python

# -*- coding: utf-8 -*-
# Copyright 2026 Nexa Systems Inc.
# License OPL-1 (Odoo Proprietary License v1.0)
# Part of the Fusion Plating product family.
"""Direct-HTTP ingest endpoint for sensors that bypass the Odoo IoT proxy.
Authentication: shared secret header `X-FP-IOT-Token` compared to the
system parameter `fusion_plating_iot.ingest_token`. The Pi proxy (via
iot_drivers) uses Odoo's built-in websocket and doesn't need this path.
Payload (JSON):
{
"device_serial": "28-abc123def456",
"value": 87.3,
"unit": "C", // informational, optional
"read_at": "2026-04-19T13:12:05Z" // optional; defaults to now
}
Or a batch form:
{
"token": "<shared secret>", // alternative to X-FP-IOT-Token
"readings": [
{"device_serial": "...", "value": ..., "read_at": "..."},
...
]
}
Returns 200 + `{ok: true, accepted: N}` on success, 401 on auth fail,
404 if any device_serial isn't mapped to a fp.tank.sensor.
"""
import hmac
import json
import logging
from datetime import datetime, timezone
from odoo import http
from odoo.http import request, Response
_logger = logging.getLogger(__name__)
def _parse_read_at(raw):
"""Best-effort ISO-8601 parse — fall back to 'now' on garbage input."""
from odoo.fields import Datetime as OdooDatetime
if not raw:
return OdooDatetime.now()
try:
# Accept both "2026-04-19T13:12:05Z" and "2026-04-19 13:12:05"
s = raw.replace('Z', '+00:00')
dt = datetime.fromisoformat(s)
# Strip tz to store naive UTC, which is what Odoo Datetime fields store
if dt.tzinfo is not None:
dt = dt.astimezone(timezone.utc).replace(tzinfo=None)
return dt
except Exception:
return OdooDatetime.now()
class FpIotIngestController(http.Controller):
@http.route('/fp/iot/ingest', type='http', auth='public',
methods=['POST'], csrf=False, save_session=False)
def ingest(self, **_kwargs):
"""Accept one-or-many sensor readings and land them in fp.tank.reading."""
# Pull the shared secret from config — configured at install via
# data/ir_config_parameter_data.xml, but admins can rotate it
# in Settings → Technical → System Parameters.
expected = request.env['ir.config_parameter'].sudo().get_param(
'fusion_plating_iot.ingest_token', ''
)
if not expected:
_logger.warning('fp.iot.ingest: token not configured — all requests rejected')
return Response(
json.dumps({'ok': False, 'error': 'token_not_configured'}),
status=503, content_type='application/json',
)
# Accept token via either header or payload body — some simple
# sensors can't easily set custom headers.
header_token = request.httprequest.headers.get('X-FP-IOT-Token', '')
raw = request.httprequest.get_data(as_text=True) or ''
try:
body = json.loads(raw) if raw else {}
except ValueError:
return Response(
json.dumps({'ok': False, 'error': 'invalid_json'}),
status=400, content_type='application/json',
)
body_token = body.get('token', '')
presented = header_token or body_token
if not hmac.compare_digest(str(presented), str(expected)):
return Response(
json.dumps({'ok': False, 'error': 'unauthorised'}),
status=401, content_type='application/json',
)
# Normalise payload to a list of readings.
readings = body.get('readings')
if readings is None:
# Single-reading shortcut
if 'device_serial' in body and 'value' in body:
readings = [body]
else:
return Response(
json.dumps({'ok': False, 'error': 'no_readings'}),
status=400, content_type='application/json',
)
Sensor = request.env['fp.tank.sensor'].sudo()
Reading = request.env['fp.tank.reading'].sudo()
accepted = 0
unknown_serials = []
for r in readings:
serial = (r.get('device_serial') or '').strip()
if not serial:
continue
sensor = Sensor.search([('device_serial', '=', serial)], limit=1)
if not sensor:
unknown_serials.append(serial)
continue
try:
value = float(r.get('value'))
except (TypeError, ValueError):
continue
Reading.create({
'sensor_id': sensor.id,
'value': value,
'reading_at': _parse_read_at(r.get('read_at')),
'source': 'http_ingest',
})
accepted += 1
status = 200 if accepted else (404 if unknown_serials else 400)
payload = {
'ok': accepted > 0,
'accepted': accepted,
}
if unknown_serials:
payload['unknown_serials'] = unknown_serials
return Response(
json.dumps(payload),
status=status, content_type='application/json',
)