Skip to content

Commit 3696c7e

Browse files
authored
Merge pull request #28 from bpmct/readme-update
docs: add nooks.bpmct.net easy setup section + clarify optional button settings
2 parents c940fb3 + 898f2e5 commit 3696c7e

2 files changed

Lines changed: 48 additions & 7 deletions

File tree

README.md

Lines changed: 48 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Questions or feedback? Please [open an issue](https://github.com/bpmct/trmnl-noo
1616

1717
- [Prerequisites](#prerequisites)
1818
- [Install](#install)
19+
- [Easy Setup](#easy-setup-recommended)
20+
- [Manual Setup](#manual-setup)
1921
- [Device Settings](#device-settings)
2022
- [Features](#features)
2123
- [Deep Sleep Mode](#deep-sleep-mode)
@@ -32,18 +34,57 @@ Questions or feedback? Please [open an issue](https://github.com/bpmct/trmnl-noo
3234
- Buy a [TRMNL BYOD license](https://shop.usetrmnl.com/collections/frontpage/products/byod) and grab your SSID + API key from Developer Settings after login (or use your own server).
3335

3436
## Install
35-
- Download the APK from [GitHub Releases](https://github.com/bpmct/trmnl-nook-simple-touch/releases).
36-
- Connect the Nook Simple Touch over USB and copy the APK over.
37-
- Open the included `ES File Explorer` app.
38-
- In ES File Explorer: `Favorites -> "/" -> "media" -> "My Files".`
39-
- Tap the APK and install.
40-
- Connect your device to WiFi
41-
- Open the app and configure the device info
37+
38+
### Easy Setup (recommended)
39+
40+
I built [a web tool](https://nooks.bpmct.net/manage/) that handles the whole setup over USB — installs the app, configures settings, and gets you on WiFi, all from the browser. No ADB needed.
41+
42+
> Requires Chrome or Edge (WebUSB). Your NOOK must be rooted first via the [Phoenix Project](https://xdaforums.com/t/nst-g-the-phoenix-project.4673934/) phase 4 before it'll show up.
43+
44+
[![nooks.bpmct.net setup wizard](images/nooks-webapp.png)](https://nooks.bpmct.net/manage/)
45+
46+
The wizard walks you through five steps:
47+
48+
1. **Connect** — Plug in your NOOK via USB, then click "Connect Device" to open the browser's USB picker. If prompted on the NOOK screen, tap *Allow* to authorize the connection.
49+
2. **Checking** — Reads your device model, verifies the TRMNL app is installed (installing or updating it if needed), and applies any missing system settings automatically.
50+
3. **Configure TRMNL** — Sign up at trmnl.com, then enter the MAC address and Device API Key from your device's Developer Perks page. Self-hosted (BYOS) and gift mode are available under advanced options.
51+
4. **WiFi Setup** — If your NOOK is already on a network, this step confirms the connection and moves on. Otherwise, it scans for nearby networks and writes the credentials directly to the device.
52+
5. **Done** — Your NOOK is ready. Unplug the USB cable and manage plugins and settings at trmnl.com.
53+
54+
The web tool configures all required device settings automatically, including those listed in [Device Settings](#device-settings) below.
55+
56+
---
57+
58+
### Manual Setup
59+
60+
1. Download the APK from [GitHub Releases](https://github.com/bpmct/trmnl-nook-simple-touch/releases).
61+
2. Connect the Nook Simple Touch over USB and copy the APK over.
62+
3. Open the included `ES File Explorer` app.
63+
4. In ES File Explorer: `Favorites -> "/" -> "media" -> "My Files".`
64+
5. Tap the APK and install.
65+
6. Connect your device to WiFi.
66+
7. Open the app and configure the device info.
67+
68+
After installing manually, you'll also need to configure [Device Settings](#device-settings).
4269

4370
## Device Settings
4471

4572
In the TRMNL Device settings, set the device type to "Nook Simple Touch" as the TRMNL team was nice enough to add support for this device!
4673

74+
The [web tool](https://nooks.bpmct.net/manage/) applies all of the settings below automatically. If you installed manually, configure each one by hand:
75+
76+
| Where | Setting | Value | Purpose |
77+
|-------|---------|-------|----------|
78+
| `Nook Settings → Display → Screensaver` | Screensaver | TRMNL / 2 min timeout | Points the screensaver at the TRMNL image and ensures it activates for deep sleep |
79+
| `Apps → Nook Touch Mod` | Hide screensaver banner | Enabled | Hides the text overlay on the screensaver |
80+
| `Apps → Nook Touch Mod` | Disable drag to unlock | Enabled | Skips the drag-to-unlock gesture on screensaver wake |
81+
| `Apps → Nook Touch Mod` *(optional)* | Home button (short press) | Launches TRMNL app | Remaps the physical Home button to open TRMNL directly |
82+
| `Apps → Nook Touch Mod` *(optional)* | Home button (long press) | Opens App Drawer | Remaps long-press Home to the app drawer |
83+
| TRMNL app → Settings → General | Sleep between updates | Enabled | Enables deep sleep between refresh cycles |
84+
| TRMNL app → Settings → General | Aggressive sleep | Enabled | Sleeps immediately after each refresh rather than waiting for timeout |
85+
86+
> **Note:** Nook Touch Mod settings require [Nook Mod Manager (NMM)](https://xdaforums.com/t/nst-g-the-phoenix-project.4673934/) to be installed (included in Phoenix Project phase 4). The Home button remapping rows are optional — the app works without them.
87+
4788
## Features
4889

4990
- On-device config UI for device ID, API key, and API URL (BYOS)

images/nooks-webapp.png

135 KB
Loading

0 commit comments

Comments
 (0)