MatrixClock Improved Firmware v3.1.0

An enhanced public-release firmware for the original HACK LABS MatrixClock hardware, maintained and extended by Steve Madden. This release is derived from the HACK LABS MatrixClock v2.2 package and is for the ESP8266-based 4 MB MatrixClock board only.

The original HACK LABS attribution is retained in the source. This modified build is licensed under GNU GPL v3; see LICENSE.

Original project source: HACK Labs MatrixClock.

The retained v3.0.0 clean 4 MB recovery image remains available for a full USB recovery install. It should be followed by this v3.1.0 OTA update.

The original-firmware archive is too large for the normal repository upload workflow. Attach it to the GitHub Release, alongside the two firmware binaries, rather than committing it to the repository.

These screenshots were captured from a running v3.1.0 clock. Network-specific values have been blurred for privacy; calibration figures and selected settings are examples from that installation and will differ on another clock. No passwords or web authentication credentials are shown.

MatrixClock v3.1.0 main page

MatrixClock v3.1.0 settings page

MatrixClock v3.1.0 firmware update page

• Use this firmware only on the matching ESP8266 MatrixClock hardware with 4 MB flash.
• The OTA file is the tested upgrade path from the original HACK LABS firmware on compatible hardware.
• The v3.0.0 full 4 MB factory image overwrites the entire flash. It remains the recovery option for a failed OTA update or an unknown/older compatible firmware; update it to v3.1.0 through the web OTA page afterwards.
• Neither firmware image should be written to a different ESP8266 product.
• Web authentication and the API are designed for a trusted local network. They use HTTP, not HTTPS; do not expose the clock directly to the internet or forward its web port. Use a VPN for remote access instead.

After a clean install, the clock starts its open setup access point:

Wi-Fi name: MatrixClock
Setup address: http://192.168.4.1/

Connect a phone or computer to that Wi-Fi network, open the setup address, choose the home Wi-Fi network, enter its password, and save. Once the clock reconnects to the home network, open the IP address shown on its boot-up display. To show the address again, press the hardware reset button to restart the device.

The normal web interface includes all clock, timezone, NTP, chronograph, display, API, authentication, calibration, and firmware-update settings.

MatrixClock_Improved_v3_1_0_OTA.bin is an OTA update for compatible MatrixClock Improved installations. The original v3.0.0 OTA update was tested from the original HACK LABS firmware on compatible 4 MB ESP8266 MatrixClock hardware. This provides a direct web-based upgrade path from the original firmware; the full 4 MB factory image is not required for a normal upgrade.

1. Find the clock's current IP address on the local network.
2. Open http://<device-ip>/update in a browser. For example: http://192.168.0.10/update.
3. Sign in to the original firmware's update page with:
   • Username: nick
   • Password: nick
4. Select MatrixClock_Improved_v3_1_0_OTA.bin.
5. Start the update and wait for the clock to restart. Do not remove power or reset the clock while the firmware is being written.
6. Follow the MatrixClock Improved first-use setup shown after restart. If the clock cannot reuse the existing Wi-Fi profile, connect to the open MatrixClock setup network and open http://192.168.4.1.

1. Find the clock's current IP address.
2. Open http://<device-ip>/update in a browser.
3. Sign in with the clock's current username and password if web security is enabled.
4. Select MatrixClock_Improved_v3_1_0_OTA.bin.
5. Select Upload and reboot and wait for the clock to restart. Do not remove power during the update.

A newly reset MatrixClock Improved installation asks you to choose credentials on its first normal-page visit. Leave both fields blank to keep local web access open.

The OTA page must never be given the 4 MB factory image.

Use the v3.0.0 factory image when the clock cannot be reached over the web interface, or when a completely clean installation is wanted. Once recovered, install the v3.1.0 OTA file through the web interface.

1. Install or download Espressif esptool. Its official ESP8266 command documentation explains drivers and serial-port selection.
2. Connect the MatrixClock by USB and close Arduino Serial Monitor or any other program using the COM port.
3. Replace COM3 below with the clock's Windows COM port:

esptool --chip esp8266 --port COM3 --baud 115200 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size 4MB 0x0 MatrixClock_Improved_v3_0_0_Factory_4MB.bin

The factory image already covers the whole flash, so a separate erase_flash command is not required before writing it. It will erase all existing firmware, Wi-Fi data, settings, and saved calibration information.

HACK_LABS_MatrixClock_v2_2_Original_Archive.rar is supplied as an optional release asset. It is an unmodified archive of the original HACK LABS MatrixClock v2.2 package, included for provenance, reference, and optional rollback only. It contains the original source, firmware binaries, hardware files, README, and GPL v3 license.

It is not required to install or use MatrixClock Improved Firmware v3.1.0.

This release was built using Arduino IDE with the ESP8266 board package 3.1.2.

Use these build settings:

Board: NodeMCU 1.0 (ESP-12E Module)
CPU frequency: 80 MHz
Flash size: 4 MB
Flash mode: DIO
Upload speed: 115200

1. Install the ESP8266 boards package if it is not already present.
2. Open MatrixClock_Improved_v3_1_0.ino from its matching folder.
3. Select Tools > Board > ESP8266 Boards > NodeMCU 1.0 (ESP-12E Module).
4. Select the clock's serial port.
5. Ensure the board is configured for 4 MB flash, then use Verify or Upload.

The libraries used by this sketch (SPI, Ticker, ESP8266WiFi, ESP8266WebServer, EEPROM, WiFiUdp, Wire, and time) are provided by the ESP8266 board package; no separate library downloads are required.

The web page shows the current API address. In the examples below, CLOCK-IP means the clock's current LAN IP address, shown on the clock during startup and on its web page. A DHCP lease can change this address after a reboot. For reliable Home Assistant use, reserve a fixed address for the clock in the router (DHCP reservation/static lease), then use that address in the API configuration. To send a message from a system on the same network, make a form-encoded HTTP POST request:

POST http://CLOCK-IP/api/message
Content-Type: application/x-www-form-urlencoded
message=MatrixClock v3.1.0&scrolls=2

If web security is enabled, include the MatrixClock username and password. PowerShell can prompt for them without putting the password in your command history:

$credential = Get-Credential
Invoke-WebRequest `
 -Uri "http://CLOCK-IP/api/message" `
 -Method POST `
 -Credential $credential `
 -ContentType "application/x-www-form-urlencoded" `
 -Body "message=MatrixClock v3.1.0&scrolls=2"

For Home Assistant, store the credentials in secrets.yaml and use a REST command:

rest_command:
 matrixclock_message:
 url: "http://CLOCK-IP/api/message"
 method: POST
 username: !secret matrixclock_username
 password: !secret matrixclock_password
 content_type: "application/x-www-form-urlencoded"
 payload: "message={{ message }}&scrolls={{ scrolls | default(1) }}"

Call it with a service action such as:

action: rest_command.matrixclock_message
data:
 message: "Bin day tomorrow"
 scrolls: 2

Leave the MatrixClock username and password blank to disable web security; in that case the API does not require credentials. Messages are local-network only, use HTTP rather than HTTPS, and are unavailable while the chronograph is open. They can be cancelled from the clock's web page or physical button.

The DS3231 RTC temperature shown in Device info is also available as a lightweight numeric API response:

GET http://CLOCK-IP/api/temperature

{"temperature_c":22.25}

Home Assistant can poll it once per minute without opening the clock's main page or its live-display connection:

rest:
 - resource: "http://CLOCK-IP/api/temperature"
 authentication: basic
 username: !secret matrixclock_username
 password: !secret matrixclock_password
 scan_interval: 60
 sensor:
 - name: MatrixClock RTC temperature
 unique_id: matrixclock_rtc_temperature
 value_template: "{{ value_json.temperature_c }}"
 device_class: temperature
 state_class: measurement
 unit_of_measurement: "°C"

Omit authentication, username, and password when MatrixClock web security is disabled. This is the RTC's internal temperature and should not be treated as a calibrated room-temperature measurement.

On Windows, run this from the release folder:

certutil -hashfile MatrixClock_Improved_v3_1_0_OTA.bin SHA256
certutil -hashfile MatrixClock_Improved_v3_0_0_Factory_4MB.bin SHA256

Compare both results with SHA256SUMS.txt. The corresponding source is maintained in this repository.

The original HACK LABS MatrixClock notices remain in the source header. The complete modified source and any distributed firmware binaries are released under GNU GPL version 3. See LICENSE and CHANGELOG.md.

This project is provided without warranty. Flashing firmware is undertaken at your own risk.