You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-10Lines changed: 37 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# TRMNL client for Nook Simple Touch
2
2
3
-
This is a[TRMNL client](https://trmnl.com/developers) for the Nook Simple Touch (BNRV300). The device usually goes for around $30 on eBay and has an 800x600 e-ink display.
3
+
A[TRMNL client](https://trmnl.com/developers) for the Nook Simple Touch (BNRV300). The device usually goes for around $30 on eBay and has an 800x600 e-ink display.
4
4
5
5
<table>
6
6
<tr>
@@ -12,11 +12,18 @@ This is a [TRMNL client](https://trmnl.com/developers) for the Nook Simple Touch
12
12
13
13
Questions or feedback? Please [open an issue](https://github.com/bpmct/trmnl-nook-simple-touch/issues/new).
14
14
15
-
## What about [trmnl-nook](https://github.com/usetrmnl/trmnl-nook)?
15
+
## Table of Contents
16
16
17
-
The [trmnl-nook](https://github.com/usetrmnl/trmnl-nook) repository is designed for much newer versions of Android (targeting Nook Glowlight 4 and similar modern devices). This repository (`trmnl-nook-simple-touch`) targets the legacy Nook Simple Touch running Android 2.1 (API 7), which requires different tooling and approaches.
18
-
19
-
I'd love to work with the TRMNL team to combine these repositories, but a lot of the code will remain seperate due to the fundamental differences in Android versions and device capabilities. The core TRMNL API integration and display logic share similarities, but the power management, wake/sleep handling, and build tooling differ significantly between Android 2.1 and modern Android versions.
17
+
-[Prerequisites](#prerequisites)
18
+
-[Install](#install)
19
+
-[Device Settings](#device-settings)
20
+
-[Features](#features)
21
+
-[Deep Sleep Mode](#deep-sleep-mode)
22
+
-[Gift Mode](#gift-mode)
23
+
-[Frames and Cases](#frames-and-cases)
24
+
-[Roadmap](#roadmap)
25
+
-[Development](#development)
26
+
-[Disclaimer](#disclaimer)
20
27
21
28
## Prerequisites
22
29
- Root the device using the [Phoenix Project](https://xdaforums.com/t/nst-g-the-phoenix-project.4673934/). I used "phase 4" (the minimal rooted install for customization). The phases were confusing because you do not need phase 1/2/3 (each is a separate backup).
@@ -35,10 +42,11 @@ I'd love to work with the TRMNL team to combine these repositories, but a lot of
35
42
36
43
In the TRMNL Device settings, set the device type to "Amazon Kindle 7" (800x600). This matches the Nook Simple Touch's display resolution. See [issue #10](https://github.com/bpmct/trmnl-nook-simple-touch/issues/10) for why this workaround is needed and efforts to add a dedicated device type.
37
44
38
-
## What this client does
45
+
## Features
46
+
39
47
- On-device config UI for device ID, API key, and API URL (BYOS)
40
-
- Fetches your screen and shows it full screen on the Nook, bypassing the lock screen until you exit
41
-
-Properly respects playlist intervals to advance to the next screen
48
+
- Fetches your screen and shows it fullscreen, bypassing the lock screen until you exit
49
+
-Respects playlist intervals to advance to the next screen
42
50
- TLS v1.2 via BouncyCastle (not included in Android 2.1)
43
51
- BYOD support for TRMNL and custom server URLs
44
52
- Reports battery voltage and Wi-Fi signal strength
@@ -69,9 +77,28 @@ Deep sleep is not enabled by default. To set it up:
69
77
2.**Nook display settings** — `Settings → Display → Screen timeout`: 2 minutes, then set Screensaver to "TRMNL"
70
78
3.**Hide screensaver banner** — In Nook apps: `Nook Touch Mod → Configure Mod Options`: Hide screensaver banner
71
79
80
+
## Gift Mode
81
+
82
+
Gift Mode displays setup instructions instead of fetching content—perfect for giving a pre-configured device as a gift.
83
+
84
+
To set up:
85
+
1. Buy a [BYOD license](https://shop.usetrmnl.com/products/byod) for the recipient
86
+
2. Get the friendly device code from [trmnl.com/claim-a-device](https://trmnl.com/claim-a-device)
87
+
3. In the app: Settings → Enable "Gift mode" → "Configure Gift Mode"
88
+
4. Enter your name, recipient's name, and the device code
89
+
90
+
## Frames and Cases
91
+
92
+
The Nook Simple Touch often develops sticky residue on its rubberized surfaces as it ages. [iFixit](https://www.ifixit.com/Device/Barnes_%26_Noble_Nook_Simple_Touch) has great teardown and repair guides if you need to clean or refurbish your device.
93
+
94
+
For a custom frame, I recommend this [3D-printed case on Thingiverse](https://www.thingiverse.com/thing:7140441). It requires:
95
+
- M3x4 flush screws
96
+
- M3x5x4 threaded inserts (soldering iron required to install)
97
+
- The original screws and inserts from the Nook Simple Touch
98
+
72
99
## Roadmap
73
-
-[ ] Rubber cleaning and mounting options (https://github.com/bpmct/trmnl-nook-simple-touch/issues/11)
74
-
-[ ] Test on the Glowlight BNRV350 (https://github.com/bpmct/trmnl-nook-simple-touch/issues/6)
100
+
101
+
See [GitHub Issues](https://github.com/bpmct/trmnl-nook-simple-touch/issues) for the roadmap and to submit feature requests.
75
102
76
103
## Development
77
104
See the CI workflow for build details ([`build-apk.yml`](https://github.com/bpmct/trmnl-nook-simple-touch/blob/main/.github/workflows/build-apk.yml)), and the `tools/` adb scripts for build/install workflows. A development guide is coming (https://github.com/bpmct/trmnl-nook-simple-touch/issues/8). In the meantime, the project can be built with surprisingly minimal, self-contained dependencies.
0 commit comments