Skip to content

Commit 1602f9c

Browse files
committed
Update README.md
1 parent b23c0e4 commit 1602f9c

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,9 @@ EncButton2<EB_BTN, EB_CALLBACK> enc[количество];
114114
```
115115
</details>
116116

117-
<a id="usage"></a>
118-
## Использование
117+
## Документация
119118
<details>
120-
<summary>Полное описание класса</summary>
119+
<summary>ПОЛНОЕ ОПИСАНИЕ КЛАССА</summary>
121120

122121
```cpp
123122
// =============== SETTINGS ==============
@@ -219,6 +218,7 @@ void setPins(uint8_t mode, uint8_t P1, uint8_t P2, uint8_t P3); // наст
219218
- Точный алгоритм активируется добавлением `#define EB_BETTER_ENC` перед подключением библиотеки
220219
- Версия библиотеки *EncButton2.h* хранит номера пинов в классе. Используйте эту версию для создания массива объектов EncButton!
221220

221+
<a id="usage"></a>
222222
## Особенности и сценарии использования
223223
### Дефайны настроек
224224
```cpp
@@ -308,11 +308,12 @@ void detachClicks(); // отключить обработ
308308
Виртуальный режим позволяет получить все возможности библиотеки EncButton в ситуациях, когда кнопка не подключена напрямую к микроконтроллеру, либо для её опроса используется другая библиотека:
309309
- Аналоговая клавиатура (например через библиотеку [AnalogKey](https://github.com/GyverLibs/AnalogKey))
310310
- Матричная клавиатура (например через библиотеку [SimpleKeypad](https://github.com/maximebohrer/SimpleKeypad))
311-
- Кнопки или энкодеры, подключенные через расширители пинов или сдвиговые регистры
311+
- Кнопки или энкодеры, подключенные через расширители пинов или сдвиговые регистры
312+
312313
Для работы нужно передать в `tick()` текущие состояния "пинов" кнопки/энкодера: `tick(s1, s2, s3)` в следующем порядке
313-
// Кнопка - (сигнал кнопки)
314-
// Энкодер - (сигнал энкодера А, сигнал энкодера B)
315-
// Энкодер с кнопкой - (сигнал энкодера А, сигнал энкодера B, сигнал кнопки)
314+
- Кнопка - (сигнал кнопки)
315+
- Энкодер - (сигнал энкодера А, сигнал энкодера B)
316+
- Энкодер с кнопкой - (сигнал энкодера А, сигнал энкодера B, сигнал кнопки)
316317

317318
### Настройки
318319
```cpp

0 commit comments

Comments
 (0)