Skip to content

Improve readme and submodules #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve readme and submodules #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
url = https://github.com/webmproject/libwebp.git
[submodule "components/esp-audio-player"]
path = components/esp-audio-player
url = git@github.com:chmorgan/esp-audio-player.git
url = https://github.com/chmorgan/esp-audio-player.git
[submodule "components/esp-libhelix-mp3"]
path = components/esp-libhelix-mp3
url = git@github.com:chmorgan/esp-libhelix-mp3.git
url = https://github.com/chmorgan/esp-libhelix-mp3.git
[submodule "lib/HUB75"]
path = lib/HUB75
url = git@github.com:tidbyt/ESP32-HUB75-MatrixPanel-I2S-DMA.git
url = https://github.com/tidbyt/ESP32-HUB75-MatrixPanel-I2S-DMA.git
branch = rohan/esp-idf-5
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ This repository contains a community supported firmware for the Tidbyt hardware
![social banner](./docs/assets/social.png)

## Warning

⚠️ Warning! Flashing your Tidbyt with this firmware or derivatives could fatally
damage your device. As such, flashing your Tidbyt with this firmware or
derivatives voids your warranty and comes without support.

## Setup

This project uses PlatformIO to build, flash, and monitor firmware on the Tidbyt.
To get started, you will need to download [PlatformIO Core][2] on your computer.

Expand All @@ -24,8 +26,17 @@ While we had pixlet in mind, you can point this firmware at any URL that hosts
a WebP image that is optimized for the Tidbyt display.

## Getting Started

This repository uses Git submodules, so make sure to specify the `--recurse-submodules`
flag when cloning:

```
git clone --recurse-submodules https://github.com/tidbyt/hdk.git
```

To flash the custom firmware on your device, run the following after replacing
the variables with your desired information:

```
TIDBYT_WIFI_SSID='Your WiFi' \
TIDBYT_WIFI_PASSWORD='super-secret' \
Expand All @@ -36,12 +47,21 @@ pio run --environment tidbyt --target upload
If you're flashing to a Tidbyt Gen2, just change to the above to use
the `--environment tidbyt-gen2` flag.

**Note:** `TIDBYT_REMOTE_URL` must be an HTTP URL. This firmware **does not support HTTPS**
for a remote URL.

## Monitoring Logs

To check the output of your running firmware, run the following:

```
pio device monitor
```

**Note:** running `device monitor` at the same time as deploying new firmware
with the `run` is not supported.


## Back to Normal
To get your Tidbyt back to normal, you can run the following to flash the
production firmware onto your Tidbyt:
Expand All @@ -56,5 +76,6 @@ And if you're working with a Tidbyt Gen 2:
pio run --target reset --environment tidbyt-gen2
```


[1]: https://github.com/tidbyt/pixlet
[2]: https://docs.platformio.org/en/latest/core/installation/index.html