xmodem.h

/*
 * Copyright (C) 2023 Debayan Sutradhar (rnayabed) (debayansutradhar3@gmail.com)
 *
 * 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.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#ifndef XMODEM_H
#define XMODEM_H

#include "device.h"
#include <vector>
#include <filesystem>

class XModem
{
public:

    enum Error
    {
        NONE,
        DEVICE_RELATED,
        FILE_DOES_NOT_EXIST,
        FILE_OPEN_FAILED,
        MAX_RETRY_SURPASSED,
        CANCELLED
    };

    XModem(Device& device,
           const int32_t& maxRetry,
           const int32_t& blockSize);

    const Error& error();
    std::string errorStr();

    bool upload(const std::filesystem::path& filePath, const bool& startAfterUpload);

private:
    Error m_error;
    Device& m_device;
    int32_t m_maxRetry;
    int32_t m_blockSize;

    constexpr static unsigned char SOH   {0x01};
    constexpr static unsigned char EOT   {0x04};
    constexpr static unsigned char ACK   {0x06};
    constexpr static unsigned char NAK   {0x15};
    constexpr static unsigned char CAN   {0x18};
    constexpr static unsigned char SUB   {0x1a};
    constexpr static unsigned char CR    {0x1d};
    constexpr static unsigned char C     {'C'};
};

#endif // XMODEM_H