Skip to content

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

Open
dkxmercury wants to merge 1 commit into
GyverLibs:mainfrom
dkxmercury:fix/readme-1.1.0-api
Open

Docs: README местами описывает API до 1.1.0#3
dkxmercury wants to merge 1 commit into
GyverLibs:mainfrom
dkxmercury:fix/readme-1.1.0-api

Conversation

@dkxmercury

Copy link
Copy Markdown

Мелочь, но спотыкаешься сразу: README местами остался от версии до 1.1.0.

Что поправил

1. Секция #### uEncoderISR - копипаста из секции uEncoder, класс не переименовали:

  • было «Класс uEncoder наследует...», стало «Класс uEncoderISR наследует...»
  • конструктор был объявлен как uEncoder(uint8_t p0, ...), стало uEncoderISR(...)
  • описание «отправляя данные с него в poll внутри tick» переехало из опросного класса и для ISR-варианта неверно: poll там приватный (using uEncoderVirt::poll в private), а tick разгребает буфер. Переписал по факту: опрос в tickISR, результат в буфер на 4 щелчка, tick достаёт по одному событию.

2. Пример предлагал раскомментировать eb.tickISR() и attachInterrupt на объекте uEncButton:

uEncButton eb(2, 3, 4);

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

После 1.1.0 у uEncButton метода tickISR нет вообще (он только у uEncButtonISR), так что раскомментировать это нельзя - не соберётся. Убрал эти строки, тем более что в реальном examples/demo/demo.ino их и нет, и добавил строчку под примером, что режим прерываний - это uEncButtonISR и пример demoISR.

README_EN не трогал

Он отстал целиком: секций uEncoderISR/uEncButtonISR там нет вовсе, зато у uEncoder и uEncButton до сих пор документирован tickISR. Но он явно генерится автоматом (судя по стилю перевода), поэтому лезть туда руками не стал - подтянется от русского. Если нет, скажи, поправлю отдельно.


Кстати, давно смотрю тебя на ютубе и читаю канал в тг, так что помочь либам было в радость. Спасибо за то, что всё выкладываешь открыто, вместе с исходниками и разбором сборки - это редкость.

Видел твой ответ в uButton#3 про то, что PR не принимаешь и пишешь сам. Твоё право. Если возьмёшь как есть, буду рад, а нет - просто перенеси правки к себе, тут их на минуту.

- секция uEncoderISR описывала класс и конструктор как uEncoder
  (копипаста), а описание работы tick было от опросного класса
- пример предлагал раскомментировать eb.tickISR() на uEncButton,
  у которого этого метода больше нет, только у uEncButtonISR
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant