add manual and setup in README

This commit is contained in:
Mateusz Walkowiak
2023-06-03 21:04:36 +02:00
committed by GitHub
parent 31fc03c69f
commit 44dc01b9ee

View File

@@ -1,8 +1,26 @@
# TEF6686_ESP32
Advanced Arduino based firmware for TEF6686 tuner with ESP32 board
Advanced Tuner software for NXP TEF668x tuners with ESP32 board\
Based on Catena / NXP semiconductors API
More information: https://www.pe5pvb.nl/tef6686/
## Setup
During boot hold:
- **BW** button to change rotary encoder direction
- **Mode** button the flip screen
- **Standby** button to calibrate analogue S-meter
- **Rotary** button to switch between normal and optical rotary encoder
## Manual
- **STANDBY SHORT** PRESS: Switch band
- **STANDBY LONG** PRESS: Standby
- **ROTARY SHORT** PRESS: Set stepsize or navigate
- **ROTARY LONG** PRESS: Toggle iMS & EQ
- **MODE SHORT** PRESS: Switch between auto/manual or exit menu
- **MODE LONG** PRESS: Open menu
- **BW SHORT** PRESS: Switch bandwidth setting
- **BW LONG** PRESS: Switch mono, or auto stereo
## Instalation
**Recommended method:** You can download already compiled software and upload it using prepared script from [release page](https://github.com/PE5PVB/TEF6686_ESP32/releases).
@@ -26,6 +44,15 @@ More information: https://www.pe5pvb.nl/tef6686/
From v1.16 you **need to** update your ESP32 boards in board manager to v2.x
### Connecting analog signal meter
```
to meter
|
R V
IO27 -------=====-----=====---|
1 k 5 k POT
```
## License
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.