mirrors/btclock_v3
1
0
Fork 0
mirror of https://github.com/btclock/btclock_v3.git synced 2024-11-19 04:20:01 +01:00
Code Issues Packages Projects Releases 1 Wiki Activity

Update README and workflow

Browse Source
This commit is contained in:
Djuri Baars 2023-11-19 18:13:44 +01:00
parent 0e168f840a
commit 00aa784b3d
2 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/workflows/workflow.yml vendored
View File

@ -58,6 +58,9 @@ jobs:
- name: Write build date to file - name: Write build date to file
run: echo "$(date -u +'%Y-%m-%dT%H:%M:%SZ')" > output/date.txt run: echo "$(date -u +'%Y-%m-%dT%H:%M:%SZ')" > output/date.txt
- name: Copy all artifacts to output folder
run: cp .pio/build/lolin_s3_mini_qr/*.bin output
- name: Upload artifacts - name: Upload artifacts
uses: actions/upload-artifact@v3 uses: actions/upload-artifact@v3
with: with:

15
README.md
View File

@ -1,24 +1,23 @@
# BTClock v3 # BTClock v3
Software for the BTClock project. Highly experimental version. [![BTClock CI](https://github.com/btclock/btclock_v3/actions/workflows/workflow.yml/badge.svg)](https://github.com/btclock/btclock_v3/actions/workflows/workflow.yml)
Biggest differences are: Software for the BTClock project.
Biggest differences with v2 are:
- Uses WebSockets for all data - Uses WebSockets for all data
- Able to configure WiFi using the Improv protocol
- Built on the ESP-IDF with Arduino as a library - Built on the ESP-IDF with Arduino as a library
- Makes better use of native timers and interrupts - Makes better use of native timers and interrupts
- Able to be flashed over-the-air (using ESP OTA) - Able to be flashed over-the-air (using ESP OTA)
- Added market capitalization screen - Added market capitalization screen
- LED flash on new block (and focus to block height screen on new block) - LED flash on new block (and focus to block height screen on new block)
Hold the top button while resetting to reset WiFi settings. Hold the 2nd button from the top while resetting to activate QR-code WiFi configuration.
"Steal focus on new block" means that when a new block is mined, the display will switch to the block height screen if it's not on it already. "Steal focus on new block" means that when a new block is mined, the display will switch to the block height screen if it's not on it already.
Most [information](https://github.com/btclock/btclock_v2/wiki) about BTClock v2 is still valid for this version. Most [information](https://github.com/btclock/btclock_v2/wiki) about BTClock v2 is still valid for this version.
**NOTE**: The software assumes that the hardware is run in a controlled private network. The Web UI and the OTA update mechanism are not password protected and accessible to anyone in the network. Also, since the device only fetches numbers through WebSockets it will skip server certificate verification to save resources. **NOTE**: The software assumes that the hardware is run in a controlled private network. The Web UI and the OTA update mechanism are not password protected and accessible to anyone in the network. Also, since the device only fetches numbers through WebSockets it will skip server certificate verification to save resources.
## Known issues ## Building
- After starting it might take a while before the correct data is displayed
- Quite often the screens will hang, especially after updating Use PlatformIO to build it yourself. Make sure you fetch the [WebUI](https://github.com/btclock/webui) submodule.