swupdater.h

/*
 * Copyright 2019 ifm electronic, gmbh
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef IFM3D_SWUPDATER_SWUPDATER_H
#define IFM3D_SWUPDATER_SWUPDATER_H
#pragma once
 
#include <ifm3d/device/legacy_device.h>
#include <ifm3d/swupdater/module_swupdater.h>
#include <memory>
#include <string>
 
namespace ifm3d
{
  /* const for the swupdate recovery port value */
  extern IFM3D_EXPORT const std::uint16_t SWUPDATER_RECOVERY_PORT;
 
  class IFM3D_EXPORT SWUpdater
  {
  public:
    using Ptr = std::shared_ptr<SWUpdater>;
 
    using FlashStatusCb = std::function<void(float, const std::string&)>;
 
    SWUpdater(
      const ifm3d::Device::Ptr& cam,
      const ifm3d::SWUpdater::FlashStatusCb& cb = {},
      std::uint16_t swupdate_recovery_port = ifm3d::SWUPDATER_RECOVERY_PORT,
      std::optional<ifm3d::Device::SWUVersion> force_swu_version =
        std::nullopt);
 
    virtual ~SWUpdater();
 
    // disable copy/move semantics
    SWUpdater(SWUpdater&&) = delete;
    SWUpdater& operator=(SWUpdater&&) = delete;
    SWUpdater(SWUpdater&) = delete;
    SWUpdater& operator=(const SWUpdater&) = delete;
 
    void RebootToRecovery(
      const std::optional<std::string>& password = std::nullopt);
 
    bool WaitForRecovery(long timeout_millis = 0);
 
    void RebootToProductive();
 
    bool WaitForProductive(long timeout_millis = 0);
 
    bool FlashFirmware(const std::string& swu_file, long timeout_millis = 0);
 
    class IFM3D_EXPORT Impl;
 
  private:
    std::unique_ptr<Impl> _impl;
 
  }; // end: class SWUpdater
 
} // end: namespace ifm3d
 
#endif // IFM3D_SWUPDATER_SWUPDATER_H