Skip to content

Make HW settings configurable #100

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
merged 2 commits into from
Oct 6, 2025
Merged

Make HW settings configurable #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e701d4a
Add configuration to swap blue and red. Fix for #96
aschoelzhorn Oct 3, 2025
ee2f674
Add Web configuration for HW parameter: driver, i2c speed, E pin
aschoelzhorn Oct 3, 2025
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
17 changes: 16 additions & 1 deletion firmware/lib/cw-commons/CWPreferences.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ struct ClockwiseParams
Preferences preferences;

const char* const PREF_SWAP_BLUE_GREEN = "swapBlueGreen";
const char* const PREF_SWAP_BLUE_RED = "swapBlueRed";
const char* const PREF_USE_24H_FORMAT = "use24hFormat";
const char* const PREF_DISPLAY_BRIGHT = "displayBright";
const char* const PREF_DISPLAY_ABC_MIN = "autoBrightMin";
Expand All @@ -25,8 +26,12 @@ struct ClockwiseParams
const char* const PREF_CANVAS_SERVER = "canvasServer";
const char* const PREF_MANUAL_POSIX = "manualPosix";
const char* const PREF_DISPLAY_ROTATION = "displayRotation";
const char* const PREF_DRIVER = "driver";
const char* const PREF_I2CSPEED = "i2cSpeed";
const char* const PREF_E_PIN = "E_pin";

bool swapBlueGreen;
bool swapBlueRed;
bool use24hFormat;
uint8_t displayBright;
uint16_t autoBrightMin;
Expand All @@ -40,7 +45,9 @@ struct ClockwiseParams
String canvasServer;
String manualPosix;
uint8_t displayRotation;

uint8_t driver;
uint32_t i2cSpeed;
uint8_t E_pin;

ClockwiseParams() {
preferences.begin("clockwise", false);
Expand All @@ -56,6 +63,7 @@ struct ClockwiseParams
void save()
{
preferences.putBool(PREF_SWAP_BLUE_GREEN, swapBlueGreen);
preferences.putBool(PREF_SWAP_BLUE_RED, swapBlueRed);
preferences.putBool(PREF_USE_24H_FORMAT, use24hFormat);
preferences.putUInt(PREF_DISPLAY_BRIGHT, displayBright);
preferences.putUInt(PREF_DISPLAY_ABC_MIN, autoBrightMin);
Expand All @@ -69,11 +77,15 @@ struct ClockwiseParams
preferences.putString(PREF_CANVAS_SERVER, canvasServer);
preferences.putString(PREF_MANUAL_POSIX, manualPosix);
preferences.putUInt(PREF_DISPLAY_ROTATION, displayRotation);
preferences.putUInt(PREF_DRIVER, driver);
preferences.putUInt(PREF_I2CSPEED, i2cSpeed);
preferences.putUInt(PREF_E_PIN, E_pin);
}

void load()
{
swapBlueGreen = preferences.getBool(PREF_SWAP_BLUE_GREEN, false);
swapBlueRed = preferences.getBool(PREF_SWAP_BLUE_RED, false);
use24hFormat = preferences.getBool(PREF_USE_24H_FORMAT, true);
displayBright = preferences.getUInt(PREF_DISPLAY_BRIGHT, 32);
autoBrightMin = preferences.getUInt(PREF_DISPLAY_ABC_MIN, 0);
Expand All @@ -87,6 +99,9 @@ struct ClockwiseParams
canvasServer = preferences.getString(PREF_CANVAS_SERVER, "raw.githubusercontent.com");
manualPosix = preferences.getString(PREF_MANUAL_POSIX, "");
displayRotation = preferences.getUInt(PREF_DISPLAY_ROTATION, 0);
driver = preferences.getUInt(PREF_DRIVER, 0);
i2cSpeed = preferences.getUInt(PREF_I2CSPEED, (uint32_t)8000000);
E_pin = preferences.getUInt(PREF_E_PIN, 18);
}

};
12 changes: 12 additions & 0 deletions firmware/lib/cw-commons/CWWebServer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ struct ClockwiseWebServer
ClockwiseParams::getInstance()->autoBrightMax = value.substring(5,9).toInt();
} else if (key == ClockwiseParams::getInstance()->PREF_SWAP_BLUE_GREEN) {
ClockwiseParams::getInstance()->swapBlueGreen = (value == "1");
} else if (key == ClockwiseParams::getInstance()->PREF_SWAP_BLUE_RED) {
ClockwiseParams::getInstance()->swapBlueRed = (value == "1");
} else if (key == ClockwiseParams::getInstance()->PREF_USE_24H_FORMAT) {
ClockwiseParams::getInstance()->use24hFormat = (value == "1");
} else if (key == ClockwiseParams::getInstance()->PREF_LDR_PIN) {
Expand All @@ -127,6 +129,12 @@ struct ClockwiseWebServer
ClockwiseParams::getInstance()->manualPosix = value;
} else if (key == ClockwiseParams::getInstance()->PREF_DISPLAY_ROTATION) {
ClockwiseParams::getInstance()->displayRotation = value.toInt();
} else if (key == ClockwiseParams::getInstance()->PREF_DRIVER) {
ClockwiseParams::getInstance()->driver = value.toInt();
} else if (key == ClockwiseParams::getInstance()->PREF_I2CSPEED) {
ClockwiseParams::getInstance()->i2cSpeed = value.toInt();
} else if (key == ClockwiseParams::getInstance()->PREF_E_PIN) {
ClockwiseParams::getInstance()->E_pin = value.toInt();
}
ClockwiseParams::getInstance()->save();
client.println("HTTP/1.0 204 No Content");
Expand Down Expand Up @@ -154,6 +162,7 @@ struct ClockwiseWebServer
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_DISPLAY_ABC_MIN, ClockwiseParams::getInstance()->autoBrightMin);
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_DISPLAY_ABC_MAX, ClockwiseParams::getInstance()->autoBrightMax);
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_SWAP_BLUE_GREEN, ClockwiseParams::getInstance()->swapBlueGreen);
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_SWAP_BLUE_RED, ClockwiseParams::getInstance()->swapBlueRed);
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_USE_24H_FORMAT, ClockwiseParams::getInstance()->use24hFormat);
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_LDR_PIN, ClockwiseParams::getInstance()->ldrPin);
client.printf(HEADER_TEMPLATE_S, ClockwiseParams::getInstance()->PREF_TIME_ZONE, ClockwiseParams::getInstance()->timeZone.c_str());
Expand All @@ -163,6 +172,9 @@ struct ClockwiseWebServer
client.printf(HEADER_TEMPLATE_S, ClockwiseParams::getInstance()->PREF_CANVAS_SERVER, ClockwiseParams::getInstance()->canvasServer.c_str());
client.printf(HEADER_TEMPLATE_S, ClockwiseParams::getInstance()->PREF_MANUAL_POSIX, ClockwiseParams::getInstance()->manualPosix.c_str());
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_DISPLAY_ROTATION, ClockwiseParams::getInstance()->displayRotation);
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_DRIVER, ClockwiseParams::getInstance()->driver);
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_I2CSPEED, ClockwiseParams::getInstance()->i2cSpeed);
client.printf(HEADER_TEMPLATE_D, ClockwiseParams::getInstance()->PREF_E_PIN, ClockwiseParams::getInstance()->E_pin);

client.printf(HEADER_TEMPLATE_S, "CW_FW_VERSION", CW_FW_VERSION);
client.printf(HEADER_TEMPLATE_S, "CW_FW_NAME", CW_FW_NAME);
Expand Down
36 changes: 34 additions & 2 deletions firmware/lib/cw-commons/SettingsWebPage.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ const char SETTINGS_PAGE[] PROGMEM = R""""(
save: "updatePreference('swapBlueGreen', Number(swapBG.checked))",
property: "swapBlueGreen"
},
{
title: "Swap Blue/Red pins?",
description: "Swap Blue and Red pins",
formInput: "<input class='w3-check' type='checkbox' id='swapBR' " + (settings.swapbluered == '1' ? "checked" : "") + "><label for='swapBR'> Yep</label>",
icon: "fa-random",
save: "updatePreference('swapBlueRed', Number(swapBR.checked))",
property: "swapBlueRed"
},
{
title: "Timezone",
description: "Consult your TZ identifier <a href='https://en.wikipedia.org/wiki/List_of_tz_database_time_zones'>here.</a> Examples: America/Sao_Paulo, Europe/Lisbon",
Expand Down Expand Up @@ -143,7 +151,31 @@ const char SETTINGS_PAGE[] PROGMEM = R""""(
icon: "fa-rotate-right",
save: "updatePreference('displayRotation', rotation.value)",
property: "displayRotation"
}
},
{
title: "Matrix Shift Driver",
description: "Hardware-specific chips used to drive matrix modules (default: SHIFTREG).",
formInput: "<select name='driver' id='driver'><option value='0'" + (settings.driver == 0 ? " selected='selected'" : "") + ">SHIFTREG</option><option value='1'" + (settings.driver == 1 ? " selected='selected'" : "") + ">FM6124</option><option value='2'" + (settings.driver == 2 ? " selected='selected'" : "") + ">FM6126A</option><option value='3'" + (settings.driver == 3 ? " selected='selected'" : "") + ">ICN2038S</option><option value='4'" + (settings.driver == 4 ? " selected='selected'" : "") + ">MBI5124</option><option value='5'" + (settings.driver == 5 ? " selected='selected'" : "") + ">DP3246</option></select>",
icon: "fa-microchip",
save: "updatePreference('driver', driver.value)",
property: "driver"
},
{
title: "I2C Speed",
description: "I2S clock speed selector (default: HZ_8M).",
formInput: "<select name='speed' id='speed'><option value='8000000'" + (settings.i2cspeed == 8000000 ? " selected='selected'" : "") + ">HZ_8M</option><option value='16000000'" + (settings.i2cspeed == 16000000 ? " selected='selected'" : "") + ">HZ_16M</option><option value='20000000'" + (settings.i2cspeed == 20000000 ? " selected='selected'" : "") + ">HZ_20M</option></select>",
save: "updatePreference('i2cSpeed', speed.value)",
icon: "fa-microchip",
property: "i2cSpeed"
},
{
title: "E Pin",
description: "E pin is Address Line E used for 64-row LED panels to select specific rows (default: 18).",
formInput: "<input id='E_pin' class='w3-input w3-light-grey' name='E_pin' type='number' min='0' max='32' value='" + settings.e_pin + "'>",
icon: "fa-microchip",
save: "updatePreference('E_pin', E_pin.value)",
property: "E_pin"
}
];

var base = document.querySelector('#base');
Expand Down Expand Up @@ -229,7 +261,7 @@ const char SETTINGS_PAGE[] PROGMEM = R""""(
}

//Local
//createCards({ "displayBright": 30, "swapBlueGreen": 1, "use24hFormat": 0, "timeZone": "Europe/Lisbon", "ntpServer": "pool.ntp.org", "wifiSsid": "test", "autoBrightMin":0, "autoBrightMax":800, "ldrPin":35, "cw_fw_version":"1.2.2", "clockface_name":"cw-cf-0x07", "canvasServer":"raw.githubusercontent.com", "canvasFile":"star-wars.json" });
//createCards({ "displayBright": 30, "swapBlueGreen": 1, "swapBlueRed": 0, "use24hFormat": 0, "timeZone": "Europe/Lisbon", "ntpServer": "pool.ntp.org", "wifiSsid": "test", "autoBrightMin":0, "autoBrightMax":800, "ldrPin":35, "driver":1, "i2cspeed":16000000, "e_pin":18, "cw_fw_version":"1.2.2", "clockface_name":"cw-cf-0x07", "canvasServer":"raw.githubusercontent.com", "canvasFile":"star-wars.json" });

//Embedded
begin();
Expand Down
40 changes: 37 additions & 3 deletions firmware/src/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,17 @@ bool autoBrightEnabled;
long autoBrightMillis = 0;
uint8_t currentBrightSlot = -1;

void displaySetup(bool swapBlueGreen, uint8_t displayBright, uint8_t displayRotation)
bool isValidI2SSpeed(uint32_t speed) {
return speed == 8000000 || speed == 16000000 || speed == 20000000;
}

bool isValidDriver(uint32_t drv) {
return drv >= 0 && drv <= 5;
}



void displaySetup(bool swapBlueGreen, bool swapBlueRed, uint8_t displayBright, uint8_t displayRotation, uint8_t driver, uint32_t i2cSpeed, uint8_t E_pin)
{
HUB75_I2S_CFG mxconfig(64, 64, 1);

Expand All @@ -39,9 +49,29 @@ void displaySetup(bool swapBlueGreen, uint8_t displayBright, uint8_t displayRota
mxconfig.gpio.g2 = 13;
}

mxconfig.gpio.e = 18;
if (swapBlueRed)
{
// Swap Blue and Red pins.
mxconfig.gpio.b1 = 25;
mxconfig.gpio.b2 = 14;
mxconfig.gpio.r1 = 27;
mxconfig.gpio.r2 = 13;
}

mxconfig.gpio.e = E_pin;
mxconfig.clkphase = false;

if (isValidDriver(driver)) {
mxconfig.driver = static_cast<HUB75_I2S_CFG::shift_driver>(driver);
} else {
Serial.printf("[ERROR] Invalid driver from config:%d\n", driver);
}
if (isValidI2SSpeed(i2cSpeed)) {
mxconfig.i2sspeed = static_cast<HUB75_I2S_CFG::clk_speed>(i2cSpeed);
} else {
Serial.printf("[ERROR] Invalid I2S speed from config:%d\n", i2cSpeed);
}

// Display Setup
dma_display = new MatrixPanel_I2S_DMA(mxconfig);
dma_display->begin();
Expand Down Expand Up @@ -89,7 +119,11 @@ void setup()

pinMode(ClockwiseParams::getInstance()->ldrPin, INPUT);

displaySetup(ClockwiseParams::getInstance()->swapBlueGreen, ClockwiseParams::getInstance()->displayBright, ClockwiseParams::getInstance()->displayRotation);
uint8_t driver = ClockwiseParams::getInstance()->driver;
uint32_t i2cSpeed = ClockwiseParams::getInstance()->i2cSpeed;
uint8_t E_pin = ClockwiseParams::getInstance()->E_pin;

displaySetup(ClockwiseParams::getInstance()->swapBlueGreen, ClockwiseParams::getInstance()->swapBlueRed, ClockwiseParams::getInstance()->displayBright, ClockwiseParams::getInstance()->displayRotation, driver, i2cSpeed, E_pin);
clockface = new Clockface(dma_display);

autoBrightEnabled = (ClockwiseParams::getInstance()->autoBrightMax > 0);
Expand Down