Skip to content

Latest commit

 

History

19 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

Metroboard Quickstart Guide

What is Metroboard?

Metroboard is a physical, LED-based transit map that lights up to show real-time train activity. Each board connects to Wi-Fi, fetches updates from the Metroboard service, and renders those updates on LED strips. The firmware is preloaded on your board, so no upload is required.


🔧 Board settings

Use this link to modify board settings: https://damp-catlin-metroboard-7be2a3b3.koyeb.app/login


Overview

You will:

  1. Plug in and power the board.
  2. Connect to the Metroboard setup Wi-Fi.
  3. Open the setup page (only if it doesn’t open automatically).
  4. Enter your Wi-Fi details and board ID.
  5. Let the board reboot and connect.

Prerequisites

  • A Metroboard device.
  • A USB-C power source (wall adapter, power bank, or computer USB port).
  • The board ID from the card included with your board.
  • A phone or computer with Wi-Fi.

Step 1: Plug In and Power the Board

  1. Plug your Metroboard into power using USB-C.
  2. Wait about 10–20 seconds for it to boot.

Step 2: Connect to the Setup Wi-Fi

On first boot (or if Wi-Fi fails), the board creates its own setup network:

  1. On your phone/laptop, join the Wi-Fi network:
    • Metroboard-Setup-<hex>

Step 3: Open the Setup Page

  • In most cases, your device will show a captive portal page automatically after connecting to the setup Wi-Fi.
  • Only if the page does not open automatically, open a browser and go to:

You should see the Metroboard setup form.


Step 4: Enter Your Details

Fill in:

  • Wi-Fi SSID
  • Wi-Fi Password
  • Board ID (from your card)

Then click Save & Restart.


Step 5: Wait for the Board to Reboot

After saving, the board will reboot, join your Wi-Fi, and remember your settings after power cycles.


Confirm It’s Running

Depending on your configuration:

  • LEDs should light or animate.
  • You may see output in the Serial Monitor (not required for normal use).

Troubleshooting

Can’t find the setup Wi-Fi

  • Unplug the board, wait 5 seconds, and plug it back in.
  • Ensure you’re within Wi-Fi range.

Setup page won’t load

  • Confirm you’re connected to Metroboard-Setup- (not your home Wi-Fi).
  • If the captive page didn’t open, use http://192.168.4.1 (not HTTPS).
  • Try a different browser.

Board won’t connect after saving

  • Double-check the SSID and password.
  • Unplug the board, wait 5 seconds, and plug it back in to re-open the setup portal and try again.

Status LED colors

The single status LED indicates the board's current state:

  • White — powered on.
  • Green — connected to Wi-Fi with a valid board ID.
  • Light blue — setup web server (Metroboard-Setup) active.
  • Orange — connecting to Wi-Fi.
  • Red — Wi-Fi not connected after the 90-second startup attempt.
  • Pink — board ID invalid (setup portal will reopen for corrections).

🔧 Board settings

Use this link to modify board settings: https://damp-catlin-metroboard-7be2a3b3.koyeb.app/login

About

Metroboard turns TfNSW GTFS-Realtime feeds into LED status states for Sydney Trains/Metro boards, with a FastAPI service, JSON endpoints, and a small web UI for board settings.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages