o3r.h

/*
 * Copyright 2021-present ifm electronic, gmbh
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef IFM3D_DEVICE_O3R_H
#define IFM3D_DEVICE_O3R_H
 
#include <ifm3d/common/features.h>
#include <ifm3d/device/device.h>
#ifdef BUILD_MODULE_CRYPTO
#  include <ifm3d/crypto/crypto.h>
#endif
 
namespace ifm3d
{
  static const int NET_WAIT_O3R_SET =
    std::getenv("IFM3D_NET_WAIT_O3R_SET") == nullptr ?
      15000 :
      std::stoi(std::getenv("IFM3D_NET_WAIT_O3R_SET"));
 
  struct IFM3D_EXPORT PortInfo
  {
    std::string port;
    uint16_t pcic_port;
    std::string type;
  };
 
#ifdef BUILD_MODULE_CRYPTO
  class O3RSealedBox;
#endif
 
  class IFM3D_EXPORT O3R : public Device
  {
  public:
    using Ptr = std::shared_ptr<O3R>;
    O3R(const std::string& ip = ifm3d::DEFAULT_IP,
        const std::uint16_t xmlrpc_port = ifm3d::DEFAULT_XMLRPC_PORT);
 
    virtual ~O3R();
    O3R(O3R&&) = delete;
    O3R& operator=(O3R&&) = delete;
    O3R(O3R&) = delete;
    O3R& operator=(O3R&) = delete;
 
    virtual void FactoryReset(bool keepNetworkSettings);
 
    json GetSchema();
 
    json Get(
      const std::vector<std::string>& path = std::vector<std::string>());
 
    json ResolveConfig(const json::json_pointer& ptr);
 
    void Set(const json& j);
 
    void Remove(const std::string& jsonPointer);
 
    void Reset(const std::string& jsonPointer);
 
    json GetInit();
 
    void SaveInit(const std::vector<std::string>& pointers = {});
 
    std::string GetInitStatus();
 
    void Lock(const std::string& password);
 
    void Unlock(const std::string& password);
 
    std::vector<PortInfo> Ports();
 
    PortInfo Port(const std::string& port);
 
    json GetDiagnostic();
 
    json GetDiagnosticFilterSchema();
 
    json GetDiagnosticFiltered(json filter);
 
    void Reboot(
      const boot_mode& mode = ifm3d::Device::boot_mode::PRODUCTIVE) override;
 
    void RebootToRecovery();
 
    device_family WhoAmI() override;
    ifm3d::Device::swu_version SwUpdateVersion() override;
 
    json ToJSON() override;
 
    void FromJSON(const json& j) override;
 
    void DownloadServiceReport(std::string outFile);
 
#ifdef BUILD_MODULE_CRYPTO
 
    std::shared_ptr<O3RSealedBox> SealedBox();
#endif
 
  private:
    class Impl;
    std::shared_ptr<Impl> pImpl;
 
#ifdef BUILD_MODULE_CRYPTO
    friend class O3RSealedBox;
#endif
  }; // end: class O3R
 
#ifdef BUILD_MODULE_CRYPTO
 
  class IFM3D_EXPORT O3RSealedBox
  {
  public:
    using Ptr = std::shared_ptr<O3RSealedBox>;
 
    O3RSealedBox(std::shared_ptr<O3R::Impl> pImpl);
    ~O3RSealedBox();
 
    void SetPassword(const std::string& new_password,
                     std::optional<std::string> old_password = std::nullopt);
 
    bool IsPasswordProtected();
 
    void RemovePassword(std::string password);
 
    void Set(const std::string& password, const json& configuration);
 
    std::vector<uint8_t> GetPublicKey();
 
  private:
    std::shared_ptr<O3R::Impl> pImpl;
  };
#endif
}
 
#endif // IFM3D_DEVICE_O3R_H