Skip to content

feat: add CC changes to allow Plugins to have a resart button #128

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

Merged
damachine merged 6 commits into from
Jan 31, 2026
Merged

feat: add CC changes to allow Plugins to have a resart button #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
649e35d
feat: prepare for `https://gitlab.com/coolercontrol/coolercontrol/-/m…
damachine Jan 24, 2026
c5104a2
feat: add restart on `save` and `reset` actions
damachine Jan 24, 2026
d53676a
Merge branch 'master' into feat-plugin
damachine Jan 31, 2026
e8f0627
Merge branch 'master' into feat-plugin
damachine Jan 31, 2026
7dd32f1
RELEASE: bump to VERSION 2.1.2
damachine Jan 31, 2026
e9763ac
Merge branch 'master' into feat-plugin
damachine Jan 31, 2026
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
2 changes: 1 addition & 1 deletion VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.1.1
2.1.2
5 changes: 5 additions & 0 deletions etc/coolercontrol/plugins/coolerdash/ui/cc-plugin-lib.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,11 @@ const close = () => {
window.parent.postMessage({ type: 'close' }, document.location.origin)
}

/* Restart the daemon & UI. This has the effect of applying any plugin changes to service configs. */
const restart = () => {
window.parent.postMessage({ type: 'restart' }, document.location.origin)
}

// Data Exchange Functions
/////////////////////////////////////////////////////////////

Expand Down
101 changes: 62 additions & 39 deletions etc/coolercontrol/plugins/coolerdash/ui/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -714,10 +714,9 @@ <h3 style="margin: 24px 0 16px; font-size: 16px; color: var(--text-dim);">Labels
</div>

<!-- Restart Notice -->
<div style="margin-top: 16px; padding: 12px; background: rgba(255, 140, 0, 0.1); border-left: 3px solid #ff8c00; border-radius: 4px;">
<p style="margin: 0; color: var(--text-primary); font-size: 13px;">
<strong>Important:</strong> After saving, restart the plugin to apply changes:<br>
<code style="background: rgba(0,0,0,0.3); padding: 2px 6px; border-radius: 3px; font-size: 12px; margin-top: 4px; display: inline-block;">systemctl restart cc-plugin-coolerdash.service</code>
<div style="margin-top: 16px; padding: 12px; background: rgba(255, 140, 0, 0.05); border-left: 3px solid #ff8c00; border-radius: 4px;">
<p style="margin: 0; color: var(--text-dim); font-size: 13px;">
<strong>Note:</strong> Changes are applied immediately — the plugin will be restarted automatically after Save or Reset.
</p>
</div>
</div>
Expand Down Expand Up @@ -1068,23 +1067,19 @@ <h3 style="margin: 24px 0 16px; font-size: 16px; color: var(--text-dim);">Labels
console.log("Saving config:", config);

try {
// 1. Save to CoolerControl plugin system (for UI persistence)
await savePluginConfig(config);
console.log("Config saved to CoolerControl");

// 2. Write to config.json (for daemon consumption)
//Write to config.json (for daemon consumption)
const writeSuccess = await writeConfigToFile(config);

// 3. Show success message with restart instructions
alert(
"Configuration saved successfully!\n\n" +
"Plugin restart required to apply changes.\n\n" +
"Simply run:\n" +
"systemctl restart cc-plugin-coolerdash.service"
);
//Arrange restart to happen after plugin confirms config save (short delay to allow file write)
requestRestartAfterSave(1000);

//Save to CoolerControl plugin system (for UI persistence) — this triggers configSaved and the restart callback
await savePluginConfig(config);

alert("Configuration saved successfully!\n\nChanges are applied immediately — the plugin will be restarted automatically after Save or Reset.");

// Close window after successful save
setTimeout(() => window.close(), 100);
// Close window after short delay
setTimeout(() => window.close(), 300);

} catch (error) {
console.error("Save failed:", error);
Expand Down Expand Up @@ -1147,10 +1142,41 @@ <h3 style="margin: 24px 0 16px; font-size: 16px; color: var(--text-dim);">Labels
}
}

// Request a restart shortly after a successful config save.
// Uses the plugin API's successfulConfigSaveCallback if available, otherwise listens for a configSaved postMessage.
function requestRestartAfterSave(delayMs = 800) {
const doRestart = () => {
try {
if (typeof restart === 'function') {
// restart() is provided by cc-plugin-lib and posts a message to the parent
restart();
} else {
// fallback: attempt API-based restart
const cfg = buildConfig();
restartPluginDaemon(cfg);
}
} catch (e) {
console.warn('Restart attempt failed:', e);
}
};

if (typeof successfulConfigSaveCallback === 'function') {
successfulConfigSaveCallback(() => setTimeout(doRestart, delayMs));
} else {
const handler = (event) => {
if (event.data && event.data.type === 'configSaved') {
window.removeEventListener('message', handler);
setTimeout(doRestart, delayMs);
}
};
window.addEventListener('message', handler);
}
}

// Write config to config.json via update script
async function writeConfigToFile(config) {
try {
// Method 1: Try to write via REST API (requires authentication)
// Try to write via REST API (requires authentication)
const apiAddress = config.daemon?.address || 'http://localhost:11987';
const password = config.daemon?.password || '';

Expand All @@ -1171,7 +1197,7 @@ <h3 style="margin: 24px 0 16px; font-size: 16px; color: var(--text-dim);">Labels
}
}

// Method 2: Fallback - Use local file write
// Fallback - Use local file write
// Create a JSON file blob and download it as workaround
const blob = new Blob([JSON.stringify(config, null, 2)], { type: 'application/json' });
const url = URL.createObjectURL(blob);
Expand Down Expand Up @@ -1202,11 +1228,7 @@ <h3 style="margin: 24px 0 16px; font-size: 16px; color: var(--text-dim);">Labels
// Reset to defaults
async function resetConfig() {
try {
// 1. Write factory defaults to CoolerControl plugin storage
await savePluginConfig(FACTORY_DEFAULTS);
console.log("Factory defaults saved to CoolerControl");

// 2. Write to config.json file
// Write to config.json file (daemon consumption)
try {
await writeConfigToFile(FACTORY_DEFAULTS);
console.log("Factory defaults written to config.json");
Expand All @@ -1216,19 +1238,20 @@ <h3 style="margin: 24px 0 16px; font-size: 16px; color: var(--text-dim);">Labels
console.info(JSON.stringify(FACTORY_DEFAULTS, null, 2));
}

// 3. Update form with factory defaults
// Update form with factory defaults
populateForm(FACTORY_DEFAULTS);

console.log("Reset to factory defaults - config.json overwritten");
alert(
'Configuration reset to factory defaults!\n\n' +
'Changes saved to CoolerControl.\n\n' +
'Plugin restart required:\n' +
'systemctl restart cc-plugin-coolerdash.service'
);
// Arrange restart to happen after plugin confirms config save (short delay to allow file write)
requestRestartAfterSave(1000);

// Save factory defaults to CoolerControl plugin storage (this triggers configSaved)
await savePluginConfig(FACTORY_DEFAULTS);
console.log("Factory defaults saved to CoolerControl");

alert('Configuration reset to factory defaults!\n\nChanges are applied immediately — the plugin will be restarted automatically after Save or Reset.');

// Close window after successful reset
setTimeout(() => window.close(), 100);
// Close window after short delay
setTimeout(() => window.close(), 300);
} catch (error) {
console.error("Failed to reset config:", error);
alert('Failed to reset configuration:\n\n' + error.message);
Expand All @@ -1240,14 +1263,14 @@ <h3 style="margin: 24px 0 16px; font-size: 16px; color: var(--text-dim);">Labels
try {
console.log("Initializing CoolerDash UI...");

// 1. Load defaults from config.json
// Load defaults from config.json
await loadDefaultConfig();

// 2. Load user config from CoolerControl
// Load user config from CoolerControl
let config = await getPluginConfig();
console.log("User config:", config);

// 3. Merge with defaults
// Merge with defaults
if (!config || Object.keys(config).length === 0) {
console.log("Using defaults");
config = DEFAULT_CONFIG;
Expand All @@ -1265,7 +1288,7 @@ <h3 style="margin: 24px 0 16px; font-size: 16px; color: var(--text-dim);">Labels
};
}

// 4. Display in UI
// Display in UI
populateForm(config);
console.log("UI initialized");
} catch (error) {
Expand Down