Skip to content

QUICKSTART.md

Latest commit

 

History

History
46 lines (37 loc) · 2.28 KB

QUICKSTART.md

File metadata and controls

46 lines (37 loc) · 2.28 KB

Quickstart Guide

Get your CheapSpoolDisplay up and running from scratch.

1. Prepare the Hardware

See HARDWARE_SETUP.md for details.

  • Device: ESP32-2432S028R (Cheap Yellow Display).
  • NFC Reader: Connect an RC522 or PN5180 SPI module.
  • Wiring:
    • Sacrifice the SD card slot pins for the NFC reader.
    • Common Pins: SDA (CS) -> IO5, SCK -> IO18, MOSI -> IO23, MISO -> IO19, RST -> IO22.
    • PN5180 Only: BUSY -> IO27 (available on CN1 header).

2. Print the Case

3. Flash the Firmware

  1. Connect the CYD to your PC via USB.
  2. Open the CheapSpoolDisplay Web Installer.
  3. Click the button matching your wired NFC module: Flash Device (MFRC522) or Flash Device (PN5180).

    [!IMPORTANT] You must choose the version that matches your physical module, otherwise the NFC reader will fail to initialize on boot.

  4. Select your CYD's COM port in the connection window and follow the prompts to install the firmware.

4. Configure the Device

See CONFIGURATION.md for details.

  1. Connect to the serial terminal using
    • the Web Installer (click Logs & Console)
    • any Serial Terminal (115200 baud)
  2. Configuration Commands:
    • set wifi <SSID> <PASSWORD> to configure your wireless network
    • set tag_format <openspool|openprinttag|opentag3d|ask> to set your preferred NFC format
    • set spoolman <URL> to enable Spoolman enrichment (e.g., http://192.168.1.50:8000)
    • set u1_host <IP_OR_HOSTNAME>:7125 to enable Snapmaker U1 loading
    • set tools <1-16> to set the number of toolheads
    • set bambu_salt <HEX_STRING> to enable Bambu Lab Tag support
    • set display_timeout <seconds> to adjust screen auto-off timings (0=Always On)
    • get config to verify your updated settings anytime

Bambu Lab Tags

Bambu Lab tags are encrypted. To read them, you MUST provide a Secret Salt in the configuration. See supported standards documentation for details.