Skip to content

Commit

Permalink
TagTuner for tagreader
Browse files Browse the repository at this point in the history
Adonno tagreader device support
  • Loading branch information
luka6000 committed Nov 5, 2024
1 parent e33f78c commit d989364
Show file tree
Hide file tree
Showing 6 changed files with 509 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ jobs:
max-parallel: 3
matrix:
file:
- tagtuner-atom-grove.yaml
- tagtuner-atom-grove
- tagtuner-for-tagreader
esphome-version:
- stable
- beta
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
with:
files: |
tagtuner-atom-grove.factory.yaml
tagtuner-for-tagreader.factory.yaml
esphome-version: 2024.10.2
combined-name: firmware
release-summary: ${{ github.event_name == 'release' && github.event.release.body || '' }}
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The ladybug icon is your guide.

## How to get tags for TagTuner
### Buy tags
Choose NTAG216 or 888-byte tags if you want to include the playlist name and artist. Otherwise, NTAG213 (144 bytes) will suffice for just links to playlists
Choose NTAG215 (504 bytes) or NTAG216 (888 bytes) tags if you want to include the playlist name and artist. Otherwise, NTAG213 (144 bytes) will suffice for just links to playlists

- [Plain white cards](https://s.click.aliexpress.com/e/_Deb0eeV)
- [Wooden cards](https://s.click.aliexpress.com/e/_DdGYnJf)
Expand Down Expand Up @@ -171,7 +171,9 @@ Use short (<5mm) M2 screw for Atom and longer (10mm) M2.5 screws for everything
#### Wiring TBD

### Firmware options
- tagtuner-atom-grove.yaml: based on m5stack Atom Echo and grove connectors

- [tagtuner-atom-grove.yaml](https://github.com/luka6000/TagTuner/blob/main/tagtuner-atom-grove.yaml): based on m5stack Atom Echo and grove connectors
- [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)
- tagtuner-esp32.yaml: custom-built TBD

## A little history
Expand Down
8 changes: 5 additions & 3 deletions static/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# About TagTuner music player
# TagTuner music player
TagTuner is a device that enables you to access music playlists or albums using NFC tags.\
It only works when integrated with Home Assistant media players and the Music Assistant music library is optional. This setup seamlessly blends your digital only music collection with the tactile experience of playing a physical record, tape or cd.\
Physical music media offer several advantages:
Expand Down Expand Up @@ -30,7 +30,7 @@ You can use the button below to install the pre-built firmware directly to your

## Getting started
To start using TagTuner, you’ll need the following:
- [Home Assistant](https://www.home-assistant.io) 2024.x
- [Home Assistant](https://www.home-assistant.io) 2024.10.x
- [Music Assistant](https://music-assistant.io) 2.x or [Sonos](https://www.sonos.com/) speaker
- configured MAss music [library](https://music-assistant.io/usage/#the-library) and/or a streaming subscription
- TagTuner device configured in HAss
Expand Down Expand Up @@ -179,7 +179,9 @@ Use short (<5mm) M2 screw for Atom and longer (10mm) M2.5 screws for everything
#### Wiring TBD

### Firmware options
- tagtuner-atom-grove.yaml: based on m5stack Atom Echo and grove connectors

- [tagtuner-atom-grove.yaml](https://github.com/luka6000/TagTuner/blob/main/tagtuner-atom-grove.yaml): based on m5stack Atom Echo and grove connectors
- [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)
- tagtuner-esp32.yaml: custom-built TBD

## A little history
Expand Down
28 changes: 28 additions & 0 deletions tagtuner-for-tagreader.factory.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# These substitutions allow the end user to override certain values
substitutions:
name: "tagtuner"
friendly_name: "TagTuner"

packages:
# Include all of the core configuration
core: !include tagtuner-for-tagreader.yaml

esphome:
name: "${name}"
friendly_name: ${friendly_name}
# Automatically add the mac address to the name
# so you can use a single firmware for all devices
name_add_mac_suffix: true

project:
name: LukaGra.TagTuner
version: dev

# This should point to the public location of this yaml file.
dashboard_import:
package_import_url: github://luka6000/TagTuner/tagtuner-for-tagreader.yaml@main
import_full_config: true

# Sets up the improv via serial client for Wi-Fi provisioning
improv_serial:
next_url: https://luka6000.github.io/TagTuner/
Loading

0 comments on commit d989364

Please sign in to comment.