Ize Compose v1.1.1

Ize Compose

Multilingual writing firmware for the Zerowriter Ink (Inkplate 5 V2). Started as a Korean-input firmware, now supports 92 keyboard layouts across dozens of scripts.

---

Supported Device

• Zerowriter Ink (Inkplate 5 V2)
  • ESP32, 800×600 monochrome e-ink display
  • Requires SD card for non-Latin fonts and document storage

---

Features

Writing

• Plain-text editing with cursor navigation
• Phonetic Korean composition (cho/jung/jong jamo assembly)
• Latin accent cycling (e.g., a → á → â → ã → ...)
• Right-to-left (RTL) text mode for Arabic-script layouts
• Text search (Ctrl+F)
• Copy / paste (Ctrl+C / Ctrl+V)
• Word and character count (3 display modes)

Keyboard & Language

• 92 keyboard layouts selectable from the system menu
• Two independent layout slots: one for English (QWERTY or Dvorak), one for a second language
• 12 script composition engines: Korean, Arabic, Indic scripts, Thai, Myanmar, Khmer, Lao, Tibetan, Sinhala, Ethiopic, Japanese, Hebrew
• RTL layout support: Arabic, Hebrew, Kurdish (Arabic), Pashto, Persian, Urdu

Files

• Saves and loads .txt files on SD card (/ize_compose/)
• File browser (up to 65 files)
• WiFi (AP mode) for uploading/downloading text and firmware OTA via browser

Display

• Partial screen update for fast typing feedback
• Configurable full-refresh threshold
• Boot/sleep image loaded from /ize_compose/initial.png on SD card
• Sleep mode: Ctrl+L or sleep button; wake with wake button

Settings (system menu)

• Line spacing
• Typing speed (key repeat delay)
• Screen refresh limit
• Keyboard layout selection
• Font slot

---

Keyboard Layouts (92)

Dvorak, QWERTY, 한국어, Shqip, العربية, Հայերեն, Deutsch (AT/DE/CH), Azərbaycanca, Беларуская, Nederlands (BE/NL), বাংলা, Bosanski / Босански, Português (BR/PT), Български, Français (CA/FR/CH), Català, Hrvatski, Čeština, Dansk, देवनागरी, Eesti, ኢትዮጵያ, Føroyskt, Suomi, Georgian, Ελληνικά, ગુજરાતી, Hausa, עברית, Magyar, Íslenska, Gaeilge, Italiano, 日本語, ಕನ್ನಡ, Qazaq / Қазақ, ខ្មែរ, Kurdî / کوردی, Кыргызча, ລາວ, Español América, Latviešu, Lietuvių, Lëtzebuergesch, മലയാളം, Malti, Māori, Română (MD) / Молдовеняскэ, Монгол, Crnogorski / Црногорски, မြန်မာ, नेपाली, Македонски, Norsk, پښتو, فارسی, Polski, ਪੰਜਾਬੀ, Română, Русский, Srpski / Српски, සිංහල, Slovenčina, Slovenščina, Español, Kiswahili, Svenska, Тоҷикӣ, தமிழ், తెలుగు, ไทย, བོད་སྐད, Türkçe, Українська, English UK, اردو, Oʻzbek / Ўзбек, Tiếng Việt, Cymraeg

---

Font Files

Latin is embedded in the firmware. All other scripts are loaded from SD card at boot.

Place the following files in /ize_compose/hwalja/ on the SD card:

File	Scripts covered
hwalja_hangul.bin	Korean (Hangul syllables)
hwalja_jamo.bin	Korean (Jamo, composition glyphs)
hwalja_jp.bin	Japanese (Hiragana, Katakana)
hwalja_greek_cyrillic.bin	Greek, Cyrillic
hwalja_arabic.bin	Arabic, Persian, Urdu
hwalja_indic.bin	Devanagari, Bengali, Gujarati, Kannada, Malayalam, Punjabi, Tamil, Telugu, Sinhala
hwalja_sea.bin	Thai, Khmer, Lao, Myanmar, Tibetan
hwalja_misc.bin	Ethiopic, Georgian, Armenian, and others

Without these files the device still works, but only Latin text is displayed correctly.

---

Build Environment

Platform / Board / Framework

Item	Value
Platform	espressif32
Board	esp32dev + Inkplate 5 V2 build flags
Framework	Arduino
CPU clock	240 MHz
Upload / monitor speed	921600 baud

board = esp32dev is used with manual build flags rather than a dedicated Inkplate board definition. This firmware will not work on a generic ESP32 dev board — the flags and PSRAM are specific to the Inkplate 5 V2 hardware.

Libraries

Library	Version	Source
InkplateLibrary	11.0.0	lib/ (local, no separate install needed)
SdFat	2.3.1	PlatformIO registry
U8g2_for_Adafruit_GFX	1.8.0	PlatformIO registry
ESP32 BLE Keyboard	0.3.2	PlatformIO registry
Adafruit GFX Library	1.12.6	PlatformIO registry
Adafruit BusIO	—	PlatformIO registry

Build flags

Flag	Purpose
-DARDUINO_INKPLATE5V2	Board identification
-DINKPLATE_5V2	Enables correct code path inside InkplateLibrary
-DBOARD_HAS_PSRAM	Declares PSRAM presence to ESP-IDF
-mfix-esp32-psram-cache-issue	Workaround for ESP32 PSRAM cache bug (older silicon)
-DSCREEN_WIDTH=800 / -DSCREEN_HEIGHT=600	Display resolution constants
-O2 + build_unflags = -Os	Speed optimization; overrides PlatformIO's default size optimization
-D CORE_DEBUG_LEVEL=0	Suppresses all serial debug output

Flash / partition settings

Item	Value
Partition table	huge_app.csv (maximizes app partition)
Flash speed	80 MHz
Flash mode	QIO (quad I/O)

huge_app.csv is a built-in partition table provided by the PlatformIO espressif32 platform. No manual file is needed.

---

Installation

Requirements

• PlatformIO (VS Code extension or CLI)
• Zerowriter Ink (Inkplate 5 V2) with SD card

Build and flash

git clone <this repo>
cd <repo>
pio run --target upload

SD card setup

1. Format SD card as FAT32.
2. Create the folder /ize_compose/hwalja/.
3. Copy the hwalja_*.bin font files into /ize_compose/hwalja/.
4. (Optional) Place initial.png (800×600 PNG) in /ize_compose/ for the sleep/boot image.

Firmware OTA update (WiFi)

1. Open the system menu → Network → WiFi.
2. Connect to the IZE_COMPOSE access point from a PC or phone.
3. Navigate to 192.168.4.1 in a browser.
4. Upload a new .bin firmware file.

---

Keyboard Shortcuts

Shortcut	Action
Ctrl+Space	Toggle Korean / English mode
Ctrl+L	Sleep (shows boot image)
Ctrl+F	Text search
Ctrl+C	Copy all text to clipboard
Ctrl+V	Paste clipboard
Space (accent cycling)	Cycle diacritic variants for last character

---

Repository Structure

src/
  IZEcompose.ino        — main firmware
  jado.h                — keyboard layout definitions and keymaps (92 layouts)
  jeong_eum.h           — Korean composition engine and script engine types
  insoe.h               — text rendering, font selection
  EmbeddedLatinFont.h   — Latin font baked into firmware
  PsramAssets.h         — PSRAM asset loading helpers
  hwalja_*.bin          — font binary files (copy to SD card, not compiled in)

lib/
  InkplateLibrary/      — Inkplate driver (local copy)

tools/
  make_fonts.py         — script used to build hwalja_*.bin from BDF sources
  u8g2/bdfconv.exe      — BDF font converter (used by make_fonts.py)

build/
  fontbuild*/           — intermediate font build artifacts
  noto_fonts/           — source Noto font TTFs used for font building

platformio.ini          — PlatformIO build config

---

Current Limitations

• Supports only Inkplate 5 V2 (800×600). Other Inkplate boards are not tested.
• Korean cursor movement during mid-syllable composition is not supported.
• Only .txt files; no formatting.
• Single document open at a time.
• WiFi and BLE cannot be active simultaneously.
• The sleep image must be exactly 800×600 pixels; other sizes are not handled.

---

Credits

• Inkplate Arduino Library — Soldered Electronics
• U8g2_for_Adafruit_GFX — Oliver Kraus
• ESP32 BLE Keyboard — T-vK
• SdFat — Bill Greiman
• Noto Fonts — Google (used for font building; license: SIL OFL 1.1)
• Zerowriter Ink — original hardware

1.1.0

Ize Compose v1.1.0

Ize Compose now supports web-based firmware updates for ZeroWriter Ink. After this release is installed once via USB, future firmware updates can be uploaded directly from the device's local update page.

What's new

• Added working web-based firmware update support (OTA)
• Changed the firmware update filename to izefirmware.bin
• Added on-device PIN confirmation and PIN display for web uploads
• Fixed text disappearing or failing to redraw correctly during writing
• Fixed incorrect highlight rendering in Search mode
• Fixed stuck Ctrl modifier behavior after leaving network/update modes
• Improved RTL display direction for Hebrew and Arabic-script layouts
• Changed Arabic-script text handling so saved documents retain logical Unicode text rather than display-form glyphs
• Moved the Latin writing font to an external SD font file to reduce firmware size
• Added hwalja_latin.bin to the web resource upload interface
• Switched to an OTA-compatible 4 MB partition layout

Firmware update file

Upload the firmware binary using this filename:

izefirmware.bin

Important installation note

Because this release changes the flash partition layout to enable OTA, the first installation of v1.1.0 must be performed over USB.

After v1.1.0 has been installed by USB, future firmware updates can be installed from the device's web update interface.

Required SD resource

This release loads the Latin writing font from the SD card. Make sure the following file is present:

/ize_compose/hwalja/hwalja_latin.bin

Notes

Arabic-script documents created from this release onward are saved as logical Unicode text for better compatibility when opened on other devices. Arabic joining appearance on the device remains dependent on the available font glyphs.

Ize Compose 1.0

Originally created to enable Korean writing on the Zerowriter Ink, Ize Compose has grown into a multilingual writing firmware with 92 selectable keyboard layouts across a wide range of scripts.

Highlights

• Multilingual plain-text writing on the Zerowriter Ink
• 92 selectable keyboard layouts
• Korean phonetic composition with cho/jung/jong assembly
• Script-specific input handling for Arabic, Indic scripts, Thai, Myanmar, Khmer, Lao, Tibetan, Sinhala, Ethiopic, Japanese, Hebrew, and more
• Right-to-left text mode for Arabic-script layouts and Hebrew
• Latin accent cycling
• Internal clipboard copy and paste
• Text search, word count, and character count
• SD card document storage and file browser
• Configurable line spacing, typing speed, and refresh behavior
• WiFi-based text transfer and firmware OTA update mode

Important: Initial Installation

The initial firmware installation must be performed through USB-C.

On the Zerowriter Ink, the keyboard occupies the USB connection during normal use. To install Ize Compose for the first time:

1. Open the device enclosure.
2. Disconnect the keyboard cable.
3. Connect the device to a computer using USB-C.
4. Build and upload the firmware with PlatformIO.
5. Disconnect USB-C after the upload completes.
6. Reconnect the keyboard cable and close the device.

After the initial installation, future firmware updates can be performed through the built-in WiFi OTA update page without reopening the device.

SD Card Requirements

Latin characters are embedded in the firmware. Additional script fonts are loaded from the SD card.

Copy the required hwalja_*.bin font files into:

/ize_compose/hwalja/

An optional 800×600 initial.png image may be placed in:

/ize_compose/

for the boot and sleep screen.

Notes

• This firmware currently targets the Zerowriter Ink / Inkplate 5 V2 only.
• Writing mode is unavailable while WiFi or BLE transfer mode is active.
• Only plain-text .txt documents are supported.
• Keyboard layouts and script handling have been implemented across many languages, but not every layout has been validated by a native user. Corrections and feedback are welcome.

Source Code

The source code, build configuration, and installation instructions are included in this repository.

Thank you to the Zerowriter community and to everyone interested in writing in their own language on dedicated writing hardware.

Ize Compose is publicly available source firmware for personal and noncommercial use.
Commercial use requires separate permission from Dievesa.
Licensed under the PolyForm Noncommercial License 1.0.0. See the LICENSE file in the repository for details.

Rupertwriter Firmware Version 2.0.0 for the Zerowriter

🖋️ Zerowriter: Rupert Edition v2.0.0

"The Ultimate Hardware-Level Typing Experience"

---

🌍 Physical Layout Remapping (Firmware-Level)

Rupert Edition v2.0.0 solves the structural limitations of the original firmware. We have remapped the input matrix so that the machine behaves as a native device. Swap your physical keycaps, and the firmware follows.
(To select your keyboard, go to submenu(System Set) and select your language at the Latin section.

French (AZERTY) - Specialized Mapping

Full native AZERTY physical matrix mapping. Exact placements for é, è, ç, à, ù and all localized punctuation marks.

Row	Key Layout
1	² & é " ' ( - è _ ç à ) =
2	A Z E R T Y U I O P ^ $ *
3	Q S D F G H J K L M ù
4	W X C V B N , ; : !

German (QWERTZ) - Standard Precision

True 1:1 hardware mapping. Automatically swaps Z and Y. Natively supports ä, ö, ü, ß on their exact local key positions.

Row	Key Layout
1	^ 1 2 3 4 5 6 7 8 9 0 ß ´
2	Q W E R T Z U I O P Ü + #
3	A S D F G H J K L Ö Ä
4	Y X C V B N M , . -

Turkish (Turkish-Q) - Native Implementation

Hardware-level remapping for dedicated Turkish keys: ğ, ü, ş, i, ı, ö, ç.

Row	Key Layout
1	" 1 2 3 4 5 6 7 8 9 0 * -
2	Q W E R T Y U I O P Ğ Ü ,
3	A S D F G H J K L Ş İ
4	< Z X C V B N M Ö Ç .

Montenegrin (QWERTZ) - Balkan Layout

Native Balkan QWERTZ mapping with direct physical key support for š, đ, č, ć, ž.

Row	Key Layout
1	' 1 2 3 4 5 6 7 8 9 0 +
2	Q W E R T Z U I O P Š Đ Ž
3	A S D F G H J K L Č Ć
4	< Y X C V B N M , . -

🇪🇺 Universal Europe Mode (For Standard QWERTY Users)

If you prefer to keep your standard US QWERTY physical keycaps, use my built-in EU Cycle Mode.
Within 3 seconds of typing a base character, press Alt repeatedly to seamlessly cycle through its accent variations:

• a / A : á, à, â, ä, ã, æ, a
• e / E : é, è, ê, ë, e
• i / I : í, ì, î, ï, ı, i
• o / O : ó, ò, ô, ö, õ, œ, o
• u / U : ú, ù, û, ü, u
• c / C : ç, ć, č, c
• n / N : ñ, n
• s / S : ß, š, ś, ş, s
• d / D : đ, d
• z / Z : ž, ź, z
• g / G : ğ, g

---

🚀 Technical Breakouts

1. 2-Byte Encoding Integration

Original Zerowriter layouts were limited by 1-byte encoding, making many European characters impossible to process. We have implemented a full UTF-8 compatible engine, ensuring every special character is processed natively without glitches.

2. Asynchronous Dual-Core Processing

• Core 1: High-priority keyboard interrupts & 1-bit E-ink rendering.
• Core 0: Real-time character/word count background processing.
• Experience zero latency even when working on book-length manuscripts.

3. Standalone Wireless File Server (No Cables Needed)

Rupert Edition completely frees you from cables. The device operates as its own WiFi Access Point (192.168.4.1 or rupertwriter.local). Simply connect your phone or PC to the device's network, open a web browser, and you can instantly download or delete your .txt drafts through a clean web interface.

4. Universal BLE Text Dumping

Need your text on another device instantly? Connect RupertWriter as a standard Bluetooth Keyboard to your smartphone or laptop. With the 'Safe BLE Transfer' function, the device will automatically "type out" your entire manuscript directly into any app (Notepad, Word, Email). We've even implemented a micro-delay for specific symbols (/ \ - =) to ensure 100% typo-free transmission across different operating systems.

5. Intelligent Dual-Font Typography Engine

Rendering different languages perfectly on a low-refresh E-ink screen is notoriously difficult. My custom engine parses characters byte-by-byte in real time. It applies a rigid monospaced 16px Typewriter font for 3-byte characters (Korean), while seamlessly swapping to a byte-adaptive Unifont for 1-to-2-byte characters (Latin, Symbols, Accents). The result? Flawless layout and alignment, no matter how many languages you mix in a single sentence.

6. E-ink Optimized Visual Search

Press Ctrl + F to open the built-in search bar. When navigating through search results, the engine physically calculates the exact hardware matrix position of the target word on the E-ink screen. It then renders an inverted black box with white text directly over the word, providing a crystal-clear visual highlight without forcing a full screen refresh.

7. Hardware-Level Battery Protection & Persistent NVS

All your preferences (Keyboard Layout, Sleep Timers, Caps Lock status) are saved to Non-Volatile Storage (NVS) and survive reboots. To protect your battery life, if the voltage drops below 3.5V, the system flashes a hardware warning and enters a deep-sleep protection mode. It can only be awakened via a direct ext0 hardware interrupt from the physical keyboard matrix.

🛠️ Maintenance & Safety (OTA)

Updates are delivered over-the-air with Signature Verification. The device only accepts firmware containing the official RUPERT_OFFICIAL_KOR signature to prevent system corruption.

---

⌨️ Hotkeys (Hardware Mapped)

Rupert Edition uses intuitive shortcuts mapped directly to your mechanical keyboard to keep your writing flow uninterrupted.

Function	Shortcut	Description
New Document	Ctrl + N	Opens a clean, new document (doc_X.txt).
Save	Ctrl + S	Safely saves the current draft to internal storage.
Copy / Paste	Ctrl + C / V	Copies the entire text to the clipboard and pastes it.
Search (Find)	Ctrl + F	Opens the search bar. Press Enter to jump to the next word.
Force Sleep	Ctrl + L	Instantly locks the screen and enters deep sleep mode.
Hard Refresh	Ctrl + R	Clears E-ink ghosting and refreshes the screen manually.
Language Toggle	Ctrl + Space	Toggles between Korean and English input modes.
Open Menu	Menu Key	Opens the file list and system settings menu.
Exit Network	Ctrl + Menu Key	Instantly turns off WiFi/Bluetooth and returns to typing.
Word / Para Jump	Ctrl + Arrows	Quickly navigate through words or jump to the end/beginning.

---

💾 Installation

The Easiest Way (Binary Flashing):

1. Navigate to the [Releases] tab.
2. Download the latest rupertwriter.bin file.
3. Open the device case and disconnect the keyboard cable connected behind the display.
4. Flash the .bin file using an ESP32 Web Flasher tool or your device's existing OTA feature.

⚠️ Note on Special Characters

Due to current font glyph limitations, certain currency symbols (e.g., €, ₺) may temporarily render as blanks. Full multilingual font implementation is planned for future updates. Contributions and Pull Requests are always welcome!

Zerowriter Korean (Rupert) V1.2

제로라이터 잉크(zerowriter ink) 한글버전 DIY 펌웨어

화살표(방향키) 조작 시 한글 자모 따라오는 현상 제거
키보드 동작 일부 수정

글씨체는 둥근모꼴입니다.

1. 초기화면은 SD카드에 'initial.png'로 넣으면 됩니다. 잠자기 모드에서 볼 수 있습니다.

2. 단축키는 다음과 같습니다(ctrl을 누른 상태에서).
   C : 전체 복사
   V : 붙여넣기(전체 복사와 붙여넣기는, 따로 문서 복사 기능이 없어서 그렇습니다...)
   L : 잠자기(initial.png파일의 그림 띄우기)
   R : e-ink 새로고침
   N : 새로 만들기(Ctrl+C 상태로 Ctrl+N을 한 후 Ctrl+V를 하면 똑같은 문서를 만들 수 있습니다.)
   S : 현재 문서 저장하기
   F : 현재 문서에서 찾기
   좌우화살표 : 앞뒤 단어 단위로 이동
   상하화살표 : 글의 맨 앞과 맨 뒤
   백스페이스 : 단어 단위로 지우기

3. 화살표 동작
   좌우 : 글자 단위로 앞뒤로 이동
   상하 : 문단 단위로 상하로 이동

4. 네트워크 사용법은 다음과 같습니다.
   BLE : Rupertwriter로 검색 후 연결하면 블루투스 외장 키보드로 사용할 수 있습니다.
   wifi : Rupertwriter로 검색 후 연결하면 파일을 볼 수 있습니다. 미리보기 및 파일삭제 기능이 있습니다. 문서 각각의 편집은 불가능합니다. 미리보기화면에서 복사해서 다른 앱에서 사용할 수 있습니다.

현재 구동 후 눈에 띄는 버그만 없는 상태입니다. 긴 글을 작성하거나 파일 개수가 많아지면 어떻게 될지 모르니 테스트용 혹은 메모용으로만 사용해 주세요.
넣는 방법은 https://zerowriter.ink/pages/firmware-updates 에서 보이는 것처럼, 우선 키보드 케이블을 분리해야 합니다.
https://adafruit.github.io/Adafruit_WebSerial_ESPTool/ 에 접속 후, 맨 위 우측에서 속도를 921600으로 맞춘 후 연결합니다.
주소는 0x부터 지정되어 있는 곳에 bin 파일을 넣으면 됩니다. 파일을 선택하고 Program을 실행합니다.
업로드가 끝나면 껐다 켜면 적용됩니다.

SD카드는 반드시 FAT32로 포맷되어 있어야 합니다. 에러가 나면 포맷을 윈도우 기본 포매터가 아니라 https://www.sdcard.org/downloads/formatter/ 에서 다운받아 설치한 포매터를 사용해서 포맷해 보세요.
보드의 라이브러리 특성상 32기가 이하의 메모리를 사용하라고 합니다.

zerowriter_KOR_rupertV1.0

제로라이터 잉크(zerowriter ink) 한글버전 DIY

글자를 치던 중 화살표로 커서 이동 시 자음 등이 따라오는 현상이 있습니다. 반드시 스페이스바를 누른 후 이동해 주세요. 자모음 분리하여 보이게 하다보니 나온 현상인데, 글자가 다 만들어지고 나서 보이게 할지 중간에도 보이게 할지 중 선택하다보니 나온 현상입니다.
글씨체는 둥근모꼴입니다.

1. 초기화면은 SD카드에 'initial.png'로 넣으면 됩니다. 잠자기 모드에서 볼 수 있습니다.
2. 단축키는 다음과 같습니다(ctrl을 누른 상태에서).
   C : 전체 복사
   V : 붙여넣기(전체 복사와 붙여넣기는, 따로 문서 복사 기능이 없어서 그렇습니다...)
   L : 잠자기(initial.png파일의 그림 띄우기)
   R : e-ink 새로고침
   N : 새로 만들기(Ctrl+C 상태로 Ctrl+N을 한 후 Ctrl+V를 하면 똑같은 문서를 만들 수 있습니다.)
   S : 현재 문서 저장하기
   F : 현재 문서에서 찾기
   좌우화살표 : 해당 줄의 맨 앞과 맨 뒤
   상하화살표 : 문단의 맨 앞과 맨 뒤
3. 네트워크 사용법은 다음과 같습니다.
   BLE : Rupertwriter로 검색 후 연결하면 블루투스 외장 키보드로 사용할 수 있습니다.
   wifi : Rupertwriter로 검색 후 연결하면 파일을 볼 수 있습니다. 미리보기 및 파일삭제 기능이 있습니다. 문서 각각의 편집은 불가능합니다. 미리보기화면에서 복사해서 다른 앱에서 사용할 수 있습니다.

현재 구동 후 눈에 띄는 버그만 없는 상태입니다. 긴 글을 작성하거나 파일 개수가 많아지면 어떻게 될지 모르니 테스트용 혹은 메모용으로만 사용해 주세요.
넣는 방법은 https://zerowriter.ink/pages/firmware-updates 에서 보이는 것처럼, 우선 키보드 케이블을 분리해야 합니다.
https://adafruit.github.io/Adafruit_WebSerial_ESPTool/ 에 접속 후, 맨 위 우측에서 속도를 921600으로 맞춘 후 연결합니다.
주소는 0x부터 넣으면 됩니다. 파일을 선택하고 Program을 실행합니다.
업로드가 끝나면 껐다 켜면 적용됩니다.

SD카드는 반드시 FAT32로 포맷되어 있어야 합니다. 에러가 나면 포맷을 윈도우 기본 포매터가 아니라 https://www.sdcard.org/downloads/formatter/ 에서 다운받아 설치한 포매터를 사용해서 포맷해 보세요.
보드의 라이브러리 특성상 32기가 이하의 메모리를 사용하라고 합니다.