device.hpp

Go to the documentation of this file.

// (C) Copyright 2025, SECO Mind Srl
//
// SPDX-License-Identifier: Apache-2.0
 
#ifndef ASTARTE_DEVICE_SDK_DEVICE_H
#define ASTARTE_DEVICE_SDK_DEVICE_H

 
#include <chrono>
#include <filesystem>
#include <optional>
#include <string>
#include <string_view>
 
#include "astarte_device_sdk/data.hpp"
#include "astarte_device_sdk/errors.hpp"
#include "astarte_device_sdk/msg.hpp"
#include "astarte_device_sdk/object.hpp"

namespace AstarteDeviceSdk {

class AstarteDevice {
 public:
  virtual ~AstarteDevice() = default;
  AstarteDevice(const AstarteDevice& other) = delete;
  AstarteDevice(AstarteDevice&& other) = default;
  auto operator=(const AstarteDevice& other) -> AstarteDevice& = delete;
  auto operator=(AstarteDevice&& other) -> AstarteDevice& = default;
  virtual auto add_interface_from_file(const std::filesystem::path& json_file)
      -> astarte_tl::expected<void, AstarteError> = 0;
  virtual auto add_interface_from_str(std::string_view json)
      -> astarte_tl::expected<void, AstarteError> = 0;
  virtual auto remove_interface(const std::string& interface_name)
      -> astarte_tl::expected<void, AstarteError> = 0;
  virtual auto connect() -> astarte_tl::expected<void, AstarteError> = 0;
  [[nodiscard]] virtual auto is_connected() const -> bool = 0;
  virtual auto disconnect() -> astarte_tl::expected<void, AstarteError> = 0;
  virtual auto send_individual(std::string_view interface_name, std::string_view path,
                               const AstarteData& data,
                               const std::chrono::system_clock::time_point* timestamp)
      -> astarte_tl::expected<void, AstarteError> = 0;
  virtual auto send_object(std::string_view interface_name, std::string_view path,
                           const AstarteDatastreamObject& object,
                           const std::chrono::system_clock::time_point* timestamp)
      -> astarte_tl::expected<void, AstarteError> = 0;
  virtual auto set_property(std::string_view interface_name, std::string_view path,
                            const AstarteData& data)
      -> astarte_tl::expected<void, AstarteError> = 0;
  virtual auto unset_property(std::string_view interface_name, std::string_view path)
      -> astarte_tl::expected<void, AstarteError> = 0;
  virtual auto poll_incoming(const std::chrono::milliseconds& timeout)
      -> std::optional<AstarteMessage> = 0;
 
 protected:
  AstarteDevice() = default;
};
 
}  // namespace AstarteDeviceSdk
 
#endif  // ASTARTE_DEVICE_SDK_DEVICE_H