LISYclock Config Editor – User Manual

Version 1.11 | Language: English

Table of Contents

1. Overview
2. Requirements & Getting Started
3. File Operations
4. Tab: Clock
5. Tab: General
6. Tab: Events
7. Tab: GI LEDs
8. Tab: Attract Mode
9. Tab: TTS Settings
10. Tab: Update
11. Tab: Debug
12. config.txt – Format & Structure
13. Tips & Notes

1. Overview

The LISYclock Config Editor is a tool for conveniently editing the config.txt configuration file of the LISYclock.

• Standalone application: a single LISYclock_config_editor.html file, no server, no build step
• Simply open LISYclock_config_editor.html in your browser and get started
• Supports direct upload/download to the LISYclock hardware via IP (HTTP) or USB

2. Requirements & Getting Started

Browser

Starting

1. Open LISYclock_config_editor.html from the project directory locally in your browser (double-click or File → Open)
2. The application starts immediately with an empty default configuration

Important: For direct communication with the LISYclock via IP (tab “Clock”), the file must be opened via file:// – not via HTTPS. Browsers block HTTP requests from HTTPS pages for security reasons. USB mode works regardless of how the file is opened.

3. File Operations

The buttons in the navigation bar (top) control all file operations:

The current filename is displayed in the center of the navigation bar. As long as no file has been opened, “— no file open —” appears there.

4. Tab: Clock

This tab enables direct communication with the LISYclock hardware. Choose between IP Mode (WiFi) and USB Mode (USB cable).

Connection Mode

Select the connection type using the radio buttons at the top of the tab:

IP Mode

Enter the IP address of your LISYclock (e.g. 192.168.1.42). The address is saved in the browser and automatically pre-filled the next time you open the editor.

Clicking Connect Clock checks whether the clock is reachable:

On successful connection, the firmware version and API version are shown. If the API version does not match the expected version, a warning is displayed (functions may still be partially usable).

USB Mode

Click Connect USB to establish the connection. The status dot indicates the state:

Note: The clock reboots once when you click Connect USB. This is normal — the reboot triggers the USB handshake. Wait for the status to show Connected.

Test WiFi Connection (USB only)

When connected via USB, click Test WiFi Connection to send the SSID and password from the General tab to the clock and verify the WiFi connection. The status dot shows the result.

Config Transfer

Set Clock Time

Clicking Set Clock Time from PC synchronizes the clock’s time with the PC’s current date and time.

Reboot Clock

Clicking Reboot Clock restarts the LISYclock. A confirmation dialog prevents accidental restarts.

Upload File to Clock

Transfer any file (e.g. MP3, batch file) to the clock’s SD card.

SD Card Files

• Use Refresh to load the current file list from the SD card
  • The list shows name, size, and modification date for each file
  • Individual files can be downloaded, renamed, or deleted

Protocol Log (USB only)

When in USB mode, a protocol log panel shows all serial communication between the editor and the clock.

HTTPS Warning

If the editor is opened via an HTTPS URL, the browser blocks all HTTP requests to the clock. Solution: open LISYclock_config_editor.html locally via file://.

5. Tab: General

General settings for the LISYclock.

WiFi Settings

WiFi credentials are stored in config.txt. Use Test WiFi Connection in the Clock tab (USB mode) to verify that the credentials work.

Display Brightness

Value from 0 (dark) to 7 (maximum brightness). Corresponds to the configuration key DISP_BRIGHT.

FTP Server

Timezone

Example for Central Europe with daylight saving time:

CET-1CEST,M3.5.0,M10.5.0/3

Weekday Strings

When enabled, the clock displays localized weekday names. Each of the 7 fields (Sunday–Saturday) may be at most 6 characters long. Shorter entries are automatically padded with spaces to 6 characters.

Example (English): Sun, Mon, Tue, Wed, Thu, Fri, Sat

6. Tab: Events

Events define time-controlled actions of the LISYclock.

Event Types

Time Format

The time of an event is specified as HH:MM:W or HH:MM-DD.MM.YYYY. * stands for “any” in each field.

Weekday Mode: HH:MM:W

Date Mode: HH:MM-DD.MM.YYYY

Active when * (date) is selected in the weekday field. The date field then appears additionally.

Examples

Controls

• + Add Event (top-right button): Adds a new event entry at the end of the list
• ✕ (to the right of an event): Removes that event

7. Tab: GI LEDs

Defines the start colors of the GI LEDs (General Illumination).

Fields per LED Row

The color picker and RGB fields are synchronized: a change in the picker updates the RGB fields and vice versa.

Controls

• + Add LED: Append a new LED entry at the end of the list
• ✕: Remove this LED entry

8. Tab: Attract Mode

Configures the Attract Mode lighting (running lights in standby) in 5 groups (AT1–AT5).

Each group is displayed as a collapsible accordion panel.

Settings per Group

• + Add LED: Add a new LED entry to the group
• ✕: Remove an LED entry from the group

9. Tab: TTS Settings

Settings for the Text-to-Speech function (uses the WIT.ai service).

You obtain the WIT.ai API token after free registration at wit.ai.

10. Tab: Update

The Update tab provides three ways to update the LISYclock firmware.

Upload local firmware file (IP mode only)

1. Select a .bin firmware file using the file selection button
2. Click Update & Reboot — the file is transferred to the SD card as update.bin and the clock restarts automatically to apply the update

Or select from lisy.dev

1. First connect to the clock in the Clock tab (IP mode) so the editor knows whether v1 or v2 firmware is running
2. Click Fetch versions — a dropdown appears with all matching firmware files from lisy.dev
3. Select the desired version from the dropdown
4. Click Update & Reboot — the file is downloaded from lisy.dev and transferred to the clock

When a server version is selected, it takes priority over a locally selected file.

Flash via USB (full installation, USB mode only)

Click Flash via USB to write the complete firmware package (bootloader, firmware binary, partition table, and OTA data) directly to the ESP32 via USB. No WiFi connection required.

Chrome/Edge only. A progress log is shown below the button during flashing. Do not disconnect the USB cable until flashing is complete.

11. Tab: Debug

The Debug tab provides a raw USB serial console for advanced users and developers.

Connection

Select the Baud Rate (default: 115200) and Reset Delay (default: 1500 ms), then click CONNECT. The status dot indicates the connection state:

The DTR/RTS signal states are shown in the top-right corner.

Options

Line Ending

Select the line ending appended to sent commands: NL (\n), CR+NL, CR, or None.

Console

The console shows all serial output from the ESP32 with color-coded lines: - Green: received data - Orange: system messages - Red: errors - Dark grey: boot messages (when Boot Logs is enabled)

12. config.txt – Format & Structure

Basic Format

KEY=value

• Each line contains a key and a value, separated by =
• A # at the start of a line disables the line (without deleting it)
• Capitalization of key names is normalized in the editor

Special Rules

Example Excerpt

WIFI_ENABLE=yes
WIFI_SSID="MyNetwork"
WIFI_PWD="MyPassword"
DISP_BRIGHT=5
#FTP_USER=lisy
#FTP_PWD=lisy
# TIMEZONE="CET-1CEST,M3.5.0,M10.5.0/3"
EVENT_SYNC_TIME=2:0:*,10
EVENT_SAY_TIME=14:12:*,"german"
EVENT_TTS=8:0:*,"Good morning!"

13. Tips & Notes

• Use Chrome or Edge: Only these browsers support the File System Access API for native open/save dialogs and the Web Serial API for USB mode. In Firefox and Safari, standard file pickers or download links appear instead, and USB mode is unavailable.

• Open locally for IP Clock access: If communication with the LISYclock via IP does not work, check whether LISYclock_config_editor.html is opened via file:// (locally) and not via https://.

• FTP as alternative: The finished config.txt can also be transferred to the clock’s SD card via FTP (if the FTP server is enabled in the configuration).

• Unknown keys: If the editor encounters unknown keys when loading, it ignores them and displays a warning banner listing the affected lines. They are not retained when saving. If you have custom extensions in config.txt, back them up separately beforehand.

• No undo function: The editor has no undo function. If you make accidental changes, reopening the file (without saving first) will restore the previous state.

• USB connection shared between tabs: When a USB connection is established in the Clock tab, it is automatically shared with the Debug tab and vice versa. There is only one USB connection at a time.

Created for LISYclock Config Editor v1.11