Skip to content

Docs: README местами описывает API до 1.1.0 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dkxmercury wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: README местами описывает API до 1.1.0 #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@ bool tick(bool pressed = false);
```

#### uEncoderISR
Класс `uEncoder` наследует `uEncoderVirt`, отправляя данные с него в `poll` внутри `tick`. Сам опрос происходит в прерывании, буферизация на 4 щелчка.
Класс `uEncoderISR` наследует `uEncoderVirt`. Опрос происходит в прерывании внутри `tickISR`, результат складывается в буфер на 4 щелчка, а `tick` забирает из буфера по одному событию.

```cpp
// указать пины и их режим работы
uEncoder(uint8_t p0, uint8_t p1, uint8_t mode = INPUT);
uEncoderISR(uint8_t p0, uint8_t p1, uint8_t mode = INPUT);

// опросить энкодер
bool tick();
Expand Down Expand Up @@ -173,17 +173,8 @@ void tickISR();

uEncButton eb(2, 3, 4);

// режим опроса энка в прерывании
// void isr() {
// eb.tickISR();
// }

void setup() {
Serial.begin(115200);

// режим опроса энка в прерывании
// attachInterrupt(0, isr, CHANGE);
// attachInterrupt(1, isr, CHANGE);
}

void loop() {
Expand Down Expand Up @@ -218,6 +209,8 @@ void loop() {
}
```

Для опроса энкодера в прерывании нужен класс `uEncButtonISR` - у него есть `tickISR`, который вешается на `attachInterrupt` по `CHANGE`. См. пример `demoISR`.

<a id="versions"></a>

## Версии
Expand Down