Files
Odoo-Modules/fusion_iot/iot/iot_handlers/interfaces/TIMInterface.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

109 lines
4.3 KiB
Python

# Part of Odoo. See LICENSE file for full copyright and licensing details.
import ctypes
import os
import logging
from pathlib import Path
import subprocess
from odoo.addons.iot_drivers.interface import Interface
from odoo.addons.iot_drivers.tools.system import IS_WINDOWS
from odoo.addons.iot_drivers.tools import helpers
from odoo.tools.misc import file_path
from odoo.addons.iot_drivers.iot_handlers.lib.ctypes_terminal_driver import import_ctypes_library, CTYPES_BUFFER_SIZE
_logger = logging.getLogger(__name__)
if IS_WINDOWS:
LIB_PATH = Path('odoo/addons/iot_drivers/iot_handlers/lib')
DOWNLOAD_URL = '' # Disabled -- community repackage
else:
LIB_PATH = file_path('iot_drivers/iot_handlers/lib')
DOWNLOAD_URL = '' # Disabled -- community repackage
# Download and unzip timapi library, overwriting the existing one
TIMAPI_ZIP_PATH = f'{LIB_PATH}/tim.zip'
helpers.download_from_url(DOWNLOAD_URL, TIMAPI_ZIP_PATH)
helpers.unzip_file(TIMAPI_ZIP_PATH, f'{LIB_PATH}/tim')
# Make TIM SDK dependency libraries visible for the linker
if IS_WINDOWS:
LIB_PATH = file_path('iot_drivers/iot_handlers/lib')
os.environ['PATH'] = file_path('iot_drivers/iot_handlers/lib/tim') + os.pathsep + os.environ['PATH']
else:
TIMAPI_DEPENDANCY_LIB = 'libtimapi.so.3'
TIMAPI_DEPENDANCY_LIB_V = f'{TIMAPI_DEPENDANCY_LIB}.38.0-5308'
DEP_LIB_PATH = file_path('iot_drivers/iot_handlers/lib/tim')
USR_LIB_PATH = '/usr/lib'
try:
subprocess.call([f'sudo cp {DEP_LIB_PATH}/{TIMAPI_DEPENDANCY_LIB_V} {USR_LIB_PATH}'], shell=True)
subprocess.call([f'sudo ln -fs {USR_LIB_PATH}/{TIMAPI_DEPENDANCY_LIB_V} {USR_LIB_PATH}/{TIMAPI_DEPENDANCY_LIB}'], shell=True)
except subprocess.CalledProcessError as e:
_logger.error("Failed to link the TIM SDK dependent library: %s", e.output)
# Import Odoo Timapi Library
LIB_NAME = 'libsix_odoo_w.dll' if IS_WINDOWS else 'libsix_odoo_l.so'
TIMAPI = import_ctypes_library('tim', LIB_NAME)
# --- Setup library prototypes ---
# void *six_initialize_manager(int buffer_size) {
TIMAPI.six_initialize_manager.argtypes = [ctypes.c_int]
TIMAPI.six_initialize_manager.restype = ctypes.c_void_p
# int six_setup_terminal_settings(t_terminal_manager *terminal_manager, char *terminal_id);
TIMAPI.six_setup_terminal_settings.argtypes = [ctypes.c_void_p, ctypes.c_char_p]
# int six_terminal_connected(t_terminal_manager *terminal_manager);
TIMAPI.six_terminal_connected.argtypes = [ctypes.c_void_p]
class TIMInterface(Interface):
_loop_delay = 30
connection_type = 'tim'
def __init__(self):
super(TIMInterface, self).__init__()
try:
buffer_size = ctypes.c_int(CTYPES_BUFFER_SIZE)
self.manager = TIMAPI.six_initialize_manager(buffer_size)
except OSError:
_logger.exception("Failed to initalize TIM manager")
if not self.manager:
_logger.error('Failed to allocate memory for TIM Manager')
self.tid = None
def get_devices(self):
if not self.manager:
return {}
# As this code is fetched by the IoT Box from the DB, we can't be sure
# that the IoT Box has the new method `get_conf`.
# This try-except should be replaced by a simple call to `get_conf` in master
try:
new_tid = helpers.get_conf("six_payment_terminal")
except AttributeError:
_logger.warning("Failed to get the Six TID from the configuration file, trying to read it from the old file")
new_tid = helpers.read_file_first_line('odoo-six-payment-terminal.conf')
devices = {}
# If the Six TID setup has changed, reset the settings
if new_tid != self.tid:
self.tid = new_tid
encoded_tid = new_tid.encode() if new_tid else None
try:
if not TIMAPI.six_setup_terminal_settings(self.manager, encoded_tid):
return {}
except OSError:
_logger.exception("Failed to setup Six terminal settings")
return {}
# Check if the terminal is online and responsive
try:
if self.tid and TIMAPI.six_terminal_connected(self.manager):
devices[self.tid] = ctypes.cast(self.manager, ctypes.c_void_p)
except OSError:
_logger.exception("Failed to check if the Six terminal is connected")
return devices