docs and cleanup

This commit is contained in:
2024-01-26 10:42:37 +03:00
parent d0e0af53c4
commit 469d9875c8
3 changed files with 235 additions and 422 deletions

View File

@ -21,25 +21,31 @@
#define aroundRise(t) (riseTimeMin < t && t < riseTimeMax)
#define IR_timeout (riseTimeMax * (8 + syncBits +1)) // us // таймаут в 8 data + 3 sync + 1
#define subBufferSize 5 //Буфер для складирования фронтов, пока их не обработают
#define subBufferSize 7 //Буфер для складирования фронтов, пока их не обработают
class IR_Encoder;
class IR_Decoder : private IR_FOX {
friend IR_Encoder;
public:
uint16_t addrSelf;
/// @brief Конструктор
/// @param isrPin Номер вывода прерывания/данных от приёмника (2 или 3 для atmega 328p)
/// @param addr Адрес приёмника
/// @param encPair Указатель на передатчик, работающий в паре
IR_Decoder(const uint8_t isrPin, uint16_t addr, IR_Encoder* encPair = nullptr);
~IR_Decoder();
// @brief Для прерывания
// @brief Функция прерывания
void isr();
/// @brief Обработка приёмника, необходима для работы
void tick();
// @return Буффер переполнился
bool isOverflow() { return isBufferOverflow; };
/// @brief Флаг приёма
/// @return Возвращает true, если происходит приём пакета
bool isReciving() { return isRecive; };
// @brief Слушатель для работы isReciving()
void listen();
@ -157,58 +163,51 @@ public:
}
};
/// @brief Контейнер с данными
Data gotData;
Data gotRawData;
// RawData gotRawData;
/// @brief Контейнер с подтверждением
Accept gotAccept;
/// @brief Контейнер с запросом
Request gotRequest;
/// @brief Контейнер с информацией подстройки
RawTune gotTune;
private:
const uint8_t isrPin;
const uint8_t isrPin; // Пин прерывания
IR_Encoder* encoder;
bool isPairSending = false;
bool IsPairSendLOW = false;
IR_Encoder* encoder; // Указатель на парный передатчик
bool isPairSending = false; // Флаг передачи парного передатчика
bool IsPairSendLOW = false; //
volatile bool isRecive = false;
volatile bool isRecive = false; // Флаг приёма
bool isWaitingAccept = false;
uint16_t addrWaitingFrom = 0;
bool isWaitingAccept = false; // Флаг ожидания подтверждения
uint16_t addrWaitingFrom = 0; // Адрес, от кого ожидается подтверждение
uint16_t addrFrom = 0;
uint16_t riseSyncTime = bitTime; // Подстраиваемое время бита в мкс
uint16_t riseSyncTime = bitTime;
bool isCrcCorrect = false; // Флаг корректности crc
bool isBufferOverflow = false; // Флаг переполнения буффера данных
bool isWrongPack = false; // Флаг битого пакета
volatile bool isRawAvaliable = false;
volatile bool isPreamb = false; // флаг начальной последовости
bool HIGH_FIRST = true; //TODO: порядок приходящих битов
volatile bool isMsgAvaliable = false;
volatile bool isBufferOverflow = false;
bool isWrongPack = false;
volatile bool isPreamb = false; // флаг начальной последовости
bool HIGH_FIRST = true; // порядок приходящих битов
//Буффер
// const uint8_t bufferRawSize =
// ((bufferBitSizeMax % 8 > 0) ?
// (bufferBitSizeMax / 8) + 1 :
// (bufferBitSizeMax / 8));
const uint8_t bufferDataSize = dataByteSizeMax; // + crc
////////////////////////////////////////////////////////////////////////
void noFunc();
volatile uint8_t currentSubBufferIndex; // Счетчик текущей позиции во вспомогательном буфере фронтов/спадов
// Структура для хранения времени и направления фронта/спада
struct FrontStorage {
volatile uint32_t time; // Время
volatile bool dir; // Направление (true = ↑; false = ↓)
volatile FrontStorage* next; // Указатель на следующий связанный фронт/спад, или nullptr если конец
volatile uint8_t currentSubBufferIndex; // Счетчик текущей позиции во вспомогательном буфере фронтов/спадов
struct FrontStorage { // Структура для хранения времени и направления фронта/спада
volatile uint32_t time; // Время
volatile bool dir; // Направление (true = ↑; false = ↓)
volatile FrontStorage* next; // Указатель на следующий связанный фронт/спад, или nullptr если конец
// Операторо присвоения
FrontStorage& operator= (FrontStorage& val) {
FrontStorage& operator= (FrontStorage& val) {
this->next = val.next;
this->time = val.time;
this->dir = val.dir;
@ -220,23 +219,27 @@ private:
volatile FrontStorage* firstUnHandledFront = nullptr; // Указатель первого необработанного фронта/спада
volatile FrontStorage subBuffer[subBufferSize]; // вспомогательный буфер для хранения необработанных фронтов/спадов
////////////////////////////////////////////////////////////////////////
// uint8_t* rawBuffer = nullptr;
uint8_t* dataBuffer = nullptr;
uint8_t* dataBuffer = nullptr; // Указатель на буффер данных
uint32_t prevRise,prevPrevRise, prevFall, prevPrevFall; // Время предыдущих фронтов/спадов
uint16_t errorCounter = 0; // Счётчик ошибок
int8_t preambFrontCounter = 0; // Счётчик __/``` ↑ преамбулы
int16_t bufBitPos = 0; // Позиция для записи бита в буффер
volatile uint32_t prevRise, prevFall, prevPrevFall, prevPrevRise;
volatile uint16_t errorCounter = 0;
volatile int8_t frontCounter = 0;
volatile int16_t bufBitPos = 0;
crc_t crcValue = 0;
private:
uint8_t* getDataBuffer(bool reset = false);
bool crcCheck(uint8_t len);
/// @brief Проверка CRC. Проверяет len байт со значением crc, пришедшим в пакете
/// @param len Длина в байтах проверяемых данных
/// @param crc Результат рассчёта crc (Выходной параметр)
/// @return true если crc верно
bool crcCheck(uint8_t len, uint16_t &crc);
////////////////////////////////////////////////////////////////////////
bool isData = true; // Флаг относится ли бит к данным, или битам синхронизации
uint16_t i_dataBuffer; // Счётчик буфера данных
uint8_t nextControlBit = bitPerByte; // Метка для смены флага isData
uint8_t i_syncBit; // Счётчик битов синхронизации
uint8_t err_syncBit; // Счётчик ошибок синхронизации
/// @brief Запиь бита в буффер, а так же проверка битов синхранизации и их фильтрация
/// @param Бит данных
void writeToBuffer(bool);
////////////////////////////////////////////////////////////////////////