OTA_Update_Callback.h

Go to the documentation of this file.

#ifndef OTA_Update_Callback_h
#define OTA_Update_Callback_h
 
// Local includes.
#include "Callback.h"
#include "IUpdater.h"
#include "Timeoutable_Request.h"
 
 
// OTA default values.
uint8_t constexpr CHUNK_RETRIES = 12U;
uint16_t constexpr CHUNK_SIZE = (4U * 1024U);
uint64_t constexpr REQUEST_TIMEOUT_MS = (5U * 1000U * 1000U);
 
 
class OTA_Update_Callback : public Callback<void, bool const &> {
  public:
    OTA_Update_Callback() = default;
 
    // because the whole chunk is saved into the heap before it can be processed and is then erased again after it has been used, default = CHUNK_SIZE
    OTA_Update_Callback(char const * current_fw_title, char const * current_fw_version, IUpdater * updater, function finished_callback, Callback<void, size_t const &, size_t const &>::function progress_callback = nullptr, Callback<void>::function update_starting_callback = nullptr, uint8_t chunk_retries = CHUNK_RETRIES, uint16_t chunk_size = CHUNK_SIZE, uint64_t const & timeout_microseconds = REQUEST_TIMEOUT_MS);
 
    ~OTA_Update_Callback() override = default;
 
    char const * Get_Firmware_Title() const;
 
    void Set_Firmware_Title(const char * current_fw_title);
 
    char const * Get_Firmware_Version() const;
 
    void Set_Firmware_Version(const char *current_fw_version);
 
    IUpdater * Get_Updater() const;
 
    void Set_Updater(IUpdater * updater);
 
    size_t const & Get_Request_ID() const;
 
    void Set_Request_ID(size_t const & request_id);
 
    void Call_Progress_Callback(size_t const & current, size_t const & total) const;
 
    void Set_Progress_Callback(Callback<void, size_t const &, size_t const &>::function progress_callback);
 
    void Call_Update_Starting_Callback() const;
 
    void Set_Update_Starting_Callback(Callback<void>::function update_starting_callback);
 
    uint8_t Get_Chunk_Retries() const;
 
    void Set_Chunk_Retries(uint8_t chunk_retries);
 
    uint16_t Get_Chunk_Size() const;
 
    void Set_Chunk_Size(uint16_t chunk_size);
 
    Timeoutable_Request & Get_Request_Timeout();
 
  private:
    char const                                     *m_current_fw_title = {};        // Current firmware title of device
    char const                                     *m_current_fw_version = {};      // Current firmware version of device
    IUpdater                                       *m_updater = {};                 // Updater implementation used to write firmware data
    size_t                                         m_request_id = {};               // Id the request was called with
    Callback<void, size_t const &, size_t const &> m_progress_callback = {};        // Callback called when amount of downloaded chunks increased
    Callback<void>                                 m_update_starting_callback = {}; // Callback called when update is about to start (moment before topic subscription)
    uint8_t                                        m_chunk_retries = {};            // Maximum amount of retries for a single chunk to be downloaded and flashed successfully
    uint16_t                                       m_chunk_size = {};               // Size of chunks the firmware data will be split into
    Timeoutable_Request                            m_request_timeout = {};          // Handles callback that will be called if request times out
};
 
#endif // OTA_Update_Callback_h