140d8749a6
## Summary **What is the goal of this PR?** Adds a setting to swap the front buttons. The default functionality are: Back/Confirm/Left/Right. When this setting is enabled they become: Left/Right/Back/Confirm. This makes it more comfortable to use when holding in your right hand since your thumb can more easily rest on the next button. The original firmware has a similar setting. **What changes are included?** - Add the new setting. - Create a mapper to dynamically switch the buttons based on the setting. - Use mapper on the various activity screens. - Update the button hints to reflect the swapped buttons. ## Additional Context Full disclosure: I used Codex CLI to put this PR together, but did review it to make sure it makes sense. Also tested on my device: https://share.cleanshot.com/k76891NY
5.1 KiB
CrossPoint User Guide
Welcome to the CrossPoint firmware. This guide outlines the hardware controls, navigation, and reading features of the device.
1. Hardware Overview
The device utilises the standard buttons on the Xtink X4 in the same layout:
Button Layout
| Location | Buttons |
|---|---|
| Bottom Edge | Back, Confirm, Left, Right |
| Right Side | Power, Volume Up, Volume Down |
2. Power & Startup
Power On / Off
To turn the device on or off, press and hold the Power button for half a second. In Settings you can configure the power button to trigger on a short press instead of a long one.
First Launch
Upon turning the device on for the first time, you will be placed on the Home screen.
Note: On subsequent restarts, the firmware will automatically reopen the last book you were reading.
3. Screens
3.1 Home Screen
The Home Screen is the main entry point to the firmware. From here you can navigate to the Book Selection screen, Settings screen, or File Upload screen.
3.2 Book Selection (Read)
The Book Selection acts as a folder and file browser.
- Navigate List: Use Left (or Volume Up), or Right (or Volume Down) to move the selection cursor up and down through folders and books.
- Open Selection: Press Confirm to open a folder or read a selected book.
3.3 Reading Screen
See 4. Reading Mode below for more information.
3.4 File Upload Screen
The File Upload screen allows you to upload new e-books to the device. When you enter the screen you'll be prompted with a WiFi selection dialog and then your X4 will start hosting a web server.
See the webserver docs for more information on how to connect to the web server and upload files.
3.5 Settings
The Settings screen allows you to configure the device's behavior. There are a few settings you can adjust:
- Sleep Screen: Which sleep screen to display when the device sleeps, options are:
- "Dark" (default) - The default dark sleep screen
- "Light" - The same default sleep screen, on a white background
- "Custom" - Custom images from the SD card, see 3.6 Sleep Screen below for more information
- "Cover" - The book cover image (Note: this is experimental and may not work as expected)
- Extra Paragraph Spacing: If enabled, vertical space will be added between paragraphs in the book, if disabled, paragraphs will not have vertical space between them, but will have first word indentation.
- Short Power Button Click: Whether to trigger the power button on a short press or a long press.
- Front Button Layout: Swap the order of the bottom edge buttons from Back/Confirm/Left/Right to Left/Right/Back/Confirm.
3.6 Sleep Screen
You can customize the sleep screen by placing custom images in specific locations on the SD card:
- Single Image: Place a file named
sleep.bmpin the root directory. - Multiple Images: Create a
sleepdirectory in the root of the SD card and place any number of.bmpimages inside. If images are found in this directory, they will take priority over thesleep.pngfile, and one will be randomly selected each time the device sleeps.
Note
You'll need to set the Sleep Screen setting to Custom in order to use these images.
Tip
For best results:
- Use uncompressed BMP files with 24-bit color depth
- Use a resolution of 480x800 pixels to match the device's screen resolution.
4. Reading Mode
Once you have opened a book, the button layout changes to facilitate reading.
Page Turning
| Action | Buttons |
|---|---|
| Previous Page | Press Left or Volume Up |
| Next Page | Press Right or Volume Down |
Chapter Navigation
- Next Chapter: Press and hold the Right (or Volume Down) button briefly, then release.
- Previous Chapter: Press and hold the Left (or Volume Up) button briefly, then release.
System Navigation
- Return to Home: Press Back to close the book and return to the Book Selection screen.
- Chapter Menu: Press Confirm to open the Table of Contents/Chapter Selection screen.
5. Chapter Selection Screen
Accessible by pressing Confirm while inside a book.
- Use Left (or Volume Up), or Right (or Volume Down) to highlight the desired chapter.
- Press Confirm to jump to that chapter.
- Alternatively, press Back to cancel and return to your current page.
6. Current Limitations & Roadmap
Please note that this firmware is currently in active development. The following features are not yet supported but are planned for future updates:
- Images: Embedded images in e-books will not render.
- Text Formatting: There are currently no settings to adjust font type, size, line spacing, or margins.
- Rotation: Different rotation options are not supported.