Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
v1605 authored Nov 17, 2024
1 parent 5f08d59 commit 1e414aa
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ The project is now supporting the intial release of the v2 api (which uses webso
## Setup
1. If you haven't already, downalod and install Ardunio Studio.
2. Install the above Libaries.
3. Clone/Download the repository and open Tap2Esp32.ino in Arunido Studio.
3. Clone/Download the repository and open ZaparooEsp32.ino in Arunido Studio.
4. Select your board and port, located in the Tools menu. If you do not have options for an Esp32, follow these [instrustions](https://docs.sunfounder.com/projects/umsk/en/latest/03_esp32/esp32_start/03_install_esp32.html) for installing the board configurations.
5. Edit the ReadTag.hpp file to define your pins for the MFRC522, the Mister url (using the Remote port until TapTo 2.0, default 8182), and your Wifi credentials.
5. Edit the ZaparooEsp32.hpp file to define your pins for the MFRC522, the Mister url (using the Remote port until TapTo 2.0, default 8182), and your Wifi credentials.
6. (Optional) If you are planning to use a battery to power the Esp32, it might help to extend battery life by decreasing the CPU frequency under tools. If using the audio configuration, you need a min cpu of 160mhz.
7. (Optional) Enable any of the settings in the optional section of the config by uncommenting the line and setting the correct value for your setup. See "Optional Setup" for more info.
8. (Optional) If using audio options, make sure your "Partion Scheme" under tools is set to "Default xMB with spiffs". xMB will vary based on your board, but 4MB is common. After you upload the project, follow the instructons [here](https://randomnerdtutorials.com/arduino-ide-2-install-esp32-littlefs/) to upload a mp3 (test with [this gb sound effect](https://tuna.voicemod.net/sound/e4674ff7-386c-4932-9faf-e50c82d45099)).
9. Compile and upload the project your esp32.

## Optional Setup
These descriptions are for the optional config options found in the ReadTag.hpp file. Uncommment and edit the lines in the config if you want to enable them.
These descriptions are for the optional config options found in the ZaparooEsp32.hpp file. Uncommment and edit the lines in the config if you want to enable them.
1. SERIAL_ONLY: Uncommenting this setting will disable wifi. Only Simple Serial will be supported in this mode.
2. MOTOR_PIN: Sends a pulse to this pin when WiFi is connected, a game is launched, or some error has occurred (see Error Feedback). It is intended for a small vibration motor to provide haptic feedback.
3. WIFI_LED_PIN: This pin will enter a high state once a WiFi connection has been established.
Expand All @@ -40,9 +40,9 @@ These descriptions are for the optional config options found in the ReadTag.hpp

## Error Feedback
If you choose to enable the Motor or Launch pins in the config file, you can get additional feedback when scanning a card:
* 2 Pulses: Could not connect to TapTo
* 3 Pulses: TapTo could not read the text, check your tag
* 4 Pulses: TapTo sent a payload that could not be parsed to JSON.
* 2 Pulses: Could not connect to Zaparoo
* 3 Pulses: Zaparoo could not read the text, check your tag
* 4 Pulses: Zaparoo sent a payload that could not be parsed to JSON.

## Portable Options
It is possible to incorporate a battery to make a wireless NFC adapter. There are a two options to consider.
Expand Down

0 comments on commit 1e414aa

Please sign in to comment.