Skip to content

fix(display): correct module trigger logic and ensure header visibility #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dfl-aeb wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(display): correct module trigger logic and ensure header visibility #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 35 additions & 27 deletions MMM-HomeAssistantDisplay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Module.register("MMM-HomeAssistantDisplay", {
ignoreCert: true,
token: "",
debuglogging: false,
useModuleTigger: false,
useModuleTrigger: false, // Corrected typo: useModuleTigger -> useModuleTrigger
useModuleTigger: false, // For backwards compatibility
Copy link

Copilot AI Aug 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment maintains the intentional misspelling 'Tigger' for backward compatibility, but it should clarify that this is a deprecated option. Consider updating the comment to: '// For backwards compatibility - deprecated, use useModuleTrigger instead'

Suggested change
useModuleTigger: false, // For backwards compatibility
useModuleTigger: false, // For backwards compatibility - deprecated, use useModuleTrigger instead

Copilot uses AI. Check for mistakes.
moduleTriggerTemplate: "",
moduleTriggerEntities: false,
animationSpeed: 3000,
Expand All @@ -32,7 +33,7 @@ Module.register("MMM-HomeAssistantDisplay", {
this.sendSocketNotification("CONNECT", this.config);

// Setup the watched entity for the module display
if (this.config.useModuleTigger && this.config.moduleTriggerEntities) {
if ((this.config.useModuleTrigger || this.config.useModuleTigger) && this.config.moduleTriggerEntities) {
for (const entity in this.config.moduleTriggerEntities) {
this.sendSocketNotification("SET_WATCHED_ENTITY", {
identifier: this.identifier,
Expand All @@ -54,7 +55,7 @@ Module.register("MMM-HomeAssistantDisplay", {
}
// Set up a timer to trigger re-rendering outside of any entity state update
if (section.refreshTimer) {
setInterval(()=> {
setInterval(() => {
this.renderTemplates("timeout");
this.updateDom();
}, section.refreshTimer * 1000);
Expand Down Expand Up @@ -100,6 +101,13 @@ Module.register("MMM-HomeAssistantDisplay", {
},

getHeader: function () {
// If the module is configured to use a trigger to control its visibility,
// and the trigger currently indicates the module should be hidden,
// then do not return a title, so no header is rendered.
if ((this.config.useModuleTrigger || this.config.useModuleTigger) && !this.displayModule) {
Copy link

Copilot AI Aug 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The condition checks !this.displayModule but displayModule is not defined or initialized in the visible code. This could result in the header always being hidden if displayModule is undefined. Ensure displayModule is properly initialized and updated based on the module trigger logic.

Copilot uses AI. Check for mistakes.
return null;
}
// Otherwise, return the configured title.
return this.config.title;
},

Expand Down Expand Up @@ -127,7 +135,7 @@ Module.register("MMM-HomeAssistantDisplay", {
},

renderTemplates: function (causingEntity) {
if (this.config.useModuleTigger && this.config.moduleTriggerTemplate) {
if ((this.config.useModuleTrigger || this.config.useModuleTigger) && this.config.moduleTriggerTemplate) {
this.sendSocketNotification("RENDER_MODULE_DISPLAY_TEMPLATE", {
identifier: this.identifier,
template: this.config.moduleTriggerTemplate
Expand All @@ -146,29 +154,29 @@ Module.register("MMM-HomeAssistantDisplay", {
socketNotificationReceived: function (notification, payload) {
if (payload.identifier === this.identifier) {
switch (notification) {
case "MODULE_DISPLAY_RENDERED":
if (payload.render.toLowerCase() === "true" || payload.render.toLowerCase() === "on"){
this.displayModule = true;
}else {
this.displayModule = false;
}
this.updateDom();
break;
case "CHANGED_STATE":
this.renderTemplates(payload.cause);
this.updateDom();
break;
case "SECTION_DISPLAY_RENDERED":
this.config.sections[payload.section].render = payload.render;
this.updateDom();
break;
case "HASSWS_DISCONNECTED":
this.sendSocketNotification("RECONNECT_WS", this.config);
break;
default:
break;
case "MODULE_DISPLAY_RENDERED":

if (payload.render.toLowerCase() === "true" || payload.render.toLowerCase() === "on") {
this.displayModule = true;
} else {
this.displayModule = false;
}

this.updateDom();
break;
case "CHANGED_STATE":
this.renderTemplates(payload.cause);
this.updateDom();
break;
case "SECTION_DISPLAY_RENDERED":
this.config.sections[payload.section].render = payload.render;
this.updateDom();
break;
case "HASSWS_DISCONNECTED":
this.sendSocketNotification("RECONNECT_WS", this.config);
break;
default:
break;
}
}
}
Expand Down