Updated README
This commit is contained in:
parent
8e3f702c98
commit
0d59ab3b7e
Before Width: | Height: | Size: 322 KiB After Width: | Height: | Size: 322 KiB |
Before Width: | Height: | Size: 377 KiB After Width: | Height: | Size: 377 KiB |
32
README.md
32
README.md
@ -3,12 +3,11 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
# Work in progress
|
# Work in progress
|
||||||
This is a custom firmware being developed for the [LilyGo T-Deck](https://www.lilygo.cc/products/t-deck), currently it is experimental & buggy.
|
This is a custom firmware being developed for the [LilyGo T-Deck](https://www.lilygo.cc/products/t-deck), currently it is experimental & buggy while we are in beta status.
|
||||||
|
|
||||||
We have a team of developers working on this project in **#comms** on **[irc.supernets.org](irc://irc.supernets.org)**, join us if you have ideas, bugs, or want to get your hands dirty & develope this project with us.
|
If you are familiar with or use [Internet Relay Chat](https://en.wikipedia.org/wiki/IRC), we have a team of developers working on this project in **#comms** on **[irc.supernets.org](irc://irc.supernets.org)**, join us if you have ideas, bugs, or want to get your hands dirty & develope this project with us.
|
||||||
|
|
||||||
# Previews
|
![](./.screens/preview.png)
|
||||||
![](./.screens/preview1.png) ![](./.screens/preview2.png)
|
|
||||||
|
|
||||||
# Flashing the Firmware
|
# Flashing the Firmware
|
||||||
###### Using VS Code
|
###### Using VS Code
|
||||||
@ -28,10 +27,11 @@ We have a team of developers working on this project in **#comms** on **[irc.sup
|
|||||||
5. Flash the device: `esptool.py --chip esp32-s3 --port /dev/ttyUSB0 --baud 115200 write_flash -z 0x1000 firmware.bin`
|
5. Flash the device: `esptool.py --chip esp32-s3 --port /dev/ttyUSB0 --baud 115200 write_flash -z 0x1000 firmware.bin`
|
||||||
6. Press the RST *(reset)* button on the device.
|
6. Press the RST *(reset)* button on the device.
|
||||||
|
|
||||||
# Connecting to WiFi
|
# Command & Control
|
||||||
The device will scan for WiFi networks on boot. Once the list is displayed, you can scroll up and down the list with the "u" key for UP and the "d" key for down.
|
###### Menu controls
|
||||||
|
The device will scan for WiFi networks on boot. Once the list is displayed, you can scroll up and down the list with the `u` key for UP and the `d` key for down.
|
||||||
|
|
||||||
# Commands
|
###### IRC commands
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
| --------------- | --------------------------- |
|
| --------------- | --------------------------- |
|
||||||
| `/debug` | Show hardware information |
|
| `/debug` | Show hardware information |
|
||||||
@ -47,13 +47,16 @@ The device will scan for WiFi networks on boot. Once the list is displayed, you
|
|||||||
# Roapmap
|
# Roapmap
|
||||||
###### Device functionality
|
###### Device functionality
|
||||||
- [X] Screen timeout on inactivity *(default 30 seconds)*
|
- [X] Screen timeout on inactivity *(default 30 seconds)*
|
||||||
- [ ] Keyboard backlight timeout on 10 seconds oof inactivity.
|
- [ ] Keyboard backlight timeout with screen timeout
|
||||||
- [ ] Trackball support
|
- [ ] Trackball support
|
||||||
- [ ] Speaker support
|
- [ ] Speaker support
|
||||||
|
- [ ] GPS support
|
||||||
|
- [ ] Lora support
|
||||||
|
- [ ] BLE support
|
||||||
|
|
||||||
###### Features
|
###### Features
|
||||||
- [X] Wifi scanning & selection menu
|
- [X] Wifi scanning & selection menu
|
||||||
- [ ] Saved wifi profiles
|
- [x] Saved wifi profiles
|
||||||
- [ ] Wifi Hotspot
|
- [ ] Wifi Hotspot
|
||||||
- [ ] Notifcations Window *(All notifications will go here, from IRC, Gotify, Meshtastic, or anything)*
|
- [ ] Notifcations Window *(All notifications will go here, from IRC, Gotify, Meshtastic, or anything)*
|
||||||
- [X] Status bar *(Time, Date, Notification, Wifi, and Battery)*
|
- [X] Status bar *(Time, Date, Notification, Wifi, and Battery)*
|
||||||
@ -79,11 +82,14 @@ The device will scan for WiFi networks on boot. Once the list is displayed, you
|
|||||||
- [ ] Spotify/Music player *(can we play audio throuigh Bluetoth headphones or the on-board speaker?)*
|
- [ ] Spotify/Music player *(can we play audio throuigh Bluetoth headphones or the on-board speaker?)*
|
||||||
- [ ] Syslog *(All serial logs will be displayed here for on-device debugging)*
|
- [ ] Syslog *(All serial logs will be displayed here for on-device debugging)*
|
||||||
|
|
||||||
# Known issues
|
# Previews
|
||||||
- Messages that exceed the screen width and wrap to the next line will throw off thje logic of calculating the max lines able to be displayed on the screen. Messages eventually go off screen.
|
###### 99 Color support
|
||||||
|
|
||||||
# More screens..
|
|
||||||
![](./.screens/99colors.png)
|
![](./.screens/99colors.png)
|
||||||
|
|
||||||
|
###### Full ASCII support for PUMPERS
|
||||||
|
![](./.screens/ascii.png)
|
||||||
|
|
||||||
|
###### Support for /HUEG
|
||||||
![](./.screens/hueg.png)
|
![](./.screens/hueg.png)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
Loading…
Reference in New Issue
Block a user