Skip to content

Commit 1f0f225

Browse files
committed
publish pages
1 parent 3dc7b0e commit 1f0f225

File tree

4 files changed

+52
-44
lines changed

4 files changed

+52
-44
lines changed

.github/workflows/publish-firmware.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ jobs:
1919
with:
2020
#### Modify below here to match your project ####
2121
# tagtuner-D1-custom1.factory.yaml
22+
# tagtuner-on-ha-voice-pe.factory.yaml
2223
files: |
2324
tagtuner-XIAO-custom.factory.yaml
24-
tagtuner-on-ha-voice-pe.factory.yaml
2525
tagtuner-atom-grove-ble.factory.yaml
2626
tagtuner-for-tagreader.factory.yaml
2727
esphome-version: stable

.github/workflows/publish-pages.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,25 @@ jobs:
2323
runs-on: ubuntu-latest
2424
steps:
2525
- name: Checkout source code
26-
uses: actions/checkout@v4.2.2
26+
uses: actions/checkout@v6
2727

2828
- run: mkdir -p output/firmware
2929

3030
- name: Build
31-
uses: actions/jekyll-build-pages@v1.0.13
31+
uses: actions/jekyll-build-pages@v1
3232
with:
3333
source: ./static
3434
destination: ./output
3535

3636
- name: Fetch firmware files
37-
uses: robinraju/release-downloader@v1.11
37+
uses: robinraju/release-downloader@v1
3838
with:
3939
latest: true
4040
fileName: '*'
4141
out-file-path: output/firmware
4242

4343
- name: Upload artifact
44-
uses: actions/upload-pages-artifact@v3.0.1
44+
uses: actions/upload-pages-artifact@v4
4545
with:
4646
path: output
4747
retention-days: 1
@@ -60,8 +60,8 @@ jobs:
6060
url: ${{ steps.deployment.outputs.page_url }}
6161
steps:
6262
- name: Setup Pages
63-
uses: actions/configure-pages@v5.0.0
63+
uses: actions/configure-pages@v5
6464

6565
- name: Deploy to GitHub Pages
6666
id: deployment
67-
uses: actions/deploy-pages@v4.0.5
67+
uses: actions/deploy-pages@v4

.github/workflows/upload-to-gh-release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ jobs:
3535
pushd $version
3636
cp manifest*.json ../../../output/
3737
for bin in *.{bin,elf}; do
38-
md5sum $bin | head -c 32 > "${output_path}$bin.md5"
39-
sha256sum $bin | head -c 64 > "${output_path}$bin.sha256"
40-
cp $bin "$output_path"
38+
md5sum $bin | head -c 32 > ../../../output/$bin.md5
39+
sha256sum $bin | head -c 64 > "../../../output/$bin.sha256"
40+
cp $bin ../../../output/
4141
done
4242
popd
4343
popd

static/index.md

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You can use the button below to install the pre-built firmware directly to your
4848
<p>Select your TagTuner version</p>
4949
<ul class="radios">
5050
<li>
51-
<label><input type="radio" name="type" value="tagtuner-d1-esp32" /> D1-Custom</label>
51+
<label><input type="radio" name="type" value="tagtuner-xiao-esp32c6" /> XIAO Custom</label>
5252
</li>
5353
<li>
5454
<label><input type="radio" name="type" value="tagtuner-on-ha-voice-esp32s3" /> HA Voice PE</label>
@@ -59,6 +59,9 @@ You can use the button below to install the pre-built firmware directly to your
5959
<li>
6060
<label><input type="radio" name="type" value="tagtuner-for-tagreader-esp8266" /> tagreader</label>
6161
</li>
62+
<li>
63+
<label><input type="radio" name="type" value="tagtuner-d1-esp32" /> D1 Custom</label>
64+
</li>
6265
</ul>
6366
<p class="button-row" align="center">
6467
<esp-web-install-button class="invisible"></esp-web-install-button>
@@ -78,8 +81,8 @@ Installer powered by [ESP Web Tools](https://esphome.github.io/esp-web-tools/)
7881

7982
## Getting started
8083
To start using TagTuner, you’ll need the following:
81-
- [Home Assistant](https://www.home-assistant.io) 2025.1.x
82-
- [Music Assistant](https://music-assistant.io) 2.x or [Sonos](https://www.sonos.com/) speaker
84+
- [Home Assistant](https://www.home-assistant.io) 2025.12.x
85+
- [Music Assistant](https://music-assistant.io) 2.7.x or [Sonos](https://www.sonos.com/) speaker
8386
- configured MAss music [library](https://music-assistant.io/usage/#the-library) and/or a streaming subscription
8487
- TagTuner device configured in HAss
8588
- any NFC tags or programmable NTAG213/215/216
@@ -103,55 +106,60 @@ Custom model cases are print-ready
103106
- [printables](https://www.printables.com/model/1109660-tagtuner-d1-custom1)
104107
- [ko-fi/shop](https://ko-fi.com/s/ce428ab53f)
105108

106-
Choose and print your enclosure with preferred colors and surface patterns
107-
![A4334D41-580B-43D2-9B9E-4769A9EE2630_1_105_c](https://github.com/user-attachments/assets/a507ec1a-55a8-4e1c-a4b2-368f907f073b)
108-
109+
Choose and print your enclosure with preferred colors and surface patterns. \
109110
I suggest a cool-white (signal white) base and a dark front plate with a nice carbon fibre pattern.
110111
![D7EFA920-1D9A-4D65-AD23-4F0A2328A510_1_105_c](https://github.com/user-attachments/assets/ea6c62d3-68ee-47b1-8d40-b381910d00c3)
111112

112-
### Parts for D1-Custom version
113-
- [esp32 D1 mini](https://s.click.aliexpress.com/e/_DkyEAwt) controller with USBC
114-
- [pn532](https://s.click.aliexpress.com/e/_De8uw89) NFC reader
115-
- [hw040](https://s.click.aliexpress.com/e/_DlIIMtn) rotary encoder
116-
- [grove angle connectors](https://s.click.aliexpress.com/e/_DDF07mN)
117-
118-
#### Wiring D1-Custom
119-
pn532 connector:
120-
- GND: GND
121-
- VCC: VCC (+5V)
122-
- SDA/TXD: IO21
123-
- SCL/RXD: IO22
124-
125-
hw040 connector:
126-
- CLK: IO18
127-
- DT: IO19
128-
- SW: IO23
129-
- +: +3.3V
113+
### BOM for XIAO-Custom version
114+
- [XIAO esp32-c6](https://s.click.aliexpress.com/e/_c3hnW7jV) controller with built-in antenna
115+
- [pn532](https://s.click.aliexpress.com/e/_c3l9MKHr) NFC reader
116+
- [grove angle connectors](https://s.click.aliexpress.com/e/_c3xcepEd)
117+
- [grove cables](https://s.click.aliexpress.com/e/_c3rtIVGR)
118+
- [hw040](https://s.click.aliexpress.com/e/_c3vSH4wJ) rotary encoder
119+
- [dupont cables](https://s.click.aliexpress.com/e/_c4FUMZi7) for hw040
120+
- [M2.5 10mm](https://s.click.aliexpress.com/e/_c3gFU5Zv) screws
121+
122+
#### Wiring XIAO-Custom
123+
pn532 connector (use grove cable):
124+
- GND: GND (bottom cable)
125+
- VCC: VBUS (+5V, bottom cable)
126+
- SDA/TXD: D4
127+
- SCL/RXD: D5
128+
129+
hw040 connector (use dupont cable):
130+
- CLK: D8
131+
- DT: D9
132+
- SW: D10
133+
- +: 3V3 (+3.3V)
130134
- GND: GND
131135

132-
![BCAC91FD-93C7-45B1-BD3F-C07717A7AF5C_1_201_a](https://github.com/user-attachments/assets/6c01184f-bc0a-4e16-bff7-f1452aa176a0)
136+
![IMG_3879](https://github.com/user-attachments/assets/89939c33-9ba4-458e-9037-983e964e1784)
137+
138+
Route and solder the VCC (red) and GND (white) wires along the bottom side of XIAO to ensure the front LED remains unobstructed.
133139

134-
ESP32 D1 mini will fit perfectly into the bottom part braces
135-
<img width="800" alt="image" src="https://github.com/user-attachments/assets/c7907571-c27f-4d40-ac83-a28fe8a409e3" />
140+
XIAO will fit perfectly into the bottom part braces
141+
<img width="800" alt="image" src="https://github.com/user-attachments/assets/729de545-c39a-4701-8ef3-378c20e3397d" />
136142

137-
Built-in LED is used as confirmation light. Print the led peg with clear filament and it will give great results
143+
Built-in LED is used as confirmation light. Print the led peg with clear filament and it will give great results \
144+
(TODO: XIAO front plate LED)
138145
![IMG_2940](https://github.com/user-attachments/assets/e50b129d-66d2-4ead-8c5c-6e190eb7a39f)
139146

140-
I preffer soldering the [grove angle connector](https://s.click.aliexpress.com/e/_DDF07mN) to the [PN532 NFC](https://s.click.aliexpress.com/e/_De8uw89) board
147+
I preffer soldering the grove angle connector to the PN532 NFC board
141148
![CA3A603C-CE5B-4982-AF24-9E40D3E554C2_1_201_a](https://github.com/user-attachments/assets/977e082d-af23-4d34-a981-68bd14b8df44)
142-
Remember to set the DIP switches to 10 to enable I2C. Correct position for I2c is marked by yellow lines.
149+
Remember to set the DIP switches to 10 to enable I2C. Correct switches position for I2c is marked by yellow lines.
143150

144151
Everything will fit into the enclosure.
145-
![79F47CA4-0882-47AD-8710-8E5B6021D77A_1_105_c](https://github.com/user-attachments/assets/97d14e1a-97f8-4c64-a5ec-44054e5350db)
152+
![IMG_3884](https://github.com/user-attachments/assets/486370be-21fa-4e10-a11b-db0cf5e78d17)
146153

147154
Use 10mm M2.5 screws (nfc board, volume encoder, front plate).
148155

149156
### Firmware
150157

151-
- [tagtuner-D1-custom1.yaml](https://github.com/luka6000/TagTuner/blob/main/tagtuner-D1-custom1.yaml): ESP32 D1 mini with HW-040 rotary encoder and button. Bluetooth & BLE proxy, ESP-IDF framework
152-
158+
- [quick start](https://luka6000.github.io/TagTuner/#installation): use pre-built firmware with [ESP Web Tools](https://esphome.github.io/esp-web-tools/) powered installer [here](https://luka6000.github.io/TagTuner/#installation)
159+
- [tagtuner-XIAO-custom.yaml](https://github.com/luka6000/TagTuner/blob/main/tagtuner-XIAO-custom.yaml): XIAO ESP32-C6 with HW-040 rotary encoder and button. Bluetooth & BLE proxy, ESP-IDF framework
153160

154161
### Other options
162+
- [D1 mini](https://github.com/luka6000/TagTuner/blob/main/TagTuner-D1.md): TagTuner Custom1 based on the ESP32 D1 Mini; previously my preferred version but dropped in favor of the XIAO because of the poor quality of available D1 boards
155163
- [HA Voice PE version](https://github.com/luka6000/TagTuner/blob/main/TagTuner-on-HA-Voice-PE.md): TagTuner on HA Voice PE device
156164
- [tagtuner-for-tagreader.yaml](https://github.com/luka6000/TagTuner/blob/main/tagtuner-for-tagreader.yaml): TagTuner firmware for [Adonno tagreader](https://github.com/adonno/tagreader) device (buzzer only, no led support)
157165
- [Atom version](https://github.com/luka6000/TagTuner/blob/main/TagTuner-Atom.md): based on m5stack Atom Echo and grove connectors; free model case but much thicker (23.5mm)
@@ -202,7 +210,7 @@ Watch the LED light in the button: \
202210
**flashing constant**: writing operation in progress \
203211
**flashing few times**: operation success
204212

205-
D1-Custom has a single color led so it's only blinking but it's really easy to understand what's going on. Use HAss device Diagnostic dashboard in case you would need status info.
213+
XIAO-Custom has a single color led so it's only blinking but it's really easy to understand what's going on. Use HAss device Diagnostic dashboard in case you would need status info.
206214

207215
### Diagnostic
208216
Check the Diagnostic->Status messages on the device page in Home Assistant.\

0 commit comments

Comments
 (0)