client.hpp

Go to the documentation of this file.

 
 
#ifndef WATERLINKEDSONAR_CLIENT_HPP
#define WATERLINKEDSONAR_CLIENT_HPP
 
#include <chrono>
#include <cstdint>
#include <memory>
#include <string>
#include <waterlinkedsonar/http_transport.hpp>
#include <waterlinkedsonar/types.hpp>
 
namespace waterlinked::sonar {
 
class SonarClient {
 public:
  explicit SonarClient(std::unique_ptr<HttpTransport> transport);
 
  explicit SonarClient(
      const std::string& ip, std::uint16_t port = 80,
      std::chrono::milliseconds timeout = std::chrono::seconds(5));
 
  ~SonarClient();
  SonarClient(SonarClient&&) noexcept;
  SonarClient& operator=(SonarClient&&) noexcept;
  SonarClient(const SonarClient&) = delete;
  SonarClient& operator=(const SonarClient&) = delete;
 
  [[nodiscard]] const std::string& firmware_version() const {
    return firmware_version_;
  }
 
  About about();
  Status status();
  double temperature();
 
  bool acoustics_enabled();
  void set_acoustics_enabled(bool enabled);
 
  Range range();
  void set_range(Range range);
 
  double speed_of_sound();
  void set_speed_of_sound(double speed);
 
  AcousticsMode mode();
  void set_mode(AcousticsMode mode);
 
  Salinity salinity();
  void set_salinity(Salinity salinity);
 
  UdpConfig udp_config();
  void set_udp_config(const UdpConfig& config);
 
  bool imu_batch_enabled();
  void set_imu_batch_enabled(bool enabled);
 
  TimeStatus time_status();
 
  void set_time_manual(std::chrono::system_clock::time_point now);
 
  std::string ntp_address();
  void set_ntp_address(const std::string& address);
 
  ForceSyncResult force_sync_ntp(std::chrono::seconds timeout);
 
 private:
  void require_firmware(const char* what, const char* min_version) const;
 
  std::unique_ptr<HttpTransport> transport_;
  std::string firmware_version_;
};
 
}  // namespace waterlinked::sonar
 
#endif  // WATERLINKEDSONAR_CLIENT_HPP