Rien-Prescript-Beeper

KO | EN

gitlite — search

#typescript #llm #deep-learning #linux #macos #nodejs #windows #awesome #cli #security #ios #openai #mcp #open-source

Rien-Prescript-Beeper

(★ 10)

Definitive ver. of my Rien Index Beeper

Rien-Prescript-Beeper Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Rien Index Beeper Device.

The main goal for this project was to make a budget Index Oracle's proxy / Rien device. This runs on Web BLE (so it connects directly to your browser without needing weird setups). This project is under the MIT license so you are free to do anything with it (this includes selling this stuff) but don't try to gatekeep lol. Also, if you decide to make this, feel free to show me! I wanna see it. Hit up @quantdrent on TikTok, Twitter, and Discord.
 
If you want to use the beeper, <a href="https://quantdrent.github.io/Rien-Prescript-Beeper">visit the Web App</a>. or open the html from source code 
Note: You need to use a browser that supports Web BLE (Chrome, Edge, Opera, etc).

## Features
- **Web BLE Integration:** Control the device, sync settings, and beam prescripts right from Chrome/Edge/Opera (no app installs needed).
- **Custom Prescripts:** Write, import, and export your own custom prescripts via the web interface.
- **Stats Tracking:** Physically tap the capacitive touch buttons to **Pass** or **Fail** a prescript, and the device will keep track of your stats.
- **Deep Sleep Mode:** (Recommended Build only) Actually decent battery life for standby.

## Hardware Versions & Required Materials

> There are three different hardware setups in this project:
> * **The nRF52840 (Recommended Build).** It has a TFT color screen, custom fonts, and deep sleep mode. This is the recommended version you see in the GIF.
> * **The ESP32-C3 (Alternative Build).** This uses the exact same TFT color screen as the recommended build, but runs on a much cheaper ESP32-C3 SuperMini. It lacks deep sleep but is a great budget alternative.
> * **The ESP32-C3 (Legacy OLED Build).** An older, archived build that uses a basic blue 1.3" OLED screen. You can find its firmware in `firmware/ESP32/PrescriptBeeper_Legacy_OLED`.
> 
> **DO NOT mix the parts (if you dont know what youre doing).** The firmwares and 3D printed cases are **NOT** interchangeable between the different screens and boards. Make sure you pick the right firmware and 3D model for your parts.

<details>
<summary>Recommended Build (nRF52840)</summary>

This is the recommended version with a tft color screen, custom proportional fonts, and deep sleep support.

> **Note:** Don't forget to solder the boost pads on the SuperMini board if your battery is more than 500mAh.
>
> The TFT `BL` (Backlight) pin MUST be wired to `GND` for the screen to turn on

**Required Parts:**
- SuperMini nRF52840 [[AliExpress](https://www.aliexpress.com/item/1005006019812115.html)]
- 2.25 Inch TFT LCD Module 76x284 ST7789 [[AliExpress](https://www.aliexpress.com/item/1005011855033572.html)]
- 2x Touch capacitive switches TTP-223 [[AliExpress](https://www.aliexpress.com/item/32964219843.html)]
- Any small buttons that can fit inside the case
- Wires (AWG 24 recommended)
- 3.7V Lipo Battery (just make sure it fits in the case)

**Required Arduino Libraries:**
- `Adafruit GFX Library`
- `Adafruit LittleFS`
- `Adafruit ST7735 and ST7789 Library`
**3D Printing (Case):**
- **For the Recommended Build (nRF52840 Supermini):** Use `models/Case.3mf` or `models/Case.stl`
- *(Tinkercad remix link available in `models/tinkercadlink.txt`. I recommend using `.3mf` files. Best results were on a BambuLab A1 with 0.4 nozzle and SUNLU PLA+ 2.0)*

**Wiring Diagram:**

 <img src="images/Main-nRF52840-wiring.png" width="50%" alt="Main nRF52840 Wiring">

#### Board Setup (Arduino IDE)
1. Open Arduino v2.x IDE.
2. Go to **File > Preferences**.
3. Click the icon on the right-hand side of “Additional boards manager URLs”.
4. Add the following URL lines into the text box and click OK:
   * **Temporary fix (use this for now):**
     `https://files.seeedstudio.com/arduino/package_seeeduino_boards_index.json`
     `https://raw.githubusercontent.com/pdcook/nRFMicro-Arduino-Core/3dab6477754d9b28053fe36b06c718cde6e93d3f/package_nRFMicro_index.json`
   * *(Note: The official URL without the hash currently has issues, use the temporary fix).*
5. Go to the Boards Manager (**Tools > Board > Boards Manager**).
6. Search for “nrfmicro”.
7. Find the “nRFMicro-like-Boards” by pdcook, and click “Install”.
8. Go to **Tools > Board > nRFMicro-like-Boards > “SuperMini nRF52840”** (Restart Arduino IDE if it is not listed).
9. Plug in your board to a USB port, click the board selector, and choose the relevant port.

#### Updating the Bootloader
The SuperMini nRF52840 boards have nice!nano v2 compatibility, meaning the Adafruit nRF52 Bootloader can be easily updated.

1. Open your file explorer and look for a USB drive related to your board, often called “NICENANO” (if it isn’t visible, quickly ground the RST pin twice to enter bootloader mode).
2. Inside, `INFO_UF2.TXT` is a small text file that states the current bootloader version.
3. You can see the latest bootloader version on the [bootloader github releases page](https://github.com/adafruit/Adafruit_nRF52_Bootloader/releases).
4. **To update via Arduino IDE:**
 * Go to **Tools > Programmer**, and select **“Bootloader DFU for Bluefruit nRF52”**.
 * Go to **Tools > Burn Bootloader**.
 * **Be patient whilst the bootloader is updated. It is critical not to disconnect mid-update, as you could brick the board.**
5. Once updated, recheck the `INFO_UF2.TXT` file to ensure the version has updated (e.g., from 0.6.0 to 0.9.2).
</details>

<details>
<summary>Alternative Build (ESP32-C3 TFT)</summary>

This version is kept here because the ESP32 parts are generally much cheaper and easier to source than the nRF52840, while still allowing you to use the premium TFT color screen.

> **If you are using an ESP32C3** check out [this guide](https://randomnerdtutorials.com/getting-started-esp32-c3-super-mini/) to set up your board in Arduino IDE.
>
> The TFT `BL` (Backlight) pin MUST be wired to `GND` for the screen to turn on

instruction for this version have not been completed. this was a port made by someone else

**Required Parts:**
- ESP32C3 SuperMini (any ESP32 SuperMini should work)
- 2.25 Inch TFT LCD Module 76x284 ST7789 [[AliExpress](https://www.aliexpress.com/item/1005011855033572.html)]
- 2x Touch capacitive switches TTP-223 [[AliExpress](https://www.aliexpress.com/item/32964219843.html)]
- Any small slide switch that fits inside the case [[AliExpress](https://www.aliexpress.com/item/1005011902173007.html)]
- Wires (AWG 26 recommended)

(optional)
- Any small slide switch that fits inside the case [[AliExpress](https://www.aliexpress.com/item/1005011902173007.html)]
- TP4056 Type-C Charger [[AliExpress](https://www.aliexpress.com/item/1005006043031985.html)]
- 3.7V Lipo Battery (just make sure it fits in the case)

**Required Arduino Libraries:**
- `Adafruit GFX Library`
- `Adafruit LittleFS`
- `Adafruit ST7735 and ST7789 Library`

**3D Printing (Case):**
- **For the Alternative Build (ESP32-C3 Supermini):** Use `models/Case.3mf` or `models/Case.stl`
- Best results were on a BambuLab A1 with 0.4 nozzle and SUNLU PLA+ 2.0)*

*(Note: For the charging module, solder it the exact same way as shown in the Legacy version's wiring diagram. The slide switch does not connect to a GPIO pin; wire it inline with the OUT+ of the charging module to act as a physical power switch).*
</details>

<details>
<summary>Legacy Build (ESP32-C3 OLED)</summary>

This is the archived legacy version using a monochrome OLED. You can find its firmware in `firmware/ESP32/PrescriptBeeper_Legacy_OLED`.

**Required Parts:**
- ESP32C3 Super Mini
- 1.3 Inch OLED Screen SH1106 [[AliExpress](https://www.aliexpress.com/item/1005006862867338.html)]
- 2x Touch capacitive switches TTP-223
- Wires (AWG 26 recommended)

**Required Arduino Libraries:**
- `Adafruit GFX Library`
- `Adafruit SH110X`

**3D Printing (Case):**
- **For the Legacy Build (ESP32-C3 Supemini):** Use `models/Legacy-Case.3mf` or `models/Legacy-Case.stl`
- I recommend using `.3mf` files. Best results were on a BambuLab A1 with 0.4 nozzle and SUNLU PLA+ 2.0)*

**Wiring Diagram:**

 <img src="images/Legacy-ESP32-wiring.png" width="50%" alt="Legacy ESP32 Wiring">

*(Note: The slide switch does not connect to a GPIO pin; wire it inline with the OUT+ of the charging module to act as a physical power switch, as shown in the diagram).*
</details>

## Quickstart

### Instructions

> **Note:** some knowledge of soldering is needed. Don't forget you need a soldering iron, solder, and maybe some flux to connect them all

1. Click the `<> Code` button and download the ZIP, or check releases.
2. Open the `firmware/` folder, select your microcontroller's folder, and open the `.ino` file in the Arduino IDE.
3. Solder everything together based on the pins defined in your firmware's `config.h` file or refer to the hardware sections above for wiring diagrams. 
4. Upload the sketch to your board.
5. Open the [Web App](https://quantdrent.github.io/Rien-Prescript-Beeper) in your browser (or open the local `index.html` file to use offline).
6. Click **Pair Device** and connect to your beeper and your device should work now.
7. Click **Prescripts** at the top middle to add or remove your saved prescripts. You can also export/import them (export first to see the formatting template).
8. Click the giant button on the web app to send a random prescript, or physically tap the capacitive buttons on your device to pull one up.
9. You can factory reset the device by pressing the red button at the bottom right of the settings menu.

## Credits
This project and the Web BLE page were inspired by and forked from Kritzkingvoid's Prescript web project.
https://kritzkingvoid.github.io/Prescripts/

Sounds were taken from Limbus Company / Project Moon.

Rien-Prescript-Beeper

Rien-Prescript-Beeper Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Rien-Prescript-Beeper

Rien-Prescript-Beeper Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README