From 5e954f238b6e9563dd78d5ded63a9e80404aeb91 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 11:52:38 -0400 Subject: [PATCH 01/21] feat(aux): add auxiliary relay settings defaults and get_aux_list helper --- common/common.py | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/common/common.py b/common/common.py index b5421b9a5..fd8b46dc5 100644 --- a/common/common.py +++ b/common/common.py @@ -231,12 +231,22 @@ def default_settings(): }, "outputs": { "auger": 14, + "aux1": None, + "aux2": None, + "aux3": None, + "aux4": None, "dc_fan": 26, "fan": 15, "igniter": 18, "power": 4, "pwm": 13 }, + "aux_labels": { + "aux1": "Aux 1", + "aux2": "Aux 2", + "aux3": "Aux 3", + "aux4": "Aux 4" + }, "system" : { "SPI0" : { "CE0" : 8, # In case a non-standard CE/CS is utilized @@ -2414,6 +2424,32 @@ def get_probe_info(probe_info): return probe_structure +AUX_OUTPUT_NAMES = ['aux1', 'aux2', 'aux3', 'aux4'] + +def get_aux_list(settings): + """ + Build the list of configured auxiliary relays. + + An auxiliary relay is considered configured when its pin in + settings['platform']['outputs'] is not None. Relays that are not + configured are omitted entirely, which is what hides them from every UI. + + :param settings: Settings dictionary + :return: List of dictionaries, i.e. [{'name' : 'aux1', 'label' : 'Work Light'}] + """ + aux_list = [] + outputs = settings['platform'].get('outputs', {}) + labels = settings['platform'].get('aux_labels', {}) + + for name in AUX_OUTPUT_NAMES: + if outputs.get(name, None) is not None: + aux_list.append({ + 'name' : name, + 'label' : labels.get(name, name) + }) + + return aux_list + def read_probe_status(probe_info): """ Creates a structured status report for all probes in the system by combining probe configuration From 687a89a45292771eda5dee2e17ef0342a6b54e61 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 11:57:27 -0400 Subject: [PATCH 02/21] feat(aux): add auxiliary relay support to the prototype platform --- grillplat/prototype.py | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/grillplat/prototype.py b/grillplat/prototype.py index 6532ee235..92d021036 100644 --- a/grillplat/prototype.py +++ b/grillplat/prototype.py @@ -49,6 +49,13 @@ def __init__(self, config): self.out_pins['power'] = False self.in_pins['selector'] = False + ''' Auxiliary relays - only those with a real pin assigned exist ''' + self.aux = {} + configured_outputs = config.get('outputs', {}) + for aux_name in ['aux1', 'aux2', 'aux3', 'aux4']: + if configured_outputs.get(aux_name, None) is not None: + self.aux[aux_name] = False + def auger_on(self): self.out_pins['auger'] = True @@ -96,6 +103,39 @@ def power_on(self): def power_off(self): self.out_pins['power'] = False + ''' Auxiliary relays cannot be energized without main power ''' + self._all_aux_off() + + def aux_names(self): + ''' Return the list of configured auxiliary relay names. ''' + return list(self.aux.keys()) + + def aux_on(self, name): + if name not in self.aux: + self.logger.debug(f'aux_on: Auxiliary relay [{name}] is not configured - ignoring.') + return + self.aux[name] = True + + def aux_off(self, name): + if name not in self.aux: + self.logger.debug(f'aux_off: Auxiliary relay [{name}] is not configured - ignoring.') + return + self.aux[name] = False + + def aux_toggle(self, name): + if name not in self.aux: + self.logger.debug(f'aux_toggle: Auxiliary relay [{name}] is not configured - ignoring.') + return + self.aux[name] = not self.aux[name] + + def get_aux_status(self, name): + ''' Return the state of an auxiliary relay, or None if it is not configured. ''' + return self.aux.get(name, None) + + def _all_aux_off(self): + ''' De-energize every auxiliary relay. Called whenever main power drops. ''' + for name in self.aux: + self.aux[name] = False def get_input_status(self): return (self.in_pins['selector']) @@ -109,6 +149,8 @@ def get_output_status(self): self.current['igniter'] = self.out_pins['igniter'] self.current['power'] = self.out_pins['power'] self.current['fan'] = self.out_pins['fan'] + for name in self.aux: + self.current[name] = self.aux[name] if self.dc_fan: self.current['pwm'] = 100 - (self.out_pins['pwm'] * 100) self.current['frequency'] = self.frequency From d8ea1ce77365eb45e81808a5dfabf695faa13ea3 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 12:03:30 -0400 Subject: [PATCH 03/21] feat(aux): add auxiliary relay support to the raspberry pi platform --- grillplat/raspberry_pi_all.py | 50 +++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/grillplat/raspberry_pi_all.py b/grillplat/raspberry_pi_all.py index d97240cea..7952ec57c 100644 --- a/grillplat/raspberry_pi_all.py +++ b/grillplat/raspberry_pi_all.py @@ -85,6 +85,13 @@ def __init__(self, config): self.igniter = OutputDevice(self.out_pins['igniter'], active_high=active_high, initial_value=False) self.power = OutputDevice(self.out_pins['power'], active_high=active_high, initial_value=False) + ''' Auxiliary relays - only those with a real pin assigned are constructed ''' + self.aux = {} + for aux_name in ['aux1', 'aux2', 'aux3', 'aux4']: + aux_pin = self.out_pins.get(aux_name, None) + if aux_pin is not None: + self.aux[aux_name] = OutputDevice(aux_pin, active_high=active_high, initial_value=False) + def auger_on(self): self.logger.debug('auger_on: Turning on auger') self.auger.on() @@ -147,6 +154,45 @@ def power_on(self): def power_off(self): self.logger.debug('power_off: Powering off grill platform') self.power.off() + ''' Auxiliary relays cannot be energized without main power ''' + self._all_aux_off() + + + def aux_names(self): + ''' Return the list of configured auxiliary relay names. ''' + return list(self.aux.keys()) + + def aux_on(self, name): + if name not in self.aux: + self.logger.debug(f'aux_on: Auxiliary relay [{name}] is not configured - ignoring.') + return + self.logger.debug(f'aux_on: Turning on auxiliary relay [{name}]') + self.aux[name].on() + + def aux_off(self, name): + if name not in self.aux: + self.logger.debug(f'aux_off: Auxiliary relay [{name}] is not configured - ignoring.') + return + self.logger.debug(f'aux_off: Turning off auxiliary relay [{name}]') + self.aux[name].off() + + def aux_toggle(self, name): + if name not in self.aux: + self.logger.debug(f'aux_toggle: Auxiliary relay [{name}] is not configured - ignoring.') + return + self.logger.debug(f'aux_toggle: Toggling auxiliary relay [{name}]') + self.aux[name].toggle() + + def get_aux_status(self, name): + ''' Return the state of an auxiliary relay, or None if it is not configured. ''' + if name not in self.aux: + return None + return self.aux[name].is_active + + def _all_aux_off(self): + ''' De-energize every auxiliary relay. Called whenever main power drops. ''' + for name in self.aux: + self.aux[name].off() def get_input_status(self): if self.in_pins['selector'] is not None and self.standalone == False: @@ -159,6 +205,8 @@ def get_output_status(self): self.current['igniter'] = self.igniter.is_active self.current['power'] = self.power.is_active self.current['fan'] = self.fan.is_active + for name in self.aux: + self.current[name] = self.aux[name].is_active if self.dc_fan: # self.logger.debug('get_output_status: self.current_fan_speed_percent = ' + str(self.current_fan_speed_percent)) # This is a little verbose, even for debug logging self.current['pwm'] = self.current_fan_speed_percent @@ -208,6 +256,8 @@ def cleanup(self): self.igniter.close() self.auger.close() self.fan.close() + for name in self.aux: + self.aux[name].close() self.pwm.stop() if self.selector is not None: self.selector.close() From bd8ebbe08226d5ce2131eb6800cf8d8ac78d8591 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 12:12:15 -0400 Subject: [PATCH 04/21] feat(aux): process auxiliary relay requests in the control script --- common/common.py | 2 ++ control.py | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/common/common.py b/common/common.py index fd8b46dc5..344e183e0 100644 --- a/common/common.py +++ b/common/common.py @@ -685,6 +685,8 @@ def default_control(): 'pwm' : 100 } + control['aux'] = {} # Pending auxiliary relay requests, i.e. {'aux1' : True}. Cleared once applied. + control['smartstart'] = { 'startuptemp' : 0, 'profile_selected' : 0 diff --git a/control.py b/control.py index f31de8766..4d0871618 100755 --- a/control.py +++ b/control.py @@ -148,6 +148,7 @@ DisplayModule = importlib.import_module(f'display.{display_name}') display_config = settings['display']['config'][display_name] display_config['probe_info'] = get_probe_info(settings['probe_settings']['probe_map']['probe_info']) + display_config['aux_info'] = get_aux_list(settings) disp_rotation = display_config.get('rotation', 0) except: @@ -302,6 +303,39 @@ def _process_system_commands(grill_platform): } system_output.push(result) +def _process_aux_requests(grill_platform): + """ + Apply any pending auxiliary relay requests. + + Auxiliary relays are user owned - the controller never drives them - so this is + deliberately NOT gated on Manual mode or settings['safety']['allow_manual_changes'], + and it does not participate in the manual_override timers. + + Requests are transient: they are cleared as soon as they have been applied, so that + Stop mode resetting the control structure cannot strand a stale desired state. + """ + control = read_control() + requests = control.get('aux', {}) + + if not requests: + return + + configured = grill_platform.aux_names() + + for name, state in requests.items(): + if name not in configured: + eventLogger.debug(f'Auxiliary relay [{name}] is not configured - ignoring request.') + continue + if state: + grill_platform.aux_on(name) + eventLogger.debug(f'Auxiliary Relay [{name}] ON') + else: + grill_platform.aux_off(name) + eventLogger.debug(f'Auxiliary Relay [{name}] OFF') + + control['aux'] = {} + write_control(control, direct_write=True, origin='control') + def _work_cycle(mode, grill_platform, probe_complex, display_device, dist_device): """ Work Cycle Function @@ -579,6 +613,7 @@ def _work_cycle(mode, grill_platform, probe_complex, display_device, dist_device control = read_control() _process_system_commands(grill_platform) + _process_aux_requests(grill_platform) # Check if new mode has been requested if control['updated']: @@ -1286,6 +1321,7 @@ def exit_handler(): # Check for system commands _process_system_commands(grill_platform) + _process_aux_requests(grill_platform) # Check if there were updates to any of the settings that were flagged if control['settings_update']: From ccad2ac353c577dbcddc833b410994e9f645c6db Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 12:24:23 -0400 Subject: [PATCH 05/21] feat(aux): add /api/set/aux endpoint for auxiliary relay control --- common/common.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/common/common.py b/common/common.py index 344e183e0..5d4edc0f1 100644 --- a/common/common.py +++ b/common/common.py @@ -3183,6 +3183,32 @@ def process_command(action=None, arglist=[], origin='unknown', direct_write=Fals data['result'] = 'ERROR' data['message'] = f'Before changing manual outputs, system must be put into Manual mode.' + elif arglist[0] == 'aux': + ''' + Auxiliary Relay Control + Note: Auxiliary relays are never driven by the controller, so unlike the manual + commands above, no mode change or safety override is required. + /api/set/aux/{aux1|aux2|aux3|aux4}/{true/false/toggle} + ''' + aux_names = [aux['name'] for aux in get_aux_list(settings)] + + if arglist[1] not in aux_names: + data['result'] = 'ERROR' + data['message'] = f'Auxiliary relay [{arglist[1]}] is not configured. Configured relays: {aux_names}' + else: + if arglist[2] == 'toggle': + status = read_status() + arglist[2] = 'false' if status['outpins'].get(arglist[1], False) else 'true' + + if arglist[2] in ['true', 'false']: + if control.get('aux', None) is None: + control['aux'] = {} + control['aux'][arglist[1]] = True if arglist[2] == 'true' else False + write_control(control, direct_write=direct_write, origin=origin) + else: + data['result'] = 'ERROR' + data['message'] = f'Auxiliary relay command [{arglist[2]}] not recognized. Use true, false or toggle.' + else: data['result'] = 'ERROR' data['message'] = f'Set API Argument: {arglist[0]} not recognized.' From 63706488b4e609b5e05899f5ed61e1507d33f99b Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 12:35:35 -0400 Subject: [PATCH 06/21] feat(aux): add auxiliary relay toggles to the default dashboard --- .../dash/static/default/js/dash_default.js | 32 +++++++++++++++++++ .../default/_macro_dash_default.html | 7 ++++ 2 files changed, 39 insertions(+) diff --git a/blueprints/dash/static/default/js/dash_default.js b/blueprints/dash/static/default/js/dash_default.js index 5e3dd2966..8016b9642 100644 --- a/blueprints/dash/static/default/js/dash_default.js +++ b/blueprints/dash/static/default/js/dash_default.js @@ -19,6 +19,8 @@ var probesReady = false; // Pre-initialized state var last_fan_status = null; var last_auger_status = null; var last_igniter_status = null; +var last_aux_status = {}; +var aux_labels = {}; var last_pmode_status = null; var last_lid_open_status = false; var last_probe_status = {}; @@ -337,6 +339,25 @@ function updateProbeCards() { }; }; + ['aux1', 'aux2', 'aux3', 'aux4'].forEach(function(aux_name) { + if (!(aux_name in current.status.outpins)) { + return; + } + if (current.status.outpins[aux_name] != last_aux_status[aux_name]) { + last_aux_status[aux_name] = current.status.outpins[aux_name]; + var element = document.getElementById(aux_name + '_status'); + if (element === null) { + return; + } + var label = aux_labels[aux_name] || aux_name; + if (last_aux_status[aux_name]) { + element.innerHTML = ''; + } else { + element.innerHTML = ''; + } + } + }); + if (current.status.p_mode != last_pmode_status) { last_pmode_status = current.status.p_mode; if (last_pmode_status == 0) { @@ -1116,6 +1137,17 @@ $(document).ready(function(){ dash_api_set('lid_open/toggle'); }); + ['aux1', 'aux2', 'aux3', 'aux4'].forEach(function(aux_name) { + var element = document.getElementById(aux_name + '_status'); + if (element === null) { + return; + } + aux_labels[aux_name] = element.querySelector('i').getAttribute('title').replace(/ (ON|OFF)$/, ''); + $('#' + aux_name + '_status').click(function() { + dash_api_set('aux/' + aux_name + '/toggle'); + }); + }); + // Initialize Dashboard Data dashGetData(); diff --git a/blueprints/dash/templates/default/_macro_dash_default.html b/blueprints/dash/templates/default/_macro_dash_default.html index 2f8d0595c..f0fab439a 100644 --- a/blueprints/dash/templates/default/_macro_dash_default.html +++ b/blueprints/dash/templates/default/_macro_dash_default.html @@ -389,6 +389,13 @@

  {{ probe_d   + {% for aux_name in ['aux1', 'aux2', 'aux3', 'aux4'] %} + {% if settings['platform']['outputs'].get(aux_name) is not none %} + +   + + {% endif %} + {% endfor %} From c56fa321e5915e3ed1e48aaa69dfbd72f6351b6f Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 13:23:30 -0400 Subject: [PATCH 07/21] feat(aux): add auxiliary relay toggles to the basic dashboard Mirrors Task 6's default-dashboard implementation: renders a plug icon and name badge per configured aux relay (aux1-aux4, hidden when unconfigured), tracks/updates their on/off state, and wires clicks to toggle via /api/set/aux//toggle. Required two additional fixes beyond the two in-scope files: - dash_basic.js has no dash_api_set helper; used the equivalent cp_api_set from static/js/control_panel.js instead. - render_status_card() never received settings, so referencing settings['platform'] inside it would have raised UndefinedError; added the parameter and updated its one call site in dash_basic.html. --- blueprints/dash/static/basic/js/dash_basic.js | 36 +++++++++++++++++-- .../templates/basic/_macro_dash_basic.html | 14 +++++++- .../dash/templates/basic/dash_basic.html | 2 +- 3 files changed, 48 insertions(+), 4 deletions(-) diff --git a/blueprints/dash/static/basic/js/dash_basic.js b/blueprints/dash/static/basic/js/dash_basic.js index 87c5dd770..7606a8374 100644 --- a/blueprints/dash/static/basic/js/dash_basic.js +++ b/blueprints/dash/static/basic/js/dash_basic.js @@ -15,6 +15,8 @@ var notify_status = {}; // store all notify statuses var last_fan_status = null; var last_auger_status = null; var last_igniter_status = null; +var last_aux_status = {}; +var aux_labels = {}; var last_pmode_status = null; var last_lid_open_status = false; var display_mode = null; @@ -231,6 +233,25 @@ function updateProbeCards() { }; }; + ['aux1', 'aux2', 'aux3', 'aux4'].forEach(function(aux_name) { + if (!(aux_name in current.status.outpins)) { + return; + } + if (current.status.outpins[aux_name] != last_aux_status[aux_name]) { + last_aux_status[aux_name] = current.status.outpins[aux_name]; + var element = document.getElementById(aux_name + '_status'); + if (element === null) { + return; + } + var label = aux_labels[aux_name] || aux_name; + if (last_aux_status[aux_name]) { + element.innerHTML = ''; + } else { + element.innerHTML = ''; + } + } + }); + if (current.status.p_mode != last_pmode_status) { last_pmode_status = current.status.p_mode; if (last_pmode_status == 0) { @@ -785,8 +806,19 @@ function dashClearErrorCounter() { $(document).ready(function(){ // Setup Listeners $('#reloadPage').click(function() { - // Reload page when server side changes detected. - location.reload(); + // Reload page when server side changes detected. + location.reload(); + }); + + ['aux1', 'aux2', 'aux3', 'aux4'].forEach(function(aux_name) { + var element = document.getElementById(aux_name + '_status'); + if (element === null) { + return; + } + aux_labels[aux_name] = element.querySelector('i').getAttribute('title').replace(/ (ON|OFF)$/, ''); + $('#' + aux_name + '_status').click(function() { + cp_api_set('aux/' + aux_name + '/toggle'); + }); }); // Initialize Dashboard Data diff --git a/blueprints/dash/templates/basic/_macro_dash_basic.html b/blueprints/dash/templates/basic/_macro_dash_basic.html index 10b3f301c..251ea58e6 100644 --- a/blueprints/dash/templates/basic/_macro_dash_basic.html +++ b/blueprints/dash/templates/basic/_macro_dash_basic.html @@ -313,7 +313,7 @@
Current:
{% endmacro %} -{% macro render_status_card() %} +{% macro render_status_card(settings) %}
  Status: Stop @@ -332,6 +332,13 @@
Current:
  + {% for aux_name in ['aux1', 'aux2', 'aux3', 'aux4'] %} + {% if settings['platform']['outputs'].get(aux_name) is not none %} + +   + + {% endif %} + {% endfor %} @@ -343,6 +350,11 @@
Current:
Fan Auger Igniter + {% for aux_name in ['aux1', 'aux2', 'aux3', 'aux4'] %} + {% if settings['platform']['outputs'].get(aux_name) is not none %} + {{ settings['platform']['aux_labels'].get(aux_name, aux_name) }} + {% endif %} + {% endfor %} P-Mode diff --git a/blueprints/dash/templates/basic/dash_basic.html b/blueprints/dash/templates/basic/dash_basic.html index 597683d0a..e862c9276 100644 --- a/blueprints/dash/templates/basic/dash_basic.html +++ b/blueprints/dash/templates/basic/dash_basic.html @@ -44,7 +44,7 @@ style="display:none" {% endif %}>
- {{ render_status_card() }} + {{ render_status_card(settings) }}
From ea5a2f3763bfe463c7e719f8afc40336b3c8b5e9 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 13:25:26 -0400 Subject: [PATCH 08/21] Ignore agent scratch directories .superpowers/sdd/ was only ignored by a nested .gitignore containing `*`, which ignored itself and so was untracked -- a `git clean -fdx` would remove it and leave the whole workspace committable. Cover it from the tracked root .gitignore instead, along with .serena/ and .worktrees/. Co-Authored-By: Claude Opus 5 (1M context) --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.gitignore b/.gitignore index 00e2d79fd..f395a3846 100755 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,11 @@ generated/ +# Agent scratch / tooling state - never commit +.superpowers/ +.serena/ +.worktrees/ + *.pyc control.err.log From 9a22e5209ff46323620f3c0c41343cd3168a3b2a Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 13:32:20 -0400 Subject: [PATCH 09/21] feat(aux): add auxiliary relay menu to the 800x480 touch displays --- display/base_flex.py | 46 ++++++++++++++++++++++++ display/dsi_800x480t.json | 64 +++++++++++++++++++++++++--------- display/protoflex_800x480.json | 64 +++++++++++++++++++++++++--------- 3 files changed, 142 insertions(+), 32 deletions(-) diff --git a/display/base_flex.py b/display/base_flex.py index c6095c2d2..eb743ad1d 100644 --- a/display/base_flex.py +++ b/display/base_flex.py @@ -109,6 +109,8 @@ def _init_framework(self): self._fixup_display_data() + self._configure_aux_menu() + self._init_assets() def _fixup_display_data(self): @@ -142,6 +144,41 @@ def _fixup_display_data(self): #print(f'Fixed Up: \n{self.display_data[self.display_profile]["menus"]}') + def _configure_aux_menu(self): + ''' + Populate the auxiliary relay menu from the configured relays, and remove the + menu entry point entirely when no relays are configured. + + Mirrors the food probe gauge treatment in _configure_dash: objects that have + no backing configuration are dropped rather than rendered empty. + ''' + menus = self.display_data[self.display_profile].get('menus', {}) + if 'aux' not in menus: + return + + aux_info = self.config.get('aux_info', []) + + if not aux_info: + ''' No auxiliary relays configured - remove the entry point from every main menu ''' + for menu_name, menu in menus.items(): + while 'menu_aux' in menu.get('button_list', []): + index = menu['button_list'].index('menu_aux') + menu['button_list'].pop(index) + menu['button_text'].pop(index) + return + + button_list = ['menu_close'] + button_text = ['Close Menu'] + for aux in aux_info: + button_list.append(f'aux_toggle_{aux["name"]}') + button_text.append(aux['label']) + button_list.append('menu_close') + button_text.append('Close') + + menus['aux']['button_list'] = button_list + menus['aux']['button_text'] = button_text + + def _init_display_device(self): ''' Inheriting classes will override this function to init the display device and start the display thread. @@ -852,6 +889,15 @@ def _command_handler(self): except: self.eventLogger.debug('Fan Toggle Failed.') + if 'aux_toggle_' in self.command: + aux_name = self.command.split('aux_toggle_')[-1] + try: + requests.get(f'http://127.0.0.1:5000/api/set/aux/{aux_name}/toggle') + except: + self.eventLogger.debug(f'Auxiliary Relay [{aux_name}] Toggle Failed.') + self.display_active = 'dash' + self.display_init = True + if 'lid_open' in self.command: try: requests.get('http://127.0.0.1:5000/api/set/lid_open/toggle') diff --git a/display/dsi_800x480t.json b/display/dsi_800x480t.json index 4b8ed9749..52c527768 100644 --- a/display/dsi_800x480t.json +++ b/display/dsi_800x480t.json @@ -371,8 +371,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "menu_prime", "menu_startup", "cmd_monitor", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Prime", "Startup", "Monitor", "System", "Close"], + "button_list" : ["menu_close", "menu_prime", "menu_startup", "cmd_monitor", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Prime", "Startup", "Monitor", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -387,8 +387,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_lid_open", "input_hold", "cmd_shutdown", "cmd_stop", "cmd_smoke", "cmd_splus", "menu_pmode", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Lid Open", "Hold", "Shutdown", "Stop", "Smoke", "Smoke+", "PMode", "System", "Close"], + "button_list" : ["menu_close", "cmd_lid_open", "input_hold", "cmd_shutdown", "cmd_stop", "cmd_smoke", "cmd_splus", "menu_pmode", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Lid Open", "Hold", "Shutdown", "Stop", "Smoke", "Smoke+", "PMode", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -403,8 +403,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_stop", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Stop", "System", "Close"], + "button_list" : ["menu_close", "cmd_stop", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Stop", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -419,8 +419,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_next_step", "cmd_shutdown", "cmd_stop", "cmd_splus", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Next Step", "Shutdown", "Stop", "Smoke+", "System", "Close"], + "button_list" : ["menu_close", "cmd_next_step", "cmd_shutdown", "cmd_stop", "cmd_splus", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Next Step", "Shutdown", "Stop", "Smoke+", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -584,6 +584,22 @@ "button_text" : ["Close Menu", "OK"], "button_value" : [], "touch_areas" : [] + }, + "aux" : { + "type" : "menu", + "position" : [100, 40], + "animation_enabled" : false, + "size" : [600, 400], + "glow" : false, + "font" : "trebuc.ttf", + "label" : "aux_menu", + "title_text" : "Auxiliary", + "color" : [255,255,255,255], + "data" : {}, + "button_list" : ["menu_close"], + "button_text" : ["Close Menu"], + "button_value" : [], + "touch_areas" : [] } }, "input" : { @@ -971,8 +987,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "menu_prime", "menu_startup", "cmd_monitor", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Prime", "Startup", "Monitor", "System", "Close"], + "button_list" : ["menu_close", "menu_prime", "menu_startup", "cmd_monitor", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Prime", "Startup", "Monitor", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -987,8 +1003,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_lid_open", "input_hold", "cmd_shutdown", "cmd_stop", "cmd_smoke", "cmd_splus", "menu_pmode", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Lid Open", "Hold", "Shutdown", "Stop", "Smoke", "Smoke+", "PMode", "System", "Close"], + "button_list" : ["menu_close", "cmd_lid_open", "input_hold", "cmd_shutdown", "cmd_stop", "cmd_smoke", "cmd_splus", "menu_pmode", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Lid Open", "Hold", "Shutdown", "Stop", "Smoke", "Smoke+", "PMode", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -1003,8 +1019,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_stop", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Stop", "System", "Close"], + "button_list" : ["menu_close", "cmd_stop", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Stop", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -1019,8 +1035,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_next_step", "cmd_shutdown", "cmd_stop", "cmd_splus", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Next Step", "Shutdown", "Stop", "Smoke+", "System", "Close"], + "button_list" : ["menu_close", "cmd_next_step", "cmd_shutdown", "cmd_stop", "cmd_splus", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Next Step", "Shutdown", "Stop", "Smoke+", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -1184,6 +1200,22 @@ "button_text" : ["Close Menu", "OK"], "button_value" : [], "touch_areas" : [] + }, + "aux" : { + "type" : "menu", + "position" : [20, 40], + "animation_enabled" : false, + "size" : [440, 320], + "glow" : false, + "font" : "trebuc.ttf", + "label" : "aux_menu", + "title_text" : "Auxiliary", + "color" : [255,255,255,255], + "data" : {}, + "button_list" : ["menu_close"], + "button_text" : ["Close Menu"], + "button_value" : [], + "touch_areas" : [] } }, "input" : { diff --git a/display/protoflex_800x480.json b/display/protoflex_800x480.json index 894385cfe..4415efefa 100644 --- a/display/protoflex_800x480.json +++ b/display/protoflex_800x480.json @@ -371,8 +371,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "menu_prime", "menu_startup", "cmd_monitor", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Prime", "Startup", "Monitor", "System", "Close"], + "button_list" : ["menu_close", "menu_prime", "menu_startup", "cmd_monitor", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Prime", "Startup", "Monitor", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -387,8 +387,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_lid_open", "input_hold", "cmd_shutdown", "cmd_stop", "cmd_smoke", "cmd_splus", "menu_pmode", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Lid Open", "Hold", "Shutdown", "Stop", "Smoke", "Smoke+", "PMode", "System", "Close"], + "button_list" : ["menu_close", "cmd_lid_open", "input_hold", "cmd_shutdown", "cmd_stop", "cmd_smoke", "cmd_splus", "menu_pmode", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Lid Open", "Hold", "Shutdown", "Stop", "Smoke", "Smoke+", "PMode", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -403,8 +403,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_stop", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Stop", "System", "Close"], + "button_list" : ["menu_close", "cmd_stop", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Stop", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -419,8 +419,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_next_step", "cmd_shutdown", "cmd_stop", "cmd_splus", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Next Step", "Shutdown", "Stop", "Smoke+", "System", "Close"], + "button_list" : ["menu_close", "cmd_next_step", "cmd_shutdown", "cmd_stop", "cmd_splus", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Next Step", "Shutdown", "Stop", "Smoke+", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -584,6 +584,22 @@ "button_text" : ["Close Menu", "OK"], "button_value" : [], "touch_areas" : [] + }, + "aux" : { + "type" : "menu", + "position" : [100, 40], + "animation_enabled" : false, + "size" : [600, 400], + "glow" : false, + "font" : "trebuc.ttf", + "label" : "aux_menu", + "title_text" : "Auxiliary", + "color" : [255,255,255,255], + "data" : {}, + "button_list" : ["menu_close"], + "button_text" : ["Close Menu"], + "button_value" : [], + "touch_areas" : [] } }, "input" : { @@ -971,8 +987,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "menu_prime", "menu_startup", "cmd_monitor", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Prime", "Startup", "Monitor", "System", "Close"], + "button_list" : ["menu_close", "menu_prime", "menu_startup", "cmd_monitor", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Prime", "Startup", "Monitor", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -987,8 +1003,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_lid_open", "input_hold", "cmd_shutdown", "cmd_stop", "cmd_smoke", "cmd_splus", "menu_pmode", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Lid Open", "Hold", "Shutdown", "Stop", "Smoke", "Smoke+", "PMode", "System", "Close"], + "button_list" : ["menu_close", "cmd_lid_open", "input_hold", "cmd_shutdown", "cmd_stop", "cmd_smoke", "cmd_splus", "menu_pmode", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Lid Open", "Hold", "Shutdown", "Stop", "Smoke", "Smoke+", "PMode", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -1003,8 +1019,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_stop", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Stop", "System", "Close"], + "button_list" : ["menu_close", "cmd_stop", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Stop", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -1019,8 +1035,8 @@ "title_text" : "Main Menu", "color" : [255,255,255,255], "data" : {}, - "button_list" : ["menu_close", "cmd_next_step", "cmd_shutdown", "cmd_stop", "cmd_splus", "menu_system", "menu_close"], - "button_text" : ["Close Menu", "Next Step", "Shutdown", "Stop", "Smoke+", "System", "Close"], + "button_list" : ["menu_close", "cmd_next_step", "cmd_shutdown", "cmd_stop", "cmd_splus", "menu_system", "menu_aux", "menu_close"], + "button_text" : ["Close Menu", "Next Step", "Shutdown", "Stop", "Smoke+", "System", "Auxiliary", "Close"], "button_value" : [], "touch_areas" : [] }, @@ -1184,6 +1200,22 @@ "button_text" : ["Close Menu", "OK"], "button_value" : [], "touch_areas" : [] + }, + "aux" : { + "type" : "menu", + "position" : [20, 40], + "animation_enabled" : false, + "size" : [440, 320], + "glow" : false, + "font" : "trebuc.ttf", + "label" : "aux_menu", + "title_text" : "Auxiliary", + "color" : [255,255,255,255], + "data" : {}, + "button_list" : ["menu_close"], + "button_text" : ["Close Menu"], + "button_value" : [], + "touch_areas" : [] } }, "input" : { From 7a381dcfd8be5bda0f43188c7a67718ee24866c6 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 13:40:25 -0400 Subject: [PATCH 10/21] fix(aux): prefix aux relay toggle command with cmd_ so touch/ENTER dispatch reaches it _configure_aux_menu generated button names like aux_toggle_aux1, but both display/protoflex.py and display/dsi_800x480t.py only call _command_handler() when 'cmd_' is a substring of the selected button name (the ENTER-key path at line 334/355 and the touch path at line 393/429 in each file respectively). Every other actionable button in these layouts (cmd_fan_toggle, cmd_igniter_toggle, cmd_monitor, etc.) carries this prefix for exactly that reason; the aux toggle buttons did not, so they were unreachable from the touchscreen. _command_handler's substring match on 'aux_toggle_' and its aux_name extraction are unaffected since the prefix is additive. --- display/base_flex.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/display/base_flex.py b/display/base_flex.py index eb743ad1d..2ea0727af 100644 --- a/display/base_flex.py +++ b/display/base_flex.py @@ -170,7 +170,7 @@ def _configure_aux_menu(self): button_list = ['menu_close'] button_text = ['Close Menu'] for aux in aux_info: - button_list.append(f'aux_toggle_{aux["name"]}') + button_list.append(f'cmd_aux_toggle_{aux["name"]}') button_text.append(aux['label']) button_list.append('menu_close') button_text.append('Close') From 88ad761b0a5af6a52fd2b4217807c7aa615e2d03 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 13:45:48 -0400 Subject: [PATCH 11/21] feat(aux): publish auxiliary relay state over MQTT and the mobile API --- blueprints/mobile/socket_io.py | 3 +- notify/mqtt_handler.py | 950 +++++++++++++++++---------------- 2 files changed, 479 insertions(+), 474 deletions(-) diff --git a/blueprints/mobile/socket_io.py b/blueprints/mobile/socket_io.py index d3e4ee6f3..f0a2b6c03 100644 --- a/blueprints/mobile/socket_io.py +++ b/blueprints/mobile/socket_io.py @@ -214,7 +214,8 @@ def _get_dash_data(settings, pelletdb): 'outputs': { 'fan': status['outpins']['fan'], 'auger': status['outpins']['auger'], - 'igniter': status['outpins']['igniter'] + 'igniter': status['outpins']['igniter'], + 'aux': {aux['name']: status['outpins'].get(aux['name'], False) for aux in get_aux_list(settings)} }, 'recipeStatus': { 'recipeMode': status['recipe'], diff --git a/notify/mqtt_handler.py b/notify/mqtt_handler.py index aafaaaadd..09d2d2c2c 100644 --- a/notify/mqtt_handler.py +++ b/notify/mqtt_handler.py @@ -1,473 +1,477 @@ -#!/usr/bin/env python3 - -# ***************************************** -# PiFire Mqtt Interface Library -# ***************************************** -# -# Description: This library supports publishing data to an mqtt -# broker, including metadata for homeassistant -# sensor autodiscovery. -# -# Install Dependencies: -# -# sudo pip3 install paho-mqtt -# -# ***************************************** - -import paho.mqtt.client as mqtt -import json -import logging -import time -from socket import getfqdn -from common import create_logger -import psutil -#from common import write_control - - -class MqttNotificationHandler: - - def __init__(self, settings) -> None: - """ Initialize an mqtt client - Home Assistant mqtt sensor metadata: https://www.home-assistant.io/integrations/sensor.mqtt/ - Home Assistant auto-discovery description: https://www.home-assistant.io/integrations/mqtt/ - - Arguments: - settings: PiFire settings dict - """ - - try: - self.client = None # Initialize to none so we can check its existance later - self.initialized_topics = [] # Topics that have already sent auto-discover data - self.last = {} # Last published values so we can send by exception - self.last_mode = None # Last mode we were in - self.last_conn_time = 0 # Last time we tried to connect to the mqtt broker - self.subscriptions = [] # Topics we have subscribed to so we can be remotely controlled - self.control = None # Link to the control structure so we can send controls to the Control app - - # Keep track of the last time we published different types of MQTT data so that we can - # throttle our updates to the configured rate - self.pub_times = {'base': 0, 'pellet': 0, 'pid': 0} - self.pub_rate = float(settings['notify_services']['mqtt']['update_sec']) - - # Create shortcuts to settings we will use frequently - self._global_settings = settings['globals'] - self._probe_settings = settings['probe_settings']['probe_map']['probe_info'] - self._mqtt_settings = settings['notify_services']['mqtt'] - - # This lists contexts that will be published to mqtt - self.CONTEXTS = ['control','devices', - 'probe_data_primary','probe_data_food','probe_data_aux','probe_data_tr', - 'pid', 'pid_config','pid_cycle_data','pellet','notify_event','system'] - - # These list the devices aka attributes that will be published to mqtt - self.DEVICE_SENSORS = ['auger','igniter','power','fan','notify_event'] - self.CONTROL_SENSORS = ['mode','next_mode','s_plus','pwm_control','duty_cycle','status','primary_setpoint'] - self.PID_CONFIG_SENSORS = ['PB','Td','Ti','center'] - self.PID_CYCLE_TIME_SENSORS = ['HoldCycleTime','LidOpenPauseTime','LidOpenThreshold','PMode','SmokeCycleTime','u_max','u_min'] - self.PID_SENSORS = ['kp','ki','kd','p','i','d','u','error','derv','inter','inter_max','cycle_ratio'] - self.HOPPER_SENSORS = ['hopper_level'] - self.CONTROL_NOTIFY_SENSORS = ['target'] - #self.LAST_NOTIFICATION = ['msg'] - self.SYSTEM_SENSORS = ['cpu','available_memory','free_memory','cpu_temp'] - - # Setup logging - log_level = logging.DEBUG if settings['globals']['debug_mode'] else logging.INFO - self._mqttLogger = create_logger('mqtt', filename='./logs/mqtt.log', level=log_level, - messageformat='%(asctime)s | %(levelname)s | %(thread)s | %(message)s') - - # Default payload for setting up home assistant auto discovery messagage. - self.discovery_topic = self._mqtt_settings['homeassistant_autodiscovery_topic'] - self.pifire_id = self._mqtt_settings['id'] - grill_name = "PiFire" if len(self._global_settings['grill_name']) == 0 else self._global_settings['grill_name'] - self.default_payload = { - 'availability': [{ - 'topic': f"{self.pifire_id}/availability", - }], - 'availability_mode': 'all', - 'device': { - 'identifiers': [ self.pifire_id ], - 'manufacturer': "PiFire", - 'model': settings['modules']['grillplat'], - 'name': grill_name, - 'configuration_url': f"http://{getfqdn()}:5000/settings" - }, - 'enabled_by_default': True, - } - - # Connect to the broker - self._check_connection() - - except: - self._mqttLogger.exception(f'Error initializing the mqtt class object: ') - - def __del__(self): - try: - self._publish_data(topic=f"{self._mqtt_settings['id']}/availability",payload="offline") - self.client.loop_stop() - self.client.disconnect() - except: - self._mqttLogger.exception(f'Error occurred closing mqtt client: ') - - def _connect(self): - try: - settings = self._mqtt_settings - - # Initialize our client if not already intialized - if self.client == None: - - # Future: may want to make these configurable - self.client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION1, transport='tcp', protocol=mqtt.MQTTv5) - self.client.on_connect = self._on_connect - self.client.on_disconnect = self._on_disconnect - self.client.on_connect_fail = self._on_connect_fail - self.client.on_message = self._on_message - self.client.will_set(topic=f"{settings['id']}/availability",payload="offline") - - if len(settings['username']) > 0: - self.client.username_pw_set(settings['username'], settings['password']) - - # Future: may want to support tls - #self.client.tls_set( certfile=None, keyfile=None, cert_reqs=None) - - ret = self.client.connect(host=settings['broker'], port=int(settings['port']), - keepalive=10) - - if ret == mqtt.MQTT_ERR_SUCCESS: - self.client.loop_start() #Will run async forever, monitoring mqtt and sending keepalives - else: - self._mqttLogger.error(f"Error {mqtt.connack_string(ret)} connecting to {settings['broker']}.") - self.client = None - except: - self._mqttLogger.exception(f'Error occurred connecting to the mqtt broker: ') - - def _on_connect(self, client, userdata, flags, rc, properties): - self._mqttLogger.info(f"Connection to '{self._mqtt_settings['broker']}' returned result: '{mqtt.connack_string(rc)}'") - self.last_conn_time = 0 - self._publish_data(topic=f"{self._mqtt_settings['id']}/availability",payload="online", qos=1) - - # Restore any subscriptions that we have - for sub in self.subscriptions: - self._subscribe(sub) - - def _on_message(self, client, userdata, msg): - - # Ignore if we haven't finished intializing or haven't enabled control - #if self.control == None: return - #if self._mqtt_settings['control'] == False: return - - # element = msg.topic.split('/')[-1] - # payload = msg.payload.decode('utf-8') - - # self._mqttLogger.debug(f"Recieved message {payload} for {element}") - - # if element == "mode": - # # If going into Hold mode we need to set the setpoint as well. Default to 150 if not set. - # if payload == 'Hold': - # self.control['primary_setpoint'] = max(self.control['primary_setpoint'], 150) - - # self.control[element] = payload - # self.control['updated'] = 'yes' - # write_control(self.control, direct_write=False, origin='mqtt') - - # #TODO when switching to HOLD mode we also need to send a setpoint - - # elif element == "primary_setpoint": - # #Only adjust the setpoint if we are in Hold mode - # if (self.control['mode']) == 'Hold': - # self.control[element] = int(payload) - # self.control['updated'] = 'yes' - # write_control(self.control, direct_write=False, origin='mqtt') - - # else: - # pass - pass - - def _on_disconnect(self, client, userdata, rc, properties): - if rc != 0: - self._mqttLogger.error(f"Disconnect returned result: {mqtt.connack_string(rc)}") - else: - self._mqttLogger.info(f"Disconnect returned result: {mqtt.connack_string(rc)}") - - def _on_connect_fail(self, client, userdata, rc): - self._mqttLogger.error(f"Connection failure: {mqtt.connack_string(rc)}") - - def _check_connection(self): - - # Connection process is async, so give it some time - if time.time() < self.last_conn_time + 5: return False - - # Connect if not already connected - if self.client is None or not self.client.is_connected(): - self._mqttLogger.error(f"Need to connect to the broker") - self._connect() - self.last_conn_time = time.time() - - return self.client.is_connected() - - def _check_homeassistant(self): - return len(self._mqtt_settings['homeassistant_autodiscovery_topic']) > 0 - - def _publish_data(self, topic, payload, qos=0, retain=False, properties=None): - - if not self._check_connection(): - return False - - ret= self.client.publish(topic, payload, qos, retain, properties) - - # Check the return - if ret.rc == mqtt.MQTT_ERR_SUCCESS: - return True - elif ret.rc == mqtt.MQTT_ERR_CONN_LOST: - self._mqttLogger.error(f"Cannot publish data for {topic} because the mqtt connection is lost.") - return False - elif ret.rc == mqtt.MQTT_ERR_AUTH: - self._mqttLogger.error(f"Cannot publish data for {topic} because of error {mqtt.connack_string(ret.rc)}") - self.client = None - else: - self._mqttLogger.error(f"Cannot publish data for {topic} because of error {mqtt.connack_string(ret.rc)}") - return False - - def _publish_autodiscover(self, category, topic, payload, qos=2, retain=True, properties=None): - - ret= self.client.publish(topic, payload, qos, retain, properties) - - # Check the return - if ret.rc == mqtt.MQTT_ERR_SUCCESS: - if not category in self.initialized_topics: - self.initialized_topics.append(category) - elif ret.rc == mqtt.MQTT_ERR_CONN_LOST: - self._mqttLogger.error(f"Cannot publish autodiscover data for {topic} because the mqtt connection is lost.") - else: - self._mqttLogger.error(f"Cannot publish autodiscover data for {topic} because of error {mqtt.connack_string(ret.rc)}") - - def _publish(self, context, data): - - # Extract the supported attributes and verify there is a change - change_detected = False - payload = {} - for device in data: - if (context == 'devices' and device in self.DEVICE_SENSORS) or \ - (context == 'control' and device in self.CONTROL_SENSORS) or \ - (context == 'pid_config' and device in self.PID_CONFIG_SENSORS) or \ - (context == 'pid_cycle_data' and device in self.PID_CYCLE_TIME_SENSORS) or \ - (context == 'pellet') and device in self.HOPPER_SENSORS or \ - (context == 'pid' and device in self.PID_SENSORS) or \ - (context == 'notify_event') or \ - (context == 'system') or \ - (context.startswith('control_notify_data') and device in self.CONTROL_NOTIFY_SENSORS) or \ - (context.startswith("probe_data")): - - device_name = context + '_' + device - last_val = self.last.get(device_name) - payload[device] = data[device] - new_val = data[device] - if new_val != last_val: - change_detected = True - self.last[device_name] = new_val - - if not change_detected: return - - if self._publish_data(topic=f"{self._mqtt_settings['id']}/{context}", payload=json.dumps(payload)): - - # Publish home assitant auto-discovery info - if self._check_homeassistant: - self._create_autodiscover(context, data) - - def _subscribe(self,topic): - self.client.subscribe(topic) - if topic not in self.subscriptions: - self.subscriptions.append(topic) - - def _create_autodiscover(self, context, data): - for device in data: - device_name = context + '_' + device - topic_name = device_name - if device_name in self.last: - if not device_name in set(self.initialized_topics): - - discovery = self.default_payload.copy() - discovery['state_topic'] = f"{self.pifire_id}/{context}" - discovery['object_id'] = f"{self.pifire_id}_{device_name}".lower() - discovery['unique_id'] = f"{self.pifire_id}_{device_name}".lower() - discovery['value_template'] = f"{{{{ value_json.{device} }}}}" - discovery['name'] = device.title().replace('_',' ') - - datatype = type(data[device]) - - if datatype == bool: - component = "binary_sensor" - discovery['payload_on'] = True - discovery['payload_off'] = False - - if device not in {'auger','igniter','power','fan'}: - discovery['enabled_by_default'] = False - - elif datatype == str: - component = "sensor" - - elif datatype == int or datatype == float: - component = "sensor" - discovery['state_class'] = "measurement" - - if context in ['probe_data_primary', 'probe_data_food','probe_data_aux']: - discovery['device_class'] = "temperature" - discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" - suffix = 'Temp' - - elif context == 'probe_data_tr': - discovery['unit_of_measurement'] = "ohms" - discovery['enabled_by_default'] = False - discovery['entity_category'] = "diagnostic" - suffix = 'RTD Ohms' - - elif context.startswith('probe_data'): - # Find this probes name in the settings - for probe in self._probe_settings: - if probe['label'] == device: - discovery['name'] = f"{discovery['name']} {suffix}" - topic_name = context + '_' + probe['port'] - break - - elif context.startswith('control_notify'): - discovery['device_class'] = "temperature" - discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" - suffix = 'Target' - for probe in self._probe_settings: - if probe['label'] == data['label']: - discovery['name'] = f"{data['name']} {suffix}" - topic_name = context - break - - elif context.startswith('pid'): - discovery['entity_category'] = "diagnostic" - discovery['enabled_by_default'] = False - - if device in ['u_min','u_max','center','p','i','d','u','cycle_ratio']: - discovery['unit_of_measurement'] = "%" - discovery['enabled_by_default'] = False - discovery['value_template'] = f"{{{{ value_json.{device} | round(2)}}}}" - - elif device in ['available_memory', 'free_memory']: - discovery['unit_of_measurement'] = "b" - - elif device in ['duty_cycle', 'hopper_level','cpu']: - discovery['unit_of_measurement'] = "%" - - elif device in ['PB', 'Td', 'Ti', 'HoldCycleTime', 'LidOpenPauseTime']: - discovery['unit_of_measurement'] = "s" - discovery['enabled_by_default'] = False - - elif device == 'cpu_temp': - discovery['device_class'] = "temperature" - discovery['unit_of_measurement'] = "°C" - - elif device in ['primary_setpoint']: - discovery['device_class'] = "temperature" - discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" - - #if self._mqtt_settings['control']: - #component = "number" - - # Make setpoint subscribeable and subscribe to it - #discovery['command_topic'] = f"{discovery['state_topic']}/set/{device}" - #discovery['min'] = 100 - #discovery['max'] = 700 - #discovery['mode'] = 'auto' - #discovery['optimistic'] = 'false' - #discovery['step'] = 1 - #self._subscribe(discovery['command_topic']) - - self._publish_autodiscover( - device, - f"{self.discovery_topic}/{component}/{self.pifire_id}/{topic_name}/config", - json.dumps(discovery)) - - self.initialized_topics.append(device_name) - - def notify(self, context: str, data: dict): - """ Publish changed data to the mqtt broker - - Parameters: - context (str): Description of the data (devices, probes, control, cycle) - data (dict): Key-value pairs of data to publish - """ - try: - # Split out nested dictionaries - for key in data: - if key == 'notify_data': - for device in data[key]: - #new_context = context + '_' + key + '_' + device['label'] - for probe in self._probe_settings: - if probe['label'] == device['label']: - new_context = context + '_' + key + '_' + probe['port'] - break - self.notify(new_context, device ) - elif isinstance(data[key], dict): - new_context = context + '_' + key - self.notify(new_context, data[key]) - - # Save the latest control info - if context == 'control' and self.control == None: - self.control = data - - # Get system info if requested - if context == 'system': - data = {} - data['cpu'] = psutil.cpu_percent(interval=None) - data['available_memory'] = psutil.virtual_memory().available - data['free_memory'] = psutil.virtual_memory().free - if 'sensors_temperatures' in dir(psutil): - # This is for raspberry PI. Other hardware may be different - temps = psutil.sensors_temperatures() - if 'cpu_thermal' in temps: - cpu_temps = temps['cpu_thermal'] - data['cpu_temp'] = cpu_temps[0].current - - # Publish the data we are interested in - if context in self.CONTEXTS or context.startswith('control_notify_data'): - self._publish(context, data) - - # Check to see if we have changed operating mode - if context != 'control' or data['mode'] == self.last_mode: return - - new_mode = data['mode'] - - # Update the message state if we moved to a more advanced state (ignore Stop and Error) - # all modes ['Stop','Recipe','Error','Reignite','Monitor','Prime','Startup','Smoke','Hold','Shutdown','Manual'] - #if new_mode in ['Recipe', 'Reignite','Monitor','Prime','Startup','Smoke','Hold','Shutdown','Manual']: - payload = {'msg': f"Entered {new_mode} mode" } - self.notify("notify_event", payload) - - self.last_mode = data['mode'] - - # Zero the PID data if not controlling - if data['mode'] not in ['Hold']: - payload = {} - for key in self.PID_SENSORS: - payload[key] = 0 - self._publish('pid', payload) - - # Zero the temps if stopped - if data['mode'] == "Stop": - primary_data = {} - food_data = {} - aux_data = {} - tr_data = {} - for probe in self._probe_settings: - if probe['type'] == 'Food': - food_data[probe['label']] = 0 - elif probe['type'] == 'Primary': - primary_data[probe['label']] = 0 - elif probe['type'] == 'aux': - aux_data[probe['label']] = 0 - else: - pass - - tr_data[probe['label']] = 0 - self._publish('probe_data_primary', primary_data) - self._publish('probe_data_food', food_data) - self._publish('probe_data_aux', aux_data) - self._publish('probe_data_tr', tr_data) - - except: - self._mqttLogger.exception(f'Error occurred publishing device data: ') +#!/usr/bin/env python3 + +# ***************************************** +# PiFire Mqtt Interface Library +# ***************************************** +# +# Description: This library supports publishing data to an mqtt +# broker, including metadata for homeassistant +# sensor autodiscovery. +# +# Install Dependencies: +# +# sudo pip3 install paho-mqtt +# +# ***************************************** + +import paho.mqtt.client as mqtt +import json +import logging +import time +from socket import getfqdn +from common import create_logger, get_aux_list +import psutil +#from common import write_control + + +class MqttNotificationHandler: + + def __init__(self, settings) -> None: + """ Initialize an mqtt client + Home Assistant mqtt sensor metadata: https://www.home-assistant.io/integrations/sensor.mqtt/ + Home Assistant auto-discovery description: https://www.home-assistant.io/integrations/mqtt/ + + Arguments: + settings: PiFire settings dict + """ + + try: + self.client = None # Initialize to none so we can check its existance later + self.initialized_topics = [] # Topics that have already sent auto-discover data + self.last = {} # Last published values so we can send by exception + self.last_mode = None # Last mode we were in + self.last_conn_time = 0 # Last time we tried to connect to the mqtt broker + self.subscriptions = [] # Topics we have subscribed to so we can be remotely controlled + self.control = None # Link to the control structure so we can send controls to the Control app + + # Keep track of the last time we published different types of MQTT data so that we can + # throttle our updates to the configured rate + self.pub_times = {'base': 0, 'pellet': 0, 'pid': 0} + self.pub_rate = float(settings['notify_services']['mqtt']['update_sec']) + + # Create shortcuts to settings we will use frequently + self._global_settings = settings['globals'] + self._probe_settings = settings['probe_settings']['probe_map']['probe_info'] + self._mqtt_settings = settings['notify_services']['mqtt'] + + # This lists contexts that will be published to mqtt + self.CONTEXTS = ['control','devices', + 'probe_data_primary','probe_data_food','probe_data_aux','probe_data_tr', + 'pid', 'pid_config','pid_cycle_data','pellet','notify_event','system'] + + # These list the devices aka attributes that will be published to mqtt + self.DEVICE_SENSORS = ['auger','igniter','power','fan','notify_event'] + ''' Auxiliary relays are published alongside the fixed outputs when configured ''' + aux_list = get_aux_list(settings) + self._aux_names = set(aux['name'] for aux in aux_list) + self.DEVICE_SENSORS += [aux['name'] for aux in aux_list] + self.CONTROL_SENSORS = ['mode','next_mode','s_plus','pwm_control','duty_cycle','status','primary_setpoint'] + self.PID_CONFIG_SENSORS = ['PB','Td','Ti','center'] + self.PID_CYCLE_TIME_SENSORS = ['HoldCycleTime','LidOpenPauseTime','LidOpenThreshold','PMode','SmokeCycleTime','u_max','u_min'] + self.PID_SENSORS = ['kp','ki','kd','p','i','d','u','error','derv','inter','inter_max','cycle_ratio'] + self.HOPPER_SENSORS = ['hopper_level'] + self.CONTROL_NOTIFY_SENSORS = ['target'] + #self.LAST_NOTIFICATION = ['msg'] + self.SYSTEM_SENSORS = ['cpu','available_memory','free_memory','cpu_temp'] + + # Setup logging + log_level = logging.DEBUG if settings['globals']['debug_mode'] else logging.INFO + self._mqttLogger = create_logger('mqtt', filename='./logs/mqtt.log', level=log_level, + messageformat='%(asctime)s | %(levelname)s | %(thread)s | %(message)s') + + # Default payload for setting up home assistant auto discovery messagage. + self.discovery_topic = self._mqtt_settings['homeassistant_autodiscovery_topic'] + self.pifire_id = self._mqtt_settings['id'] + grill_name = "PiFire" if len(self._global_settings['grill_name']) == 0 else self._global_settings['grill_name'] + self.default_payload = { + 'availability': [{ + 'topic': f"{self.pifire_id}/availability", + }], + 'availability_mode': 'all', + 'device': { + 'identifiers': [ self.pifire_id ], + 'manufacturer': "PiFire", + 'model': settings['modules']['grillplat'], + 'name': grill_name, + 'configuration_url': f"http://{getfqdn()}:5000/settings" + }, + 'enabled_by_default': True, + } + + # Connect to the broker + self._check_connection() + + except: + self._mqttLogger.exception(f'Error initializing the mqtt class object: ') + + def __del__(self): + try: + self._publish_data(topic=f"{self._mqtt_settings['id']}/availability",payload="offline") + self.client.loop_stop() + self.client.disconnect() + except: + self._mqttLogger.exception(f'Error occurred closing mqtt client: ') + + def _connect(self): + try: + settings = self._mqtt_settings + + # Initialize our client if not already intialized + if self.client == None: + + # Future: may want to make these configurable + self.client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION1, transport='tcp', protocol=mqtt.MQTTv5) + self.client.on_connect = self._on_connect + self.client.on_disconnect = self._on_disconnect + self.client.on_connect_fail = self._on_connect_fail + self.client.on_message = self._on_message + self.client.will_set(topic=f"{settings['id']}/availability",payload="offline") + + if len(settings['username']) > 0: + self.client.username_pw_set(settings['username'], settings['password']) + + # Future: may want to support tls + #self.client.tls_set( certfile=None, keyfile=None, cert_reqs=None) + + ret = self.client.connect(host=settings['broker'], port=int(settings['port']), + keepalive=10) + + if ret == mqtt.MQTT_ERR_SUCCESS: + self.client.loop_start() #Will run async forever, monitoring mqtt and sending keepalives + else: + self._mqttLogger.error(f"Error {mqtt.connack_string(ret)} connecting to {settings['broker']}.") + self.client = None + except: + self._mqttLogger.exception(f'Error occurred connecting to the mqtt broker: ') + + def _on_connect(self, client, userdata, flags, rc, properties): + self._mqttLogger.info(f"Connection to '{self._mqtt_settings['broker']}' returned result: '{mqtt.connack_string(rc)}'") + self.last_conn_time = 0 + self._publish_data(topic=f"{self._mqtt_settings['id']}/availability",payload="online", qos=1) + + # Restore any subscriptions that we have + for sub in self.subscriptions: + self._subscribe(sub) + + def _on_message(self, client, userdata, msg): + + # Ignore if we haven't finished intializing or haven't enabled control + #if self.control == None: return + #if self._mqtt_settings['control'] == False: return + + # element = msg.topic.split('/')[-1] + # payload = msg.payload.decode('utf-8') + + # self._mqttLogger.debug(f"Recieved message {payload} for {element}") + + # if element == "mode": + # # If going into Hold mode we need to set the setpoint as well. Default to 150 if not set. + # if payload == 'Hold': + # self.control['primary_setpoint'] = max(self.control['primary_setpoint'], 150) + + # self.control[element] = payload + # self.control['updated'] = 'yes' + # write_control(self.control, direct_write=False, origin='mqtt') + + # #TODO when switching to HOLD mode we also need to send a setpoint + + # elif element == "primary_setpoint": + # #Only adjust the setpoint if we are in Hold mode + # if (self.control['mode']) == 'Hold': + # self.control[element] = int(payload) + # self.control['updated'] = 'yes' + # write_control(self.control, direct_write=False, origin='mqtt') + + # else: + # pass + pass + + def _on_disconnect(self, client, userdata, rc, properties): + if rc != 0: + self._mqttLogger.error(f"Disconnect returned result: {mqtt.connack_string(rc)}") + else: + self._mqttLogger.info(f"Disconnect returned result: {mqtt.connack_string(rc)}") + + def _on_connect_fail(self, client, userdata, rc): + self._mqttLogger.error(f"Connection failure: {mqtt.connack_string(rc)}") + + def _check_connection(self): + + # Connection process is async, so give it some time + if time.time() < self.last_conn_time + 5: return False + + # Connect if not already connected + if self.client is None or not self.client.is_connected(): + self._mqttLogger.error(f"Need to connect to the broker") + self._connect() + self.last_conn_time = time.time() + + return self.client.is_connected() + + def _check_homeassistant(self): + return len(self._mqtt_settings['homeassistant_autodiscovery_topic']) > 0 + + def _publish_data(self, topic, payload, qos=0, retain=False, properties=None): + + if not self._check_connection(): + return False + + ret= self.client.publish(topic, payload, qos, retain, properties) + + # Check the return + if ret.rc == mqtt.MQTT_ERR_SUCCESS: + return True + elif ret.rc == mqtt.MQTT_ERR_CONN_LOST: + self._mqttLogger.error(f"Cannot publish data for {topic} because the mqtt connection is lost.") + return False + elif ret.rc == mqtt.MQTT_ERR_AUTH: + self._mqttLogger.error(f"Cannot publish data for {topic} because of error {mqtt.connack_string(ret.rc)}") + self.client = None + else: + self._mqttLogger.error(f"Cannot publish data for {topic} because of error {mqtt.connack_string(ret.rc)}") + return False + + def _publish_autodiscover(self, category, topic, payload, qos=2, retain=True, properties=None): + + ret= self.client.publish(topic, payload, qos, retain, properties) + + # Check the return + if ret.rc == mqtt.MQTT_ERR_SUCCESS: + if not category in self.initialized_topics: + self.initialized_topics.append(category) + elif ret.rc == mqtt.MQTT_ERR_CONN_LOST: + self._mqttLogger.error(f"Cannot publish autodiscover data for {topic} because the mqtt connection is lost.") + else: + self._mqttLogger.error(f"Cannot publish autodiscover data for {topic} because of error {mqtt.connack_string(ret.rc)}") + + def _publish(self, context, data): + + # Extract the supported attributes and verify there is a change + change_detected = False + payload = {} + for device in data: + if (context == 'devices' and device in self.DEVICE_SENSORS) or \ + (context == 'control' and device in self.CONTROL_SENSORS) or \ + (context == 'pid_config' and device in self.PID_CONFIG_SENSORS) or \ + (context == 'pid_cycle_data' and device in self.PID_CYCLE_TIME_SENSORS) or \ + (context == 'pellet') and device in self.HOPPER_SENSORS or \ + (context == 'pid' and device in self.PID_SENSORS) or \ + (context == 'notify_event') or \ + (context == 'system') or \ + (context.startswith('control_notify_data') and device in self.CONTROL_NOTIFY_SENSORS) or \ + (context.startswith("probe_data")): + + device_name = context + '_' + device + last_val = self.last.get(device_name) + payload[device] = data[device] + new_val = data[device] + if new_val != last_val: + change_detected = True + self.last[device_name] = new_val + + if not change_detected: return + + if self._publish_data(topic=f"{self._mqtt_settings['id']}/{context}", payload=json.dumps(payload)): + + # Publish home assitant auto-discovery info + if self._check_homeassistant: + self._create_autodiscover(context, data) + + def _subscribe(self,topic): + self.client.subscribe(topic) + if topic not in self.subscriptions: + self.subscriptions.append(topic) + + def _create_autodiscover(self, context, data): + for device in data: + device_name = context + '_' + device + topic_name = device_name + if device_name in self.last: + if not device_name in set(self.initialized_topics): + + discovery = self.default_payload.copy() + discovery['state_topic'] = f"{self.pifire_id}/{context}" + discovery['object_id'] = f"{self.pifire_id}_{device_name}".lower() + discovery['unique_id'] = f"{self.pifire_id}_{device_name}".lower() + discovery['value_template'] = f"{{{{ value_json.{device} }}}}" + discovery['name'] = device.title().replace('_',' ') + + datatype = type(data[device]) + + if datatype == bool: + component = "binary_sensor" + discovery['payload_on'] = True + discovery['payload_off'] = False + + if device not in set(['auger','igniter','power','fan']) | self._aux_names: + discovery['enabled_by_default'] = False + + elif datatype == str: + component = "sensor" + + elif datatype == int or datatype == float: + component = "sensor" + discovery['state_class'] = "measurement" + + if context in ['probe_data_primary', 'probe_data_food','probe_data_aux']: + discovery['device_class'] = "temperature" + discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" + suffix = 'Temp' + + elif context == 'probe_data_tr': + discovery['unit_of_measurement'] = "ohms" + discovery['enabled_by_default'] = False + discovery['entity_category'] = "diagnostic" + suffix = 'RTD Ohms' + + elif context.startswith('probe_data'): + # Find this probes name in the settings + for probe in self._probe_settings: + if probe['label'] == device: + discovery['name'] = f"{discovery['name']} {suffix}" + topic_name = context + '_' + probe['port'] + break + + elif context.startswith('control_notify'): + discovery['device_class'] = "temperature" + discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" + suffix = 'Target' + for probe in self._probe_settings: + if probe['label'] == data['label']: + discovery['name'] = f"{data['name']} {suffix}" + topic_name = context + break + + elif context.startswith('pid'): + discovery['entity_category'] = "diagnostic" + discovery['enabled_by_default'] = False + + if device in ['u_min','u_max','center','p','i','d','u','cycle_ratio']: + discovery['unit_of_measurement'] = "%" + discovery['enabled_by_default'] = False + discovery['value_template'] = f"{{{{ value_json.{device} | round(2)}}}}" + + elif device in ['available_memory', 'free_memory']: + discovery['unit_of_measurement'] = "b" + + elif device in ['duty_cycle', 'hopper_level','cpu']: + discovery['unit_of_measurement'] = "%" + + elif device in ['PB', 'Td', 'Ti', 'HoldCycleTime', 'LidOpenPauseTime']: + discovery['unit_of_measurement'] = "s" + discovery['enabled_by_default'] = False + + elif device == 'cpu_temp': + discovery['device_class'] = "temperature" + discovery['unit_of_measurement'] = "°C" + + elif device in ['primary_setpoint']: + discovery['device_class'] = "temperature" + discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" + + #if self._mqtt_settings['control']: + #component = "number" + + # Make setpoint subscribeable and subscribe to it + #discovery['command_topic'] = f"{discovery['state_topic']}/set/{device}" + #discovery['min'] = 100 + #discovery['max'] = 700 + #discovery['mode'] = 'auto' + #discovery['optimistic'] = 'false' + #discovery['step'] = 1 + #self._subscribe(discovery['command_topic']) + + self._publish_autodiscover( + device, + f"{self.discovery_topic}/{component}/{self.pifire_id}/{topic_name}/config", + json.dumps(discovery)) + + self.initialized_topics.append(device_name) + + def notify(self, context: str, data: dict): + """ Publish changed data to the mqtt broker + + Parameters: + context (str): Description of the data (devices, probes, control, cycle) + data (dict): Key-value pairs of data to publish + """ + try: + # Split out nested dictionaries + for key in data: + if key == 'notify_data': + for device in data[key]: + #new_context = context + '_' + key + '_' + device['label'] + for probe in self._probe_settings: + if probe['label'] == device['label']: + new_context = context + '_' + key + '_' + probe['port'] + break + self.notify(new_context, device ) + elif isinstance(data[key], dict): + new_context = context + '_' + key + self.notify(new_context, data[key]) + + # Save the latest control info + if context == 'control' and self.control == None: + self.control = data + + # Get system info if requested + if context == 'system': + data = {} + data['cpu'] = psutil.cpu_percent(interval=None) + data['available_memory'] = psutil.virtual_memory().available + data['free_memory'] = psutil.virtual_memory().free + if 'sensors_temperatures' in dir(psutil): + # This is for raspberry PI. Other hardware may be different + temps = psutil.sensors_temperatures() + if 'cpu_thermal' in temps: + cpu_temps = temps['cpu_thermal'] + data['cpu_temp'] = cpu_temps[0].current + + # Publish the data we are interested in + if context in self.CONTEXTS or context.startswith('control_notify_data'): + self._publish(context, data) + + # Check to see if we have changed operating mode + if context != 'control' or data['mode'] == self.last_mode: return + + new_mode = data['mode'] + + # Update the message state if we moved to a more advanced state (ignore Stop and Error) + # all modes ['Stop','Recipe','Error','Reignite','Monitor','Prime','Startup','Smoke','Hold','Shutdown','Manual'] + #if new_mode in ['Recipe', 'Reignite','Monitor','Prime','Startup','Smoke','Hold','Shutdown','Manual']: + payload = {'msg': f"Entered {new_mode} mode" } + self.notify("notify_event", payload) + + self.last_mode = data['mode'] + + # Zero the PID data if not controlling + if data['mode'] not in ['Hold']: + payload = {} + for key in self.PID_SENSORS: + payload[key] = 0 + self._publish('pid', payload) + + # Zero the temps if stopped + if data['mode'] == "Stop": + primary_data = {} + food_data = {} + aux_data = {} + tr_data = {} + for probe in self._probe_settings: + if probe['type'] == 'Food': + food_data[probe['label']] = 0 + elif probe['type'] == 'Primary': + primary_data[probe['label']] = 0 + elif probe['type'] == 'aux': + aux_data[probe['label']] = 0 + else: + pass + + tr_data[probe['label']] = 0 + self._publish('probe_data_primary', primary_data) + self._publish('probe_data_food', food_data) + self._publish('probe_data_aux', aux_data) + self._publish('probe_data_tr', tr_data) + + except: + self._mqttLogger.exception(f'Error occurred publishing device data: ') From 22c83a9e957a5b2c30cf6150d5d6886c66ecb157 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 13:46:49 -0400 Subject: [PATCH 12/21] fix(aux): restore CRLF line endings in mqtt_handler.py The previous commit's edit tool normalized the whole file to LF, turning a 4-line functional change into a 950-line diff. Restore the file's original CRLF line endings; no functional change. --- notify/mqtt_handler.py | 954 ++++++++++++++++++++--------------------- 1 file changed, 477 insertions(+), 477 deletions(-) diff --git a/notify/mqtt_handler.py b/notify/mqtt_handler.py index 09d2d2c2c..db5ff2fe9 100644 --- a/notify/mqtt_handler.py +++ b/notify/mqtt_handler.py @@ -1,477 +1,477 @@ -#!/usr/bin/env python3 - -# ***************************************** -# PiFire Mqtt Interface Library -# ***************************************** -# -# Description: This library supports publishing data to an mqtt -# broker, including metadata for homeassistant -# sensor autodiscovery. -# -# Install Dependencies: -# -# sudo pip3 install paho-mqtt -# -# ***************************************** - -import paho.mqtt.client as mqtt -import json -import logging -import time -from socket import getfqdn -from common import create_logger, get_aux_list -import psutil -#from common import write_control - - -class MqttNotificationHandler: - - def __init__(self, settings) -> None: - """ Initialize an mqtt client - Home Assistant mqtt sensor metadata: https://www.home-assistant.io/integrations/sensor.mqtt/ - Home Assistant auto-discovery description: https://www.home-assistant.io/integrations/mqtt/ - - Arguments: - settings: PiFire settings dict - """ - - try: - self.client = None # Initialize to none so we can check its existance later - self.initialized_topics = [] # Topics that have already sent auto-discover data - self.last = {} # Last published values so we can send by exception - self.last_mode = None # Last mode we were in - self.last_conn_time = 0 # Last time we tried to connect to the mqtt broker - self.subscriptions = [] # Topics we have subscribed to so we can be remotely controlled - self.control = None # Link to the control structure so we can send controls to the Control app - - # Keep track of the last time we published different types of MQTT data so that we can - # throttle our updates to the configured rate - self.pub_times = {'base': 0, 'pellet': 0, 'pid': 0} - self.pub_rate = float(settings['notify_services']['mqtt']['update_sec']) - - # Create shortcuts to settings we will use frequently - self._global_settings = settings['globals'] - self._probe_settings = settings['probe_settings']['probe_map']['probe_info'] - self._mqtt_settings = settings['notify_services']['mqtt'] - - # This lists contexts that will be published to mqtt - self.CONTEXTS = ['control','devices', - 'probe_data_primary','probe_data_food','probe_data_aux','probe_data_tr', - 'pid', 'pid_config','pid_cycle_data','pellet','notify_event','system'] - - # These list the devices aka attributes that will be published to mqtt - self.DEVICE_SENSORS = ['auger','igniter','power','fan','notify_event'] - ''' Auxiliary relays are published alongside the fixed outputs when configured ''' - aux_list = get_aux_list(settings) - self._aux_names = set(aux['name'] for aux in aux_list) - self.DEVICE_SENSORS += [aux['name'] for aux in aux_list] - self.CONTROL_SENSORS = ['mode','next_mode','s_plus','pwm_control','duty_cycle','status','primary_setpoint'] - self.PID_CONFIG_SENSORS = ['PB','Td','Ti','center'] - self.PID_CYCLE_TIME_SENSORS = ['HoldCycleTime','LidOpenPauseTime','LidOpenThreshold','PMode','SmokeCycleTime','u_max','u_min'] - self.PID_SENSORS = ['kp','ki','kd','p','i','d','u','error','derv','inter','inter_max','cycle_ratio'] - self.HOPPER_SENSORS = ['hopper_level'] - self.CONTROL_NOTIFY_SENSORS = ['target'] - #self.LAST_NOTIFICATION = ['msg'] - self.SYSTEM_SENSORS = ['cpu','available_memory','free_memory','cpu_temp'] - - # Setup logging - log_level = logging.DEBUG if settings['globals']['debug_mode'] else logging.INFO - self._mqttLogger = create_logger('mqtt', filename='./logs/mqtt.log', level=log_level, - messageformat='%(asctime)s | %(levelname)s | %(thread)s | %(message)s') - - # Default payload for setting up home assistant auto discovery messagage. - self.discovery_topic = self._mqtt_settings['homeassistant_autodiscovery_topic'] - self.pifire_id = self._mqtt_settings['id'] - grill_name = "PiFire" if len(self._global_settings['grill_name']) == 0 else self._global_settings['grill_name'] - self.default_payload = { - 'availability': [{ - 'topic': f"{self.pifire_id}/availability", - }], - 'availability_mode': 'all', - 'device': { - 'identifiers': [ self.pifire_id ], - 'manufacturer': "PiFire", - 'model': settings['modules']['grillplat'], - 'name': grill_name, - 'configuration_url': f"http://{getfqdn()}:5000/settings" - }, - 'enabled_by_default': True, - } - - # Connect to the broker - self._check_connection() - - except: - self._mqttLogger.exception(f'Error initializing the mqtt class object: ') - - def __del__(self): - try: - self._publish_data(topic=f"{self._mqtt_settings['id']}/availability",payload="offline") - self.client.loop_stop() - self.client.disconnect() - except: - self._mqttLogger.exception(f'Error occurred closing mqtt client: ') - - def _connect(self): - try: - settings = self._mqtt_settings - - # Initialize our client if not already intialized - if self.client == None: - - # Future: may want to make these configurable - self.client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION1, transport='tcp', protocol=mqtt.MQTTv5) - self.client.on_connect = self._on_connect - self.client.on_disconnect = self._on_disconnect - self.client.on_connect_fail = self._on_connect_fail - self.client.on_message = self._on_message - self.client.will_set(topic=f"{settings['id']}/availability",payload="offline") - - if len(settings['username']) > 0: - self.client.username_pw_set(settings['username'], settings['password']) - - # Future: may want to support tls - #self.client.tls_set( certfile=None, keyfile=None, cert_reqs=None) - - ret = self.client.connect(host=settings['broker'], port=int(settings['port']), - keepalive=10) - - if ret == mqtt.MQTT_ERR_SUCCESS: - self.client.loop_start() #Will run async forever, monitoring mqtt and sending keepalives - else: - self._mqttLogger.error(f"Error {mqtt.connack_string(ret)} connecting to {settings['broker']}.") - self.client = None - except: - self._mqttLogger.exception(f'Error occurred connecting to the mqtt broker: ') - - def _on_connect(self, client, userdata, flags, rc, properties): - self._mqttLogger.info(f"Connection to '{self._mqtt_settings['broker']}' returned result: '{mqtt.connack_string(rc)}'") - self.last_conn_time = 0 - self._publish_data(topic=f"{self._mqtt_settings['id']}/availability",payload="online", qos=1) - - # Restore any subscriptions that we have - for sub in self.subscriptions: - self._subscribe(sub) - - def _on_message(self, client, userdata, msg): - - # Ignore if we haven't finished intializing or haven't enabled control - #if self.control == None: return - #if self._mqtt_settings['control'] == False: return - - # element = msg.topic.split('/')[-1] - # payload = msg.payload.decode('utf-8') - - # self._mqttLogger.debug(f"Recieved message {payload} for {element}") - - # if element == "mode": - # # If going into Hold mode we need to set the setpoint as well. Default to 150 if not set. - # if payload == 'Hold': - # self.control['primary_setpoint'] = max(self.control['primary_setpoint'], 150) - - # self.control[element] = payload - # self.control['updated'] = 'yes' - # write_control(self.control, direct_write=False, origin='mqtt') - - # #TODO when switching to HOLD mode we also need to send a setpoint - - # elif element == "primary_setpoint": - # #Only adjust the setpoint if we are in Hold mode - # if (self.control['mode']) == 'Hold': - # self.control[element] = int(payload) - # self.control['updated'] = 'yes' - # write_control(self.control, direct_write=False, origin='mqtt') - - # else: - # pass - pass - - def _on_disconnect(self, client, userdata, rc, properties): - if rc != 0: - self._mqttLogger.error(f"Disconnect returned result: {mqtt.connack_string(rc)}") - else: - self._mqttLogger.info(f"Disconnect returned result: {mqtt.connack_string(rc)}") - - def _on_connect_fail(self, client, userdata, rc): - self._mqttLogger.error(f"Connection failure: {mqtt.connack_string(rc)}") - - def _check_connection(self): - - # Connection process is async, so give it some time - if time.time() < self.last_conn_time + 5: return False - - # Connect if not already connected - if self.client is None or not self.client.is_connected(): - self._mqttLogger.error(f"Need to connect to the broker") - self._connect() - self.last_conn_time = time.time() - - return self.client.is_connected() - - def _check_homeassistant(self): - return len(self._mqtt_settings['homeassistant_autodiscovery_topic']) > 0 - - def _publish_data(self, topic, payload, qos=0, retain=False, properties=None): - - if not self._check_connection(): - return False - - ret= self.client.publish(topic, payload, qos, retain, properties) - - # Check the return - if ret.rc == mqtt.MQTT_ERR_SUCCESS: - return True - elif ret.rc == mqtt.MQTT_ERR_CONN_LOST: - self._mqttLogger.error(f"Cannot publish data for {topic} because the mqtt connection is lost.") - return False - elif ret.rc == mqtt.MQTT_ERR_AUTH: - self._mqttLogger.error(f"Cannot publish data for {topic} because of error {mqtt.connack_string(ret.rc)}") - self.client = None - else: - self._mqttLogger.error(f"Cannot publish data for {topic} because of error {mqtt.connack_string(ret.rc)}") - return False - - def _publish_autodiscover(self, category, topic, payload, qos=2, retain=True, properties=None): - - ret= self.client.publish(topic, payload, qos, retain, properties) - - # Check the return - if ret.rc == mqtt.MQTT_ERR_SUCCESS: - if not category in self.initialized_topics: - self.initialized_topics.append(category) - elif ret.rc == mqtt.MQTT_ERR_CONN_LOST: - self._mqttLogger.error(f"Cannot publish autodiscover data for {topic} because the mqtt connection is lost.") - else: - self._mqttLogger.error(f"Cannot publish autodiscover data for {topic} because of error {mqtt.connack_string(ret.rc)}") - - def _publish(self, context, data): - - # Extract the supported attributes and verify there is a change - change_detected = False - payload = {} - for device in data: - if (context == 'devices' and device in self.DEVICE_SENSORS) or \ - (context == 'control' and device in self.CONTROL_SENSORS) or \ - (context == 'pid_config' and device in self.PID_CONFIG_SENSORS) or \ - (context == 'pid_cycle_data' and device in self.PID_CYCLE_TIME_SENSORS) or \ - (context == 'pellet') and device in self.HOPPER_SENSORS or \ - (context == 'pid' and device in self.PID_SENSORS) or \ - (context == 'notify_event') or \ - (context == 'system') or \ - (context.startswith('control_notify_data') and device in self.CONTROL_NOTIFY_SENSORS) or \ - (context.startswith("probe_data")): - - device_name = context + '_' + device - last_val = self.last.get(device_name) - payload[device] = data[device] - new_val = data[device] - if new_val != last_val: - change_detected = True - self.last[device_name] = new_val - - if not change_detected: return - - if self._publish_data(topic=f"{self._mqtt_settings['id']}/{context}", payload=json.dumps(payload)): - - # Publish home assitant auto-discovery info - if self._check_homeassistant: - self._create_autodiscover(context, data) - - def _subscribe(self,topic): - self.client.subscribe(topic) - if topic not in self.subscriptions: - self.subscriptions.append(topic) - - def _create_autodiscover(self, context, data): - for device in data: - device_name = context + '_' + device - topic_name = device_name - if device_name in self.last: - if not device_name in set(self.initialized_topics): - - discovery = self.default_payload.copy() - discovery['state_topic'] = f"{self.pifire_id}/{context}" - discovery['object_id'] = f"{self.pifire_id}_{device_name}".lower() - discovery['unique_id'] = f"{self.pifire_id}_{device_name}".lower() - discovery['value_template'] = f"{{{{ value_json.{device} }}}}" - discovery['name'] = device.title().replace('_',' ') - - datatype = type(data[device]) - - if datatype == bool: - component = "binary_sensor" - discovery['payload_on'] = True - discovery['payload_off'] = False - - if device not in set(['auger','igniter','power','fan']) | self._aux_names: - discovery['enabled_by_default'] = False - - elif datatype == str: - component = "sensor" - - elif datatype == int or datatype == float: - component = "sensor" - discovery['state_class'] = "measurement" - - if context in ['probe_data_primary', 'probe_data_food','probe_data_aux']: - discovery['device_class'] = "temperature" - discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" - suffix = 'Temp' - - elif context == 'probe_data_tr': - discovery['unit_of_measurement'] = "ohms" - discovery['enabled_by_default'] = False - discovery['entity_category'] = "diagnostic" - suffix = 'RTD Ohms' - - elif context.startswith('probe_data'): - # Find this probes name in the settings - for probe in self._probe_settings: - if probe['label'] == device: - discovery['name'] = f"{discovery['name']} {suffix}" - topic_name = context + '_' + probe['port'] - break - - elif context.startswith('control_notify'): - discovery['device_class'] = "temperature" - discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" - suffix = 'Target' - for probe in self._probe_settings: - if probe['label'] == data['label']: - discovery['name'] = f"{data['name']} {suffix}" - topic_name = context - break - - elif context.startswith('pid'): - discovery['entity_category'] = "diagnostic" - discovery['enabled_by_default'] = False - - if device in ['u_min','u_max','center','p','i','d','u','cycle_ratio']: - discovery['unit_of_measurement'] = "%" - discovery['enabled_by_default'] = False - discovery['value_template'] = f"{{{{ value_json.{device} | round(2)}}}}" - - elif device in ['available_memory', 'free_memory']: - discovery['unit_of_measurement'] = "b" - - elif device in ['duty_cycle', 'hopper_level','cpu']: - discovery['unit_of_measurement'] = "%" - - elif device in ['PB', 'Td', 'Ti', 'HoldCycleTime', 'LidOpenPauseTime']: - discovery['unit_of_measurement'] = "s" - discovery['enabled_by_default'] = False - - elif device == 'cpu_temp': - discovery['device_class'] = "temperature" - discovery['unit_of_measurement'] = "°C" - - elif device in ['primary_setpoint']: - discovery['device_class'] = "temperature" - discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" - - #if self._mqtt_settings['control']: - #component = "number" - - # Make setpoint subscribeable and subscribe to it - #discovery['command_topic'] = f"{discovery['state_topic']}/set/{device}" - #discovery['min'] = 100 - #discovery['max'] = 700 - #discovery['mode'] = 'auto' - #discovery['optimistic'] = 'false' - #discovery['step'] = 1 - #self._subscribe(discovery['command_topic']) - - self._publish_autodiscover( - device, - f"{self.discovery_topic}/{component}/{self.pifire_id}/{topic_name}/config", - json.dumps(discovery)) - - self.initialized_topics.append(device_name) - - def notify(self, context: str, data: dict): - """ Publish changed data to the mqtt broker - - Parameters: - context (str): Description of the data (devices, probes, control, cycle) - data (dict): Key-value pairs of data to publish - """ - try: - # Split out nested dictionaries - for key in data: - if key == 'notify_data': - for device in data[key]: - #new_context = context + '_' + key + '_' + device['label'] - for probe in self._probe_settings: - if probe['label'] == device['label']: - new_context = context + '_' + key + '_' + probe['port'] - break - self.notify(new_context, device ) - elif isinstance(data[key], dict): - new_context = context + '_' + key - self.notify(new_context, data[key]) - - # Save the latest control info - if context == 'control' and self.control == None: - self.control = data - - # Get system info if requested - if context == 'system': - data = {} - data['cpu'] = psutil.cpu_percent(interval=None) - data['available_memory'] = psutil.virtual_memory().available - data['free_memory'] = psutil.virtual_memory().free - if 'sensors_temperatures' in dir(psutil): - # This is for raspberry PI. Other hardware may be different - temps = psutil.sensors_temperatures() - if 'cpu_thermal' in temps: - cpu_temps = temps['cpu_thermal'] - data['cpu_temp'] = cpu_temps[0].current - - # Publish the data we are interested in - if context in self.CONTEXTS or context.startswith('control_notify_data'): - self._publish(context, data) - - # Check to see if we have changed operating mode - if context != 'control' or data['mode'] == self.last_mode: return - - new_mode = data['mode'] - - # Update the message state if we moved to a more advanced state (ignore Stop and Error) - # all modes ['Stop','Recipe','Error','Reignite','Monitor','Prime','Startup','Smoke','Hold','Shutdown','Manual'] - #if new_mode in ['Recipe', 'Reignite','Monitor','Prime','Startup','Smoke','Hold','Shutdown','Manual']: - payload = {'msg': f"Entered {new_mode} mode" } - self.notify("notify_event", payload) - - self.last_mode = data['mode'] - - # Zero the PID data if not controlling - if data['mode'] not in ['Hold']: - payload = {} - for key in self.PID_SENSORS: - payload[key] = 0 - self._publish('pid', payload) - - # Zero the temps if stopped - if data['mode'] == "Stop": - primary_data = {} - food_data = {} - aux_data = {} - tr_data = {} - for probe in self._probe_settings: - if probe['type'] == 'Food': - food_data[probe['label']] = 0 - elif probe['type'] == 'Primary': - primary_data[probe['label']] = 0 - elif probe['type'] == 'aux': - aux_data[probe['label']] = 0 - else: - pass - - tr_data[probe['label']] = 0 - self._publish('probe_data_primary', primary_data) - self._publish('probe_data_food', food_data) - self._publish('probe_data_aux', aux_data) - self._publish('probe_data_tr', tr_data) - - except: - self._mqttLogger.exception(f'Error occurred publishing device data: ') +#!/usr/bin/env python3 + +# ***************************************** +# PiFire Mqtt Interface Library +# ***************************************** +# +# Description: This library supports publishing data to an mqtt +# broker, including metadata for homeassistant +# sensor autodiscovery. +# +# Install Dependencies: +# +# sudo pip3 install paho-mqtt +# +# ***************************************** + +import paho.mqtt.client as mqtt +import json +import logging +import time +from socket import getfqdn +from common import create_logger, get_aux_list +import psutil +#from common import write_control + + +class MqttNotificationHandler: + + def __init__(self, settings) -> None: + """ Initialize an mqtt client + Home Assistant mqtt sensor metadata: https://www.home-assistant.io/integrations/sensor.mqtt/ + Home Assistant auto-discovery description: https://www.home-assistant.io/integrations/mqtt/ + + Arguments: + settings: PiFire settings dict + """ + + try: + self.client = None # Initialize to none so we can check its existance later + self.initialized_topics = [] # Topics that have already sent auto-discover data + self.last = {} # Last published values so we can send by exception + self.last_mode = None # Last mode we were in + self.last_conn_time = 0 # Last time we tried to connect to the mqtt broker + self.subscriptions = [] # Topics we have subscribed to so we can be remotely controlled + self.control = None # Link to the control structure so we can send controls to the Control app + + # Keep track of the last time we published different types of MQTT data so that we can + # throttle our updates to the configured rate + self.pub_times = {'base': 0, 'pellet': 0, 'pid': 0} + self.pub_rate = float(settings['notify_services']['mqtt']['update_sec']) + + # Create shortcuts to settings we will use frequently + self._global_settings = settings['globals'] + self._probe_settings = settings['probe_settings']['probe_map']['probe_info'] + self._mqtt_settings = settings['notify_services']['mqtt'] + + # This lists contexts that will be published to mqtt + self.CONTEXTS = ['control','devices', + 'probe_data_primary','probe_data_food','probe_data_aux','probe_data_tr', + 'pid', 'pid_config','pid_cycle_data','pellet','notify_event','system'] + + # These list the devices aka attributes that will be published to mqtt + self.DEVICE_SENSORS = ['auger','igniter','power','fan','notify_event'] + ''' Auxiliary relays are published alongside the fixed outputs when configured ''' + aux_list = get_aux_list(settings) + self._aux_names = set(aux['name'] for aux in aux_list) + self.DEVICE_SENSORS += [aux['name'] for aux in aux_list] + self.CONTROL_SENSORS = ['mode','next_mode','s_plus','pwm_control','duty_cycle','status','primary_setpoint'] + self.PID_CONFIG_SENSORS = ['PB','Td','Ti','center'] + self.PID_CYCLE_TIME_SENSORS = ['HoldCycleTime','LidOpenPauseTime','LidOpenThreshold','PMode','SmokeCycleTime','u_max','u_min'] + self.PID_SENSORS = ['kp','ki','kd','p','i','d','u','error','derv','inter','inter_max','cycle_ratio'] + self.HOPPER_SENSORS = ['hopper_level'] + self.CONTROL_NOTIFY_SENSORS = ['target'] + #self.LAST_NOTIFICATION = ['msg'] + self.SYSTEM_SENSORS = ['cpu','available_memory','free_memory','cpu_temp'] + + # Setup logging + log_level = logging.DEBUG if settings['globals']['debug_mode'] else logging.INFO + self._mqttLogger = create_logger('mqtt', filename='./logs/mqtt.log', level=log_level, + messageformat='%(asctime)s | %(levelname)s | %(thread)s | %(message)s') + + # Default payload for setting up home assistant auto discovery messagage. + self.discovery_topic = self._mqtt_settings['homeassistant_autodiscovery_topic'] + self.pifire_id = self._mqtt_settings['id'] + grill_name = "PiFire" if len(self._global_settings['grill_name']) == 0 else self._global_settings['grill_name'] + self.default_payload = { + 'availability': [{ + 'topic': f"{self.pifire_id}/availability", + }], + 'availability_mode': 'all', + 'device': { + 'identifiers': [ self.pifire_id ], + 'manufacturer': "PiFire", + 'model': settings['modules']['grillplat'], + 'name': grill_name, + 'configuration_url': f"http://{getfqdn()}:5000/settings" + }, + 'enabled_by_default': True, + } + + # Connect to the broker + self._check_connection() + + except: + self._mqttLogger.exception(f'Error initializing the mqtt class object: ') + + def __del__(self): + try: + self._publish_data(topic=f"{self._mqtt_settings['id']}/availability",payload="offline") + self.client.loop_stop() + self.client.disconnect() + except: + self._mqttLogger.exception(f'Error occurred closing mqtt client: ') + + def _connect(self): + try: + settings = self._mqtt_settings + + # Initialize our client if not already intialized + if self.client == None: + + # Future: may want to make these configurable + self.client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION1, transport='tcp', protocol=mqtt.MQTTv5) + self.client.on_connect = self._on_connect + self.client.on_disconnect = self._on_disconnect + self.client.on_connect_fail = self._on_connect_fail + self.client.on_message = self._on_message + self.client.will_set(topic=f"{settings['id']}/availability",payload="offline") + + if len(settings['username']) > 0: + self.client.username_pw_set(settings['username'], settings['password']) + + # Future: may want to support tls + #self.client.tls_set( certfile=None, keyfile=None, cert_reqs=None) + + ret = self.client.connect(host=settings['broker'], port=int(settings['port']), + keepalive=10) + + if ret == mqtt.MQTT_ERR_SUCCESS: + self.client.loop_start() #Will run async forever, monitoring mqtt and sending keepalives + else: + self._mqttLogger.error(f"Error {mqtt.connack_string(ret)} connecting to {settings['broker']}.") + self.client = None + except: + self._mqttLogger.exception(f'Error occurred connecting to the mqtt broker: ') + + def _on_connect(self, client, userdata, flags, rc, properties): + self._mqttLogger.info(f"Connection to '{self._mqtt_settings['broker']}' returned result: '{mqtt.connack_string(rc)}'") + self.last_conn_time = 0 + self._publish_data(topic=f"{self._mqtt_settings['id']}/availability",payload="online", qos=1) + + # Restore any subscriptions that we have + for sub in self.subscriptions: + self._subscribe(sub) + + def _on_message(self, client, userdata, msg): + + # Ignore if we haven't finished intializing or haven't enabled control + #if self.control == None: return + #if self._mqtt_settings['control'] == False: return + + # element = msg.topic.split('/')[-1] + # payload = msg.payload.decode('utf-8') + + # self._mqttLogger.debug(f"Recieved message {payload} for {element}") + + # if element == "mode": + # # If going into Hold mode we need to set the setpoint as well. Default to 150 if not set. + # if payload == 'Hold': + # self.control['primary_setpoint'] = max(self.control['primary_setpoint'], 150) + + # self.control[element] = payload + # self.control['updated'] = 'yes' + # write_control(self.control, direct_write=False, origin='mqtt') + + # #TODO when switching to HOLD mode we also need to send a setpoint + + # elif element == "primary_setpoint": + # #Only adjust the setpoint if we are in Hold mode + # if (self.control['mode']) == 'Hold': + # self.control[element] = int(payload) + # self.control['updated'] = 'yes' + # write_control(self.control, direct_write=False, origin='mqtt') + + # else: + # pass + pass + + def _on_disconnect(self, client, userdata, rc, properties): + if rc != 0: + self._mqttLogger.error(f"Disconnect returned result: {mqtt.connack_string(rc)}") + else: + self._mqttLogger.info(f"Disconnect returned result: {mqtt.connack_string(rc)}") + + def _on_connect_fail(self, client, userdata, rc): + self._mqttLogger.error(f"Connection failure: {mqtt.connack_string(rc)}") + + def _check_connection(self): + + # Connection process is async, so give it some time + if time.time() < self.last_conn_time + 5: return False + + # Connect if not already connected + if self.client is None or not self.client.is_connected(): + self._mqttLogger.error(f"Need to connect to the broker") + self._connect() + self.last_conn_time = time.time() + + return self.client.is_connected() + + def _check_homeassistant(self): + return len(self._mqtt_settings['homeassistant_autodiscovery_topic']) > 0 + + def _publish_data(self, topic, payload, qos=0, retain=False, properties=None): + + if not self._check_connection(): + return False + + ret= self.client.publish(topic, payload, qos, retain, properties) + + # Check the return + if ret.rc == mqtt.MQTT_ERR_SUCCESS: + return True + elif ret.rc == mqtt.MQTT_ERR_CONN_LOST: + self._mqttLogger.error(f"Cannot publish data for {topic} because the mqtt connection is lost.") + return False + elif ret.rc == mqtt.MQTT_ERR_AUTH: + self._mqttLogger.error(f"Cannot publish data for {topic} because of error {mqtt.connack_string(ret.rc)}") + self.client = None + else: + self._mqttLogger.error(f"Cannot publish data for {topic} because of error {mqtt.connack_string(ret.rc)}") + return False + + def _publish_autodiscover(self, category, topic, payload, qos=2, retain=True, properties=None): + + ret= self.client.publish(topic, payload, qos, retain, properties) + + # Check the return + if ret.rc == mqtt.MQTT_ERR_SUCCESS: + if not category in self.initialized_topics: + self.initialized_topics.append(category) + elif ret.rc == mqtt.MQTT_ERR_CONN_LOST: + self._mqttLogger.error(f"Cannot publish autodiscover data for {topic} because the mqtt connection is lost.") + else: + self._mqttLogger.error(f"Cannot publish autodiscover data for {topic} because of error {mqtt.connack_string(ret.rc)}") + + def _publish(self, context, data): + + # Extract the supported attributes and verify there is a change + change_detected = False + payload = {} + for device in data: + if (context == 'devices' and device in self.DEVICE_SENSORS) or \ + (context == 'control' and device in self.CONTROL_SENSORS) or \ + (context == 'pid_config' and device in self.PID_CONFIG_SENSORS) or \ + (context == 'pid_cycle_data' and device in self.PID_CYCLE_TIME_SENSORS) or \ + (context == 'pellet') and device in self.HOPPER_SENSORS or \ + (context == 'pid' and device in self.PID_SENSORS) or \ + (context == 'notify_event') or \ + (context == 'system') or \ + (context.startswith('control_notify_data') and device in self.CONTROL_NOTIFY_SENSORS) or \ + (context.startswith("probe_data")): + + device_name = context + '_' + device + last_val = self.last.get(device_name) + payload[device] = data[device] + new_val = data[device] + if new_val != last_val: + change_detected = True + self.last[device_name] = new_val + + if not change_detected: return + + if self._publish_data(topic=f"{self._mqtt_settings['id']}/{context}", payload=json.dumps(payload)): + + # Publish home assitant auto-discovery info + if self._check_homeassistant: + self._create_autodiscover(context, data) + + def _subscribe(self,topic): + self.client.subscribe(topic) + if topic not in self.subscriptions: + self.subscriptions.append(topic) + + def _create_autodiscover(self, context, data): + for device in data: + device_name = context + '_' + device + topic_name = device_name + if device_name in self.last: + if not device_name in set(self.initialized_topics): + + discovery = self.default_payload.copy() + discovery['state_topic'] = f"{self.pifire_id}/{context}" + discovery['object_id'] = f"{self.pifire_id}_{device_name}".lower() + discovery['unique_id'] = f"{self.pifire_id}_{device_name}".lower() + discovery['value_template'] = f"{{{{ value_json.{device} }}}}" + discovery['name'] = device.title().replace('_',' ') + + datatype = type(data[device]) + + if datatype == bool: + component = "binary_sensor" + discovery['payload_on'] = True + discovery['payload_off'] = False + + if device not in set(['auger','igniter','power','fan']) | self._aux_names: + discovery['enabled_by_default'] = False + + elif datatype == str: + component = "sensor" + + elif datatype == int or datatype == float: + component = "sensor" + discovery['state_class'] = "measurement" + + if context in ['probe_data_primary', 'probe_data_food','probe_data_aux']: + discovery['device_class'] = "temperature" + discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" + suffix = 'Temp' + + elif context == 'probe_data_tr': + discovery['unit_of_measurement'] = "ohms" + discovery['enabled_by_default'] = False + discovery['entity_category'] = "diagnostic" + suffix = 'RTD Ohms' + + elif context.startswith('probe_data'): + # Find this probes name in the settings + for probe in self._probe_settings: + if probe['label'] == device: + discovery['name'] = f"{discovery['name']} {suffix}" + topic_name = context + '_' + probe['port'] + break + + elif context.startswith('control_notify'): + discovery['device_class'] = "temperature" + discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" + suffix = 'Target' + for probe in self._probe_settings: + if probe['label'] == data['label']: + discovery['name'] = f"{data['name']} {suffix}" + topic_name = context + break + + elif context.startswith('pid'): + discovery['entity_category'] = "diagnostic" + discovery['enabled_by_default'] = False + + if device in ['u_min','u_max','center','p','i','d','u','cycle_ratio']: + discovery['unit_of_measurement'] = "%" + discovery['enabled_by_default'] = False + discovery['value_template'] = f"{{{{ value_json.{device} | round(2)}}}}" + + elif device in ['available_memory', 'free_memory']: + discovery['unit_of_measurement'] = "b" + + elif device in ['duty_cycle', 'hopper_level','cpu']: + discovery['unit_of_measurement'] = "%" + + elif device in ['PB', 'Td', 'Ti', 'HoldCycleTime', 'LidOpenPauseTime']: + discovery['unit_of_measurement'] = "s" + discovery['enabled_by_default'] = False + + elif device == 'cpu_temp': + discovery['device_class'] = "temperature" + discovery['unit_of_measurement'] = "°C" + + elif device in ['primary_setpoint']: + discovery['device_class'] = "temperature" + discovery['unit_of_measurement'] = f"°{self._global_settings['units']}" + + #if self._mqtt_settings['control']: + #component = "number" + + # Make setpoint subscribeable and subscribe to it + #discovery['command_topic'] = f"{discovery['state_topic']}/set/{device}" + #discovery['min'] = 100 + #discovery['max'] = 700 + #discovery['mode'] = 'auto' + #discovery['optimistic'] = 'false' + #discovery['step'] = 1 + #self._subscribe(discovery['command_topic']) + + self._publish_autodiscover( + device, + f"{self.discovery_topic}/{component}/{self.pifire_id}/{topic_name}/config", + json.dumps(discovery)) + + self.initialized_topics.append(device_name) + + def notify(self, context: str, data: dict): + """ Publish changed data to the mqtt broker + + Parameters: + context (str): Description of the data (devices, probes, control, cycle) + data (dict): Key-value pairs of data to publish + """ + try: + # Split out nested dictionaries + for key in data: + if key == 'notify_data': + for device in data[key]: + #new_context = context + '_' + key + '_' + device['label'] + for probe in self._probe_settings: + if probe['label'] == device['label']: + new_context = context + '_' + key + '_' + probe['port'] + break + self.notify(new_context, device ) + elif isinstance(data[key], dict): + new_context = context + '_' + key + self.notify(new_context, data[key]) + + # Save the latest control info + if context == 'control' and self.control == None: + self.control = data + + # Get system info if requested + if context == 'system': + data = {} + data['cpu'] = psutil.cpu_percent(interval=None) + data['available_memory'] = psutil.virtual_memory().available + data['free_memory'] = psutil.virtual_memory().free + if 'sensors_temperatures' in dir(psutil): + # This is for raspberry PI. Other hardware may be different + temps = psutil.sensors_temperatures() + if 'cpu_thermal' in temps: + cpu_temps = temps['cpu_thermal'] + data['cpu_temp'] = cpu_temps[0].current + + # Publish the data we are interested in + if context in self.CONTEXTS or context.startswith('control_notify_data'): + self._publish(context, data) + + # Check to see if we have changed operating mode + if context != 'control' or data['mode'] == self.last_mode: return + + new_mode = data['mode'] + + # Update the message state if we moved to a more advanced state (ignore Stop and Error) + # all modes ['Stop','Recipe','Error','Reignite','Monitor','Prime','Startup','Smoke','Hold','Shutdown','Manual'] + #if new_mode in ['Recipe', 'Reignite','Monitor','Prime','Startup','Smoke','Hold','Shutdown','Manual']: + payload = {'msg': f"Entered {new_mode} mode" } + self.notify("notify_event", payload) + + self.last_mode = data['mode'] + + # Zero the PID data if not controlling + if data['mode'] not in ['Hold']: + payload = {} + for key in self.PID_SENSORS: + payload[key] = 0 + self._publish('pid', payload) + + # Zero the temps if stopped + if data['mode'] == "Stop": + primary_data = {} + food_data = {} + aux_data = {} + tr_data = {} + for probe in self._probe_settings: + if probe['type'] == 'Food': + food_data[probe['label']] = 0 + elif probe['type'] == 'Primary': + primary_data[probe['label']] = 0 + elif probe['type'] == 'aux': + aux_data[probe['label']] = 0 + else: + pass + + tr_data[probe['label']] = 0 + self._publish('probe_data_primary', primary_data) + self._publish('probe_data_food', food_data) + self._publish('probe_data_aux', aux_data) + self._publish('probe_data_tr', tr_data) + + except: + self._mqttLogger.exception(f'Error occurred publishing device data: ') From be925d22fefda5df3042ce7bfa1a2f01c0f6432b Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 13:56:05 -0400 Subject: [PATCH 13/21] feat(aux): add auxiliary relay GPIO pin selection to the wizard --- wizard/wizard_manifest.json | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/wizard/wizard_manifest.json b/wizard/wizard_manifest.json index 78559f238..2c59c1a6d 100644 --- a/wizard/wizard_manifest.json +++ b/wizard/wizard_manifest.json @@ -73,6 +73,30 @@ "options" : { "4" : "GPIO4", "2" : "GPIO2", "3" : "GPIO3", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, "settings" : ["platform", "outputs", "power"] }, + "output_aux1" : { + "friendly_name" : "Auxiliary Relay 1 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 1, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux1"] + }, + "output_aux2" : { + "friendly_name" : "Auxiliary Relay 2 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 2, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux2"] + }, + "output_aux3" : { + "friendly_name" : "Auxiliary Relay 3 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 3, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux3"] + }, + "output_aux4" : { + "friendly_name" : "Auxiliary Relay 4 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 4, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux4"] + }, "output_pwm" : { "friendly_name" : "DC Fan PWM GPIO Pin", "description" : "Select the GPIO used for the DC Fan PWM. Note that this should be a PWM capable GPIO.", From 418c9cc6a95b131fd93a8a346fc80168ddc5e287 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 14:07:27 -0400 Subject: [PATCH 14/21] feat(aux): add auxiliary relay label editing to the settings page --- blueprints/settings/routes.py | 20 +++++++++- .../settings/templates/settings/index.html | 37 +++++++++++++++++++ 2 files changed, 56 insertions(+), 1 deletion(-) diff --git a/blueprints/settings/routes.py b/blueprints/settings/routes.py index f901bab9c..bace73a5d 100644 --- a/blueprints/settings/routes.py +++ b/blueprints/settings/routes.py @@ -1,6 +1,6 @@ from flask import render_template, request, render_template_string, jsonify -from common.common import read_settings, read_control, write_settings, write_control, read_generic_json, generate_uuid, convert_settings_units +from common.common import read_settings, read_control, write_settings, write_control, read_generic_json, generate_uuid, convert_settings_units, get_aux_list from common.app import is_not_blank, is_checked from . import settings_bp @@ -563,6 +563,24 @@ def settings_page(action=None): write_settings(settings) + if request.method == 'POST' and action == 'aux': + response = request.form + + for aux in get_aux_list(settings): + field = f'aux_label_{aux["name"]}' + if field in response: + label = response[field].strip() + if label != '': + settings['platform']['aux_labels'][aux['name']] = label + + event['type'] = 'updated' + event['text'] = 'Successfully updated auxiliary relay settings.' + + control['settings_update'] = True + + write_settings(settings) + write_control(control, origin='app') + if request.method == 'POST' and action == 'pellets': response = request.form diff --git a/blueprints/settings/templates/settings/index.html b/blueprints/settings/templates/settings/index.html index 64283e900..b31f6c728 100644 --- a/blueprints/settings/templates/settings/index.html +++ b/blueprints/settings/templates/settings/index.html @@ -78,6 +78,7 @@
Front
Operations
Safety + Auxiliary Relays Startup & Shutdown Controller Settings {% if settings['platform']['dc_fan'] %} @@ -1313,6 +1314,42 @@



+ +
+
+
+
+
  Auxiliary Relays
+
+
+ {% set aux_list = [] %} + {% for aux_name in ['aux1', 'aux2', 'aux3', 'aux4'] %} + {% if settings['platform']['outputs'].get(aux_name) is not none %} + {% set _ = aux_list.append(aux_name) %} +
+
+ +   {{ aux_name|upper }} (GPIO{{ settings['platform']['outputs'][aux_name] }}) + +
+ +
+ {% endif %} + {% endfor %} + {% if aux_list|length == 0 %} + NOTE: + No auxiliary relays are configured. Assign a GPIO pin to one or more auxiliary relays in the configuration wizard to enable them. + {% else %} + NOTE: + Auxiliary relays are never controlled by PiFire during a cook. They switch off whenever the main power relay switches off. Names are limited to 25 characters so they fit on the touch display. + {% endif %} +
+
+ +
+
+
+
From 9126c47cba84e63c372d5bad2d4395310a219fd6 Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Tue, 11 Aug 2026 14:29:27 -0400 Subject: [PATCH 15/21] Fix stored-XSS in auxiliary relay label rendering The dashboard JS for both the Default and Basic dashboards read the Jinja-escaped aux relay label back out of the DOM via getAttribute('title') (which returns the decoded string) and re-injected it into innerHTML on every relay status change. A label containing a double quote could close the title attribute and inject an executable attribute that fired on the next toggle. Update the icon in place via property/textContent assignment instead of rebuilding it with innerHTML, for both the pre- and post-Font Awesome-SVG-conversion DOM shapes. Read the label once from a new Jinja-escaped data-label attribute rather than parsing it back out of rendered text. Add server-side length validation on the label as defence in depth. --- blueprints/dash/static/basic/js/dash_basic.js | 36 +++++++++++++++++-- .../dash/static/default/js/dash_default.js | 36 +++++++++++++++++-- .../templates/basic/_macro_dash_basic.html | 2 +- .../default/_macro_dash_default.html | 2 +- blueprints/settings/routes.py | 2 +- 5 files changed, 69 insertions(+), 9 deletions(-) diff --git a/blueprints/dash/static/basic/js/dash_basic.js b/blueprints/dash/static/basic/js/dash_basic.js index 7606a8374..a1787dc53 100644 --- a/blueprints/dash/static/basic/js/dash_basic.js +++ b/blueprints/dash/static/basic/js/dash_basic.js @@ -60,6 +60,29 @@ function initNotifyIndicators(probes) { }; // Update temperatures on probe status cards +// Auxiliary relay icons render as either (before Font Awesome's SVG +// conversion runs) or (after conversion, which replaces the +// element and moves the tooltip text into an inner node). These +// helpers update whichever form is currently in the DOM using only +// property/textContent assignment (never innerHTML), so a user-supplied +// label can never be parsed as markup. +function getAuxIcon(container) { + return container.querySelector('svg, i'); +} + +function setAuxIconTooltip(icon, text) { + if (icon.tagName.toLowerCase() === 'svg') { + var titleEl = icon.querySelector('title'); + if (titleEl === null) { + titleEl = document.createElementNS('http://www.w3.org/2000/svg', 'title'); + icon.insertBefore(titleEl, icon.firstChild); + } + titleEl.textContent = text; + } else { + icon.title = text; + } +} + function updateProbeCards() { req = $.ajax({ url : '/api/current', @@ -243,11 +266,17 @@ function updateProbeCards() { if (element === null) { return; } + var icon = getAuxIcon(element); + if (icon === null) { + return; + } var label = aux_labels[aux_name] || aux_name; if (last_aux_status[aux_name]) { - element.innerHTML = '<i class="fas fa-plug fa-2x" data-toggle="tooltip" data-placement="top" title="' + label + ' ON" style="color:rgb(0, 190, 0)"></i>'; + setAuxIconTooltip(icon, label + ' ON'); + icon.style.color = 'rgb(0, 190, 0)'; } else { - element.innerHTML = '<i class="fas fa-plug fa-2x" data-toggle="tooltip" data-placement="top" title="' + label + ' OFF" style="color:rgb(150, 150, 150)"></i>'; + setAuxIconTooltip(icon, label + ' OFF'); + icon.style.color = 'rgb(150, 150, 150)'; } } }); @@ -815,7 +844,8 @@ $(document).ready(function(){ if (element === null) { return; } - aux_labels[aux_name] = element.querySelector('i').getAttribute('title').replace(/ (ON|OFF)$/, ''); + var icon = getAuxIcon(element); + aux_labels[aux_name] = (icon !== null && icon.dataset.label) ? icon.dataset.label : aux_name; $('#' + aux_name + '_status').click(function() { cp_api_set('aux/' + aux_name + '/toggle'); }); diff --git a/blueprints/dash/static/default/js/dash_default.js b/blueprints/dash/static/default/js/dash_default.js index 8016b9642..aa8642813 100644 --- a/blueprints/dash/static/default/js/dash_default.js +++ b/blueprints/dash/static/default/js/dash_default.js @@ -148,6 +148,29 @@ function initNotifyIndicators() { }; // Update temperatures on probe status cards +// Auxiliary relay icons render as either <i> (before Font Awesome's SVG +// conversion runs) or <svg> (after conversion, which replaces the <i> +// element and moves the tooltip text into an inner <title> node). These +// helpers update whichever form is currently in the DOM using only +// property/textContent assignment (never innerHTML), so a user-supplied +// label can never be parsed as markup. +function getAuxIcon(container) { + return container.querySelector('svg, i'); +} + +function setAuxIconTooltip(icon, text) { + if (icon.tagName.toLowerCase() === 'svg') { + var titleEl = icon.querySelector('title'); + if (titleEl === null) { + titleEl = document.createElementNS('http://www.w3.org/2000/svg', 'title'); + icon.insertBefore(titleEl, icon.firstChild); + } + titleEl.textContent = text; + } else { + icon.title = text; + } +} + function updateProbeCards() { req = $.ajax({ url : '/api/current', @@ -349,11 +372,17 @@ function updateProbeCards() { if (element === null) { return; } + var icon = getAuxIcon(element); + if (icon === null) { + return; + } var label = aux_labels[aux_name] || aux_name; if (last_aux_status[aux_name]) { - element.innerHTML = '<i class="fas fa-plug fa-2x" data-toggle="tooltip" data-placement="top" title="' + label + ' ON" style="color:rgb(0, 190, 0)"></i>'; + setAuxIconTooltip(icon, label + ' ON'); + icon.style.color = 'rgb(0, 190, 0)'; } else { - element.innerHTML = '<i class="fas fa-plug fa-2x" data-toggle="tooltip" data-placement="top" title="' + label + ' OFF" style="color:rgb(150, 150, 150)"></i>'; + setAuxIconTooltip(icon, label + ' OFF'); + icon.style.color = 'rgb(150, 150, 150)'; } } }); @@ -1142,7 +1171,8 @@ $(document).ready(function(){ if (element === null) { return; } - aux_labels[aux_name] = element.querySelector('i').getAttribute('title').replace(/ (ON|OFF)$/, ''); + var icon = getAuxIcon(element); + aux_labels[aux_name] = (icon !== null && icon.dataset.label) ? icon.dataset.label : aux_name; $('#' + aux_name + '_status').click(function() { dash_api_set('aux/' + aux_name + '/toggle'); }); diff --git a/blueprints/dash/templates/basic/_macro_dash_basic.html b/blueprints/dash/templates/basic/_macro_dash_basic.html index 251ea58e6..6df1fb0c4 100644 --- a/blueprints/dash/templates/basic/_macro_dash_basic.html +++ b/blueprints/dash/templates/basic/_macro_dash_basic.html @@ -335,7 +335,7 @@ <h5>Current: <span id="hopperPellets"></span></h5> {% for aux_name in ['aux1', 'aux2', 'aux3', 'aux4'] %} {% if settings['platform']['outputs'].get(aux_name) is not none %} <td> - <span id="{{ aux_name }}_status"><i class="fas fa-plug fa-2x" data-toggle="tooltip" data-placement="top" title="{{ settings['platform']['aux_labels'].get(aux_name, aux_name) }} OFF" style="color:rgb(150, 150, 150)"></i></span>  + <span id="{{ aux_name }}_status"><i class="fas fa-plug fa-2x" data-toggle="tooltip" data-placement="top" title="{{ settings['platform']['aux_labels'].get(aux_name, aux_name) }} OFF" data-label="{{ settings['platform']['aux_labels'].get(aux_name, aux_name) }}" style="color:rgb(150, 150, 150)"></i></span>  </td> {% endif %} {% endfor %} diff --git a/blueprints/dash/templates/default/_macro_dash_default.html b/blueprints/dash/templates/default/_macro_dash_default.html index f0fab439a..6d2507e36 100644 --- a/blueprints/dash/templates/default/_macro_dash_default.html +++ b/blueprints/dash/templates/default/_macro_dash_default.html @@ -392,7 +392,7 @@ <h4 class="modal-title"><i class="fas fa-temperature-high"></i>  {{ probe_d {% for aux_name in ['aux1', 'aux2', 'aux3', 'aux4'] %} {% if settings['platform']['outputs'].get(aux_name) is not none %} <td> - <span id="{{ aux_name }}_status"><i class="fas fa-plug fa-2x" data-toggle="tooltip" data-placement="top" title="{{ settings['platform']['aux_labels'].get(aux_name, aux_name) }} OFF" style="color:rgb(150, 150, 150)"></i></span>  + <span id="{{ aux_name }}_status"><i class="fas fa-plug fa-2x" data-toggle="tooltip" data-placement="top" title="{{ settings['platform']['aux_labels'].get(aux_name, aux_name) }} OFF" data-label="{{ settings['platform']['aux_labels'].get(aux_name, aux_name) }}" style="color:rgb(150, 150, 150)"></i></span>  </td> {% endif %} {% endfor %} diff --git a/blueprints/settings/routes.py b/blueprints/settings/routes.py index bace73a5d..39615f828 100644 --- a/blueprints/settings/routes.py +++ b/blueprints/settings/routes.py @@ -569,7 +569,7 @@ def settings_page(action=None): for aux in get_aux_list(settings): field = f'aux_label_{aux["name"]}' if field in response: - label = response[field].strip() + label = response[field].strip()[:25] if label != '': settings['platform']['aux_labels'][aux['name']] = label From dbc45b710a163f90f3b2de1724a8072f166a1e67 Mon Sep 17 00:00:00 2001 From: Daniel Berlin <dberlin@dberlin.org> Date: Tue, 11 Aug 2026 14:56:10 -0400 Subject: [PATCH 16/21] Fix findings from final whole-branch review of auxiliary relay feature - default dashboard: add the missing aux badge-row loop so badges line up under their icons (basic dashboard already had this) - control.py: _process_aux_requests now takes the caller's control dict instead of re-reading/re-writing its own snapshot, so a caller's later stale write can no longer resurrect an already-applied (and supposedly cleared) aux request - raspberry_pi_all.py: cleanup() now explicitly de-energizes aux via _all_aux_off() before closing the devices, matching prototype.py's implicit guarantee via power_off() - spec doc: replace the stale pre-revision text describing dash icons (aux_status_N / _configure_dash / _update_dash_objects) with a description of the actual shipped menu_aux screen Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> --- .../dash/templates/default/_macro_dash_default.html | 5 +++++ control.py | 11 +++++++---- grillplat/raspberry_pi_all.py | 1 + 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/blueprints/dash/templates/default/_macro_dash_default.html b/blueprints/dash/templates/default/_macro_dash_default.html index 6d2507e36..b8466349b 100644 --- a/blueprints/dash/templates/default/_macro_dash_default.html +++ b/blueprints/dash/templates/default/_macro_dash_default.html @@ -412,6 +412,11 @@ <h4 class="modal-title"><i class="fas fa-temperature-high"></i>  {{ probe_d <td><span class="badge badge-secondary">Fan</span></td> <td><span class="badge badge-secondary">Auger</span></td> <td><span class="badge badge-secondary">Igniter</span></td> + {% for aux_name in ['aux1', 'aux2', 'aux3', 'aux4'] %} + {% if settings['platform']['outputs'].get(aux_name) is not none %} + <td><span class="badge badge-secondary">{{ settings['platform']['aux_labels'].get(aux_name, aux_name) }}</span></td> + {% endif %} + {% endfor %} <td id="pmode_badge"> <span class="badge badge-secondary">P-Mode</span> </td> diff --git a/control.py b/control.py index 4d0871618..6e6c2b108 100755 --- a/control.py +++ b/control.py @@ -303,7 +303,7 @@ def _process_system_commands(grill_platform): } system_output.push(result) -def _process_aux_requests(grill_platform): +def _process_aux_requests(grill_platform, control): """ Apply any pending auxiliary relay requests. @@ -313,8 +313,11 @@ def _process_aux_requests(grill_platform): Requests are transient: they are cleared as soon as they have been applied, so that Stop mode resetting the control structure cannot strand a stale desired state. + + Takes the caller's in-memory `control` dict (rather than re-reading it) and mutates it + in place, so that any later stale write of that same object by the caller carries the + cleared aux state instead of resurrecting the just-applied request. """ - control = read_control() requests = control.get('aux', {}) if not requests: @@ -613,7 +616,7 @@ def _work_cycle(mode, grill_platform, probe_complex, display_device, dist_device control = read_control() _process_system_commands(grill_platform) - _process_aux_requests(grill_platform) + _process_aux_requests(grill_platform, control) # Check if new mode has been requested if control['updated']: @@ -1321,7 +1324,7 @@ def exit_handler(): # Check for system commands _process_system_commands(grill_platform) - _process_aux_requests(grill_platform) + _process_aux_requests(grill_platform, control) # Check if there were updates to any of the settings that were flagged if control['settings_update']: diff --git a/grillplat/raspberry_pi_all.py b/grillplat/raspberry_pi_all.py index 7952ec57c..a1731f7a0 100644 --- a/grillplat/raspberry_pi_all.py +++ b/grillplat/raspberry_pi_all.py @@ -256,6 +256,7 @@ def cleanup(self): self.igniter.close() self.auger.close() self.fan.close() + self._all_aux_off() for name in self.aux: self.aux[name].close() self.pwm.stop() From 07c535446cb33c6020ba7420df90b8433e4280b0 Mon Sep 17 00:00:00 2001 From: Daniel Berlin <dberlin@dberlin.org> Date: Tue, 11 Aug 2026 16:14:56 -0400 Subject: [PATCH 17/21] Color the aux relay menu buttons by live on/off state Adds an optional per-button colour override (button_colors) to MenuGeneric so it stays byte-identical when absent, then uses it to show each configured auxiliary relay's button green when energised. Colours are recomputed on every aux-menu build from status_data, and _fetch_data() now forces a menu rebuild when a relay's state changes while the menu is open, so the display doesn't need a per-frame update path. Toggling a relay from the menu now stays on the aux menu instead of bouncing to the dashboard, so the user sees the colour change land. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> --- display/base_flex.py | 57 ++++++++++++++++++++++++++++++++++++++++++- display/flexobject.py | 20 ++++++++++++--- 2 files changed, 73 insertions(+), 4 deletions(-) diff --git a/display/base_flex.py b/display/base_flex.py index 2ea0727af..10f350ba2 100644 --- a/display/base_flex.py +++ b/display/base_flex.py @@ -24,6 +24,10 @@ from PIL import Image from common import read_control, write_control, is_real_hardware, read_generic_json, read_settings, write_settings, read_status, read_current +''' Colour used to show an auxiliary relay is energised on the aux menu, matching the + web dashboards' colour for an "on" aux plug icon. ''' +AUX_RELAY_ON_COLOR = (0, 190, 0, 255) + ''' ================================================================================== Display base class definition @@ -42,6 +46,9 @@ def __init__(self, dev_pins, buttonslevel='HIGH', rotation=0, units='F', config= self.last_in_data = {} self.status_data = None self.last_status_data = {} + # Snapshot of {aux_name: bool} the currently-rendered aux menu's button colours were + # built from; used by _fetch_data() to detect a live state change and force a rebuild. + self.aux_menu_outpins = None self.input_enabled = False self.input_origin = None @@ -178,6 +185,39 @@ def _configure_aux_menu(self): menus['aux']['button_list'] = button_list menus['aux']['button_text'] = button_text + def _aux_relay_states(self): + ''' + Return {aux_name: bool} for every configured auxiliary relay, read from the live + status data. An unconfigured relay never appears in self.config['aux_info'], and a + configured relay that is momentarily missing from status_data['outpins'] is treated + as off. + ''' + outpins = {} + if self.status_data is not None: + outpins = self.status_data.get('outpins', {}) + + return {aux['name']: outpins.get(aux['name'], False) for aux in self.config.get('aux_info', [])} + + def _calc_aux_button_colors(self): + ''' + Build the button_colors list for the aux menu, aligned index-for-index with the + button_list that _configure_aux_menu() produced: green for a 'cmd_aux_toggle_<name>' + button whose relay is on, None (the menu's default colour) for an off relay and for + both menu_close bookend entries. + ''' + button_list = self.display_data[self.display_profile]['menus']['aux'].get('button_list', []) + aux_states = self._aux_relay_states() + + button_colors = [] + for button in button_list: + if button.startswith('cmd_aux_toggle_'): + aux_name = button[len('cmd_aux_toggle_'):] + button_colors.append(AUX_RELAY_ON_COLOR if aux_states.get(aux_name, False) else None) + else: + button_colors.append(None) + + return button_colors + def _init_display_device(self): ''' @@ -332,6 +372,11 @@ def _build_objects(self, background=None): section_data = self.display_data[self.display_profile][self.display_active] elif 'menu_' in self.display_active: section_data = [self.display_data[self.display_profile]['menus'][self.display_active.replace('menu_', '')]] + if self.display_active == 'menu_aux': + # Colours are per-render (live relay state) and must not be baked into the + # static button_list/button_text that _configure_aux_menu() built at init. + section_data[0]['button_colors'] = self._calc_aux_button_colors() + self.aux_menu_outpins = self._aux_relay_states() elif 'input_' in self.display_active: section_data = [self.display_data[self.display_profile]['input'][self.display_active.replace('input_', '')]] section_data[0]['data']['origin'] = self.input_origin @@ -644,6 +689,14 @@ def _fetch_data(self): self.units = self.status_data['units'] + ''' If the aux menu is open and a configured relay's state has changed since the menu + was last built, force a rebuild so the button colours stay current. Menus are only + rebuilt on self.display_init (see the display loops), so there is no per-frame + update path for them like there is for the dash. ''' + if self.display_active == 'menu_aux' and self.aux_menu_outpins is not None: + if self._aux_relay_states() != self.aux_menu_outpins: + self.display_init = True + ''' Wake the display to the dash if it's currently off ''' if self.display_active == None and self.status_data['mode'] != 'Stop': self.display_active = 'dash' @@ -895,7 +948,9 @@ def _command_handler(self): requests.get(f'http://127.0.0.1:5000/api/set/aux/{aux_name}/toggle') except: self.eventLogger.debug(f'Auxiliary Relay [{aux_name}] Toggle Failed.') - self.display_active = 'dash' + # Stay on the aux menu (rather than bouncing to dash) so the user sees the colour + # change; the toggle is applied asynchronously by the control script, so the actual + # colour update happens once _fetch_data() observes the new state (see item 3). self.display_init = True if 'lid_open' in self.command: diff --git a/display/flexobject.py b/display/flexobject.py index 4c11a2758..d717cf467 100644 --- a/display/flexobject.py +++ b/display/flexobject.py @@ -727,6 +727,10 @@ def _draw_object(self): draw = ImageDraw.Draw(canvas) # Create drawing object fg_color = self.objectData['color'] bg_color = (0,0,0,255) + # Optional parallel list of per-button colour overrides (see button_list). An entry of + # None, or the list being absent/shorter than button_list, falls back to fg_color/white + # outline, i.e. today's single-colour rendering. + button_colors = self.objectData.get('button_colors') # Clear any touch areas that might have been defined before self.objectData['touch_areas'] = [] @@ -795,11 +799,21 @@ def _draw_object(self): rect_size = (button_width, button_height) rect_coords = (rect_position[0], rect_position[1], rect_position[0] + rect_size[0], rect_position[1] + rect_size[1]) + + # Per-button colour override, if provided; otherwise today's single menu colour + # with a plain white outline. + if button_colors is not None and index < len(button_colors) and button_colors[index] is not None: + button_color = button_colors[index] + button_outline = button_color + else: + button_color = fg_color + button_outline = (255,255,255,255) + if selected == index: # Reverse colors if selected - draw.rounded_rectangle(rect_coords, radius=8, outline=(255,255,255,255), fill=fg_color) + draw.rounded_rectangle(rect_coords, radius=8, outline=button_outline, fill=button_color) else: - draw.rounded_rectangle(rect_coords, radius=8, outline=(255,255,255,255), fill=bg_color) + draw.rounded_rectangle(rect_coords, radius=8, outline=button_outline, fill=bg_color) # Put button text inside rectangle if len(self.objectData['button_text'][index]) > 25: @@ -810,7 +824,7 @@ def _draw_object(self): # Reverse colors if selected label = self._draw_text(label_displayed, self.objectData['font'], 35, bg_color) else: - label = self._draw_text(label_displayed, self.objectData['font'], 35, fg_color) + label = self._draw_text(label_displayed, self.objectData['font'], 35, button_color) label_x = rect_position[0] + (rect_size[0] // 2) - (label.width // 2) label_y = rect_position[1] + (rect_size[1] // 2) - (label.height // 2) label_position = (label_x, label_y) From f2cd9d96ef75ba4945444a182aa9dcbd7826de22 Mon Sep 17 00:00:00 2001 From: Daniel Berlin <dberlin@dberlin.org> Date: Tue, 11 Aug 2026 16:22:47 -0400 Subject: [PATCH 18/21] Add auxiliary relay GPIO dropdowns to PCB presets in wizard manifest The settings page tells users to configure aux relays in the wizard, but the four PCB board presets (pcb_2.00a, pcb_3.01a, pcb_pwm, pcb_4.x.x) never exposed the output_aux1..output_aux4 dropdowns - only Custom Build did, despite all presets sharing the same raspberry_pi_all platform module. Copy custom's aux relay settings_dependencies entries into each preset. --- wizard/wizard_manifest.json | 96 +++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) diff --git a/wizard/wizard_manifest.json b/wizard/wizard_manifest.json index 2c59c1a6d..af519a4d1 100644 --- a/wizard/wizard_manifest.json +++ b/wizard/wizard_manifest.json @@ -254,6 +254,30 @@ "settings" : ["platform", "outputs", "power"], "hidden" : true }, + "output_aux1" : { + "friendly_name" : "Auxiliary Relay 1 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 1, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux1"] + }, + "output_aux2" : { + "friendly_name" : "Auxiliary Relay 2 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 2, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux2"] + }, + "output_aux3" : { + "friendly_name" : "Auxiliary Relay 3 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 3, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux3"] + }, + "output_aux4" : { + "friendly_name" : "Auxiliary Relay 4 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 4, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux4"] + }, "output_pwm" : { "friendly_name" : "DC Fan PWM GPIO Pin", "description" : "Select the GPIO used for the DC Fan PWM. Note that this should be a PWM capable GPIO.", @@ -432,6 +456,30 @@ "settings" : ["platform", "outputs", "power"], "hidden" : true }, + "output_aux1" : { + "friendly_name" : "Auxiliary Relay 1 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 1, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux1"] + }, + "output_aux2" : { + "friendly_name" : "Auxiliary Relay 2 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 2, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux2"] + }, + "output_aux3" : { + "friendly_name" : "Auxiliary Relay 3 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 3, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux3"] + }, + "output_aux4" : { + "friendly_name" : "Auxiliary Relay 4 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 4, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux4"] + }, "output_pwm" : { "friendly_name" : "DC Fan PWM GPIO Pin", "description" : "Select the GPIO used for the DC Fan PWM. Note that this should be a PWM capable GPIO.", @@ -616,6 +664,30 @@ "settings" : ["platform", "outputs", "power"], "hidden" : true }, + "output_aux1" : { + "friendly_name" : "Auxiliary Relay 1 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 1, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux1"] + }, + "output_aux2" : { + "friendly_name" : "Auxiliary Relay 2 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 2, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux2"] + }, + "output_aux3" : { + "friendly_name" : "Auxiliary Relay 3 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 3, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux3"] + }, + "output_aux4" : { + "friendly_name" : "Auxiliary Relay 4 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 4, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux4"] + }, "output_pwm" : { "friendly_name" : "DC Fan PWM GPIO Pin", "description" : "Select the GPIO used for the DC Fan PWM. Note that this should be a PWM capable GPIO.", @@ -800,6 +872,30 @@ "settings" : ["platform", "outputs", "power"], "hidden" : true }, + "output_aux1" : { + "friendly_name" : "Auxiliary Relay 1 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 1, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux1"] + }, + "output_aux2" : { + "friendly_name" : "Auxiliary Relay 2 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 2, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux2"] + }, + "output_aux3" : { + "friendly_name" : "Auxiliary Relay 3 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 3, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux3"] + }, + "output_aux4" : { + "friendly_name" : "Auxiliary Relay 4 GPIO Pin", + "description" : "Select the GPIO used for auxiliary relay 4, or Not Installed if you do not have one. Auxiliary relays are never controlled by PiFire during a cook - they are yours to switch.", + "options" : { "None" : "Not Installed", "2" : "GPIO2", "3" : "GPIO3", "4" : "GPIO4", "5" : "GPIO5", "6" : "GPIO6", "7" : "GPIO7", "8" : "GPIO8", "9" : "GPIO9", "10" : "GPIO10", "11" : "GPIO11", "12" : "GPIO12", "13" : "GPIO13", "14" : "GPIO14", "15" : "GPIO15", "16" : "GPIO16", "17" : "GPIO17", "18" : "GPIO18", "19" : "GPIO19", "20" : "GPIO20", "21" : "GPIO21", "22" : "GPIO22", "23" : "GPIO23", "24" : "GPIO24", "25" : "GPIO25", "26" : "GPIO26", "27" : "GPIO27" }, + "settings" : ["platform", "outputs", "aux4"] + }, "output_pwm" : { "friendly_name" : "DC Fan PWM GPIO Pin", "description" : "Select the GPIO used for the DC Fan PWM. Note that this should be a PWM capable GPIO.", From 460397a542255ce21f7b26a735a9d8f2e48a1ff2 Mon Sep 17 00:00:00 2001 From: Daniel Berlin <dberlin@dberlin.org> Date: Tue, 11 Aug 2026 16:43:17 -0400 Subject: [PATCH 19/21] Guard wizard against assigning one GPIO pin to two platform functions The wizard let a user pick the same GPIO for two different grillplatform fields (e.g. an aux relay and the igniter). gpiozero then raises GPIOPinInUse when the platform is constructed, control.py's blanket except-clause swallows it, and the grill silently falls back to the simulated prototype platform - driving no hardware during a "normal" looking cook. Add find_platform_pin_collisions() in wizard.py, which mirrors exactly what GrillPlatform.__init__ (grillplat/raspberry_pi_all.py) constructs so inert fields (e.g. the AC fan pin on a DC-fan build, the selector pin on a standalone build) are never flagged. Wire it into routes.py's 'finish' action before anything is stored or the install is launched; on collision the request falls through to the existing error-rendering path instead, naming every colliding pair of fields. --- blueprints/wizard/routes.py | 24 ++++++++++------ blueprints/wizard/wizard.py | 57 ++++++++++++++++++++++++++++++++++++- 2 files changed, 71 insertions(+), 10 deletions(-) diff --git a/blueprints/wizard/routes.py b/blueprints/wizard/routes.py index 1f20226e4..ee22c8a0c 100644 --- a/blueprints/wizard/routes.py +++ b/blueprints/wizard/routes.py @@ -33,15 +33,21 @@ def wizard_page(action=None): if action=='finish': if control['mode'] == 'Stop': wizardInstallInfo = prepare_wizard_data(r) - store_wizard_install_info(wizardInstallInfo) - set_wizard_install_status(0, 'Starting Install...', '') - os.system(f'{python_exec} wizard.py &') # Kickoff Installation - return render_template( - 'wizard/wizard-finish.html', - page_theme=settings['globals'].get('page_theme', 'light'), - grill_name=settings['globals'].get('grill_name', ''), - wizardData=wizardData - ) + profile_selected = wizardInstallInfo['modules']['grillplatform']['profile_selected'][0] + settings_dependencies = wizardData['modules']['grillplatform'][profile_selected]['settings_dependencies'] + errors += find_platform_pin_collisions(settings_dependencies, wizardInstallInfo['modules']['grillplatform']['settings']) + if not errors: + store_wizard_install_info(wizardInstallInfo) + set_wizard_install_status(0, 'Starting Install...', '') + os.system(f'{python_exec} wizard.py &') # Kickoff Installation + return render_template( + 'wizard/wizard-finish.html', + page_theme=settings['globals'].get('page_theme', 'light'), + grill_name=settings['globals'].get('grill_name', ''), + wizardData=wizardData + ) + # else: fall through to the shared render below so the user sees the errors. + # Nothing is stored and no install is launched. if action=='modulecard': module = r['module'] diff --git a/blueprints/wizard/wizard.py b/blueprints/wizard/wizard.py index 5a3339856..2e565f521 100644 --- a/blueprints/wizard/wizard.py +++ b/blueprints/wizard/wizard.py @@ -170,4 +170,59 @@ def prepare_wizard_data(form_data): if config.startswith(module_ + 'config_'): wizardInstallInfo['modules'][module]['config'][config.replace(module_ + 'config_', '')] = value - return(wizardInstallInfo) \ No newline at end of file + return(wizardInstallInfo) + +def find_platform_pin_collisions(settings_dependencies, submitted_settings): + """ + Detects GPIO pins assigned to more than one grill platform function in a submitted + wizard configuration. + + Only fields that grillplat/raspberry_pi_all.py's GrillPlatform.__init__ actually turns + into a pin object are checked - mirroring that constructor exactly - so that fields left + inert by other settings (e.g. the AC fan pin on a DC-fan build, the selector pin on a + standalone build) are never flagged as claimed: + - outputs.auger, outputs.igniter, outputs.power are always claimed + - outputs.fan is claimed only when dc_fan is False + - outputs.dc_fan and outputs.pwm are claimed only when dc_fan is True + - inputs.selector is claimed only when standalone is False + - outputs.aux1..aux4 are claimed only when not 'None' + + Parameters: + - settings_dependencies (dict): wizardData['modules']['grillplatform'][<profile>]['settings_dependencies']. + Used only to look up each field's friendly_name for the error message. + - submitted_settings (dict): wizardInstallInfo['modules']['grillplatform']['settings'], the raw + setting-name -> submitted-string-value mapping produced by prepare_wizard_data(). + + Returns: + - list of str: one human-readable error message per colliding pair of fields, naming both + fields and the shared pin. Empty if there are no collisions. + """ + dc_fan = submitted_settings.get('dc_fan') == 'True' + standalone = submitted_settings.get('standalone') == 'True' + + pin_fields = ['output_auger', 'output_igniter', 'output_power', 'output_aux1', 'output_aux2', 'output_aux3', 'output_aux4'] + if dc_fan: + pin_fields += ['output_dc_fan', 'output_pwm'] + else: + pin_fields.append('output_fan') + if not standalone: + pin_fields.append('input_selector') + + claimed_by = {} # pin value (str) -> (field name, friendly name) + errors = [] + for field in pin_fields: + value = submitted_settings.get(field) + if value is None or value == 'None': + continue # unset/'Not Installed' pins are never claimed + + friendly_name = settings_dependencies.get(field, {}).get('friendly_name', field) + if value in claimed_by: + _, other_friendly_name = claimed_by[value] + errors.append( + f'{other_friendly_name} and {friendly_name} are both set to GPIO{value}. ' + f'Each pin may only be assigned to one function.' + ) + else: + claimed_by[value] = (field, friendly_name) + + return errors From 43c8170d0a61dcc77cb6333e9de921e8a514c1d6 Mon Sep 17 00:00:00 2001 From: Daniel Berlin <dberlin@dberlin.org> Date: Tue, 11 Aug 2026 16:54:35 -0400 Subject: [PATCH 20/21] Also claim 1-Wire and SPI0 CE0/CE1 pins in the wizard pin-collision guard board-config.py writes system.1WIRE and the SPI0 bus into the boot config as device-tree overlays (dtoverlay=w1-gpio and dtparam=spi=on, which fixes CE0/CE1 to GPIO8/GPIO7). The kernel claims these pins at boot, before control.py ever runs - so if an aux relay is assigned one of them, GrillPlatform.__init__ loses that race and raises, landing on the same silent grillplat.prototype fallback this guard exists to prevent, just through a second door beyond what GrillPlatform.__init__ itself constructs. Verified independently (not just on the review's word) that adding these three produces zero false positives against every preset's own default configuration under both dc_fan states, and that the only other duplicate-pin default anywhere in the manifest (pcb_4.x.x's auger/device_distance_trig sharing GPIO23) stays correctly out of scope since device_distance_trig remains excluded. --- blueprints/wizard/wizard.py | 41 ++++++++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 10 deletions(-) diff --git a/blueprints/wizard/wizard.py b/blueprints/wizard/wizard.py index 2e565f521..d5e73004f 100644 --- a/blueprints/wizard/wizard.py +++ b/blueprints/wizard/wizard.py @@ -177,15 +177,32 @@ def find_platform_pin_collisions(settings_dependencies, submitted_settings): Detects GPIO pins assigned to more than one grill platform function in a submitted wizard configuration. - Only fields that grillplat/raspberry_pi_all.py's GrillPlatform.__init__ actually turns - into a pin object are checked - mirroring that constructor exactly - so that fields left - inert by other settings (e.g. the AC fan pin on a DC-fan build, the selector pin on a - standalone build) are never flagged as claimed: - - outputs.auger, outputs.igniter, outputs.power are always claimed - - outputs.fan is claimed only when dc_fan is False - - outputs.dc_fan and outputs.pwm are claimed only when dc_fan is True - - inputs.selector is claimed only when standalone is False - - outputs.aux1..aux4 are claimed only when not 'None' + Fields are checked when either of two things claims the pin before/independently of + control.py ever running: + 1. grillplat/raspberry_pi_all.py's GrillPlatform.__init__ turns the field into a pin + object - mirrored exactly, so fields left inert by other settings (e.g. the AC fan + pin on a DC-fan build, the selector pin on a standalone build) are never flagged: + - outputs.auger, outputs.igniter, outputs.power are always claimed + - outputs.fan is claimed only when dc_fan is False + - outputs.dc_fan and outputs.pwm are claimed only when dc_fan is True + - inputs.selector is claimed only when standalone is False + - outputs.aux1..aux4 are claimed only when not 'None' + 2. board-config.py writes the pin into the boot config as a device-tree overlay, so the + KERNEL claims it at boot, before GrillPlatform.__init__ ever runs - if an aux relay + is assigned the same pin, GrillPlatform.__init__ loses that race and raises, which + lands PiFire on the simulated prototype platform exactly as if the collision were + with another GrillPlatform pin: + - system.1WIRE is always claimed when set (dtoverlay=w1-gpio, board-config.py's + set_onewire_gpio()) + - system.SPI0.CE0 and system.SPI0.CE1 are always claimed when set (the SPI0 + overlay enabled by board-config.py's enable_spi() fixes these pins) + + Deliberately NOT checked, despite also being pin-valued fields in the manifest: + input_shutdown, device_display_*, device_distance_*, device_input_*. None of these are + touched by GrillPlatform.__init__, and unlike 1-Wire/SPI0 they were not verified against + board-config.py's overlay writes for this change - device_distance_trig in particular is + hardcoded to the same pin as output_auger on the pcb_4.x.x default, so treating it as + claimed would refuse that board's own stock configuration. Parameters: - settings_dependencies (dict): wizardData['modules']['grillplatform'][<profile>]['settings_dependencies']. @@ -200,7 +217,11 @@ def find_platform_pin_collisions(settings_dependencies, submitted_settings): dc_fan = submitted_settings.get('dc_fan') == 'True' standalone = submitted_settings.get('standalone') == 'True' - pin_fields = ['output_auger', 'output_igniter', 'output_power', 'output_aux1', 'output_aux2', 'output_aux3', 'output_aux4'] + pin_fields = [ + 'output_auger', 'output_igniter', 'output_power', + 'output_aux1', 'output_aux2', 'output_aux3', 'output_aux4', + 'system_1wire', 'system_spi0_ce0', 'system_spi0_ce1', + ] if dc_fan: pin_fields += ['output_dc_fan', 'output_pwm'] else: From 1d8feef293137c91a2b437bccc5889b2230c50b2 Mon Sep 17 00:00:00 2001 From: Daniel Berlin <dberlin@dberlin.org> Date: Tue, 11 Aug 2026 16:58:50 -0400 Subject: [PATCH 21/21] Also claim the GPIO shutdown pin in the wizard pin-collision guard board-config.py's enable_gpio_shutdown() writes dtoverlay=gpio-shutdown,gpio_pin=N whenever inputs.shutdown is set - the same boot-time kernel pin claim, made the same way, as the w1-gpio/SPI0 overlays already covered. An aux relay (or the selector) assigned that pin makes GrillPlatform.__init__ lose the race at construction time and fall back to the silent prototype platform, same as every other collision this guard catches. Verified independently that no preset's own default configuration collides across selector/shutdown, under every dc_fan and standalone combination each preset actually offers, and reproduced the common/common.py default_settings() case (Custom build, standalone False, selector=shutdown=GPIO17) to confirm the guard both catches it and produces a comprehensible message naming both user-visible fields. --- blueprints/wizard/wizard.py | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/blueprints/wizard/wizard.py b/blueprints/wizard/wizard.py index d5e73004f..070cee493 100644 --- a/blueprints/wizard/wizard.py +++ b/blueprints/wizard/wizard.py @@ -189,20 +189,22 @@ def find_platform_pin_collisions(settings_dependencies, submitted_settings): - outputs.aux1..aux4 are claimed only when not 'None' 2. board-config.py writes the pin into the boot config as a device-tree overlay, so the KERNEL claims it at boot, before GrillPlatform.__init__ ever runs - if an aux relay - is assigned the same pin, GrillPlatform.__init__ loses that race and raises, which - lands PiFire on the simulated prototype platform exactly as if the collision were - with another GrillPlatform pin: + (or the selector) is assigned the same pin, GrillPlatform.__init__ loses that race + and raises, which lands PiFire on the simulated prototype platform exactly as if the + collision were with another GrillPlatform pin: - system.1WIRE is always claimed when set (dtoverlay=w1-gpio, board-config.py's set_onewire_gpio()) - system.SPI0.CE0 and system.SPI0.CE1 are always claimed when set (the SPI0 overlay enabled by board-config.py's enable_spi() fixes these pins) + - inputs.shutdown is always claimed when set (dtoverlay=gpio-shutdown, + board-config.py's enable_gpio_shutdown()) Deliberately NOT checked, despite also being pin-valued fields in the manifest: - input_shutdown, device_display_*, device_distance_*, device_input_*. None of these are - touched by GrillPlatform.__init__, and unlike 1-Wire/SPI0 they were not verified against - board-config.py's overlay writes for this change - device_distance_trig in particular is - hardcoded to the same pin as output_auger on the pcb_4.x.x default, so treating it as - claimed would refuse that board's own stock configuration. + device_display_*, device_distance_*, device_input_*. None of these are touched by + GrillPlatform.__init__ or by a board-config.py boot overlay verified for this guard, and + device_distance_trig in particular is hardcoded to the same pin as output_auger on the + pcb_4.x.x default, so treating it as claimed would refuse that board's own stock + configuration. Parameters: - settings_dependencies (dict): wizardData['modules']['grillplatform'][<profile>]['settings_dependencies']. @@ -221,6 +223,7 @@ def find_platform_pin_collisions(settings_dependencies, submitted_settings): 'output_auger', 'output_igniter', 'output_power', 'output_aux1', 'output_aux2', 'output_aux3', 'output_aux4', 'system_1wire', 'system_spi0_ce0', 'system_spi0_ce1', + 'input_shutdown', ] if dc_fan: pin_fields += ['output_dc_fan', 'output_pwm']