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 <list>
#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"
#include "astarte_device_sdk/ownership.hpp"
#include "astarte_device_sdk/stored_property.hpp"
 
// NOLINTBEGIN(modernize-concat-nested-namespaces) Not nested for doxygen
namespace astarte {
namespace device {
// NOLINTEND(modernize-concat-nested-namespaces)

class Device {
 public:
  virtual ~Device() = default;

  Device(const Device& other) = delete;

  Device(Device&& other) = default;

  auto operator=(const Device& other) -> Device& = delete;

  auto operator=(Device&& other) -> Device& = default;

  virtual auto add_interface_from_file(const std::filesystem::path& json_file)
      -> astarte_tl::expected<void, Error> = 0;

  virtual auto add_interface_from_str(std::string_view json)
      -> astarte_tl::expected<void, Error> = 0;

  virtual auto remove_interface(const std::string& interface_name)
      -> astarte_tl::expected<void, Error> = 0;

  virtual auto connect() -> astarte_tl::expected<void, Error> = 0;

  [[nodiscard]] virtual auto is_connected() const -> bool = 0;

  virtual auto disconnect() -> astarte_tl::expected<void, Error> = 0;

  virtual auto send_individual(std::string_view interface_name, std::string_view path,
                               const Data& data,
                               const std::chrono::system_clock::time_point* timestamp)
      -> astarte_tl::expected<void, Error> = 0;

  virtual auto send_object(std::string_view interface_name, std::string_view path,
                           const DatastreamObject& object,
                           const std::chrono::system_clock::time_point* timestamp)
      -> astarte_tl::expected<void, Error> = 0;

  virtual auto set_property(std::string_view interface_name, std::string_view path,
                            const Data& data) -> astarte_tl::expected<void, Error> = 0;

  virtual auto unset_property(std::string_view interface_name, std::string_view path)
      -> astarte_tl::expected<void, Error> = 0;

  virtual auto poll_incoming(const std::chrono::milliseconds& timeout)
      -> std::optional<Message> = 0;

  virtual auto get_all_properties(const std::optional<Ownership>& ownership)
      -> astarte_tl::expected<std::list<StoredProperty>, Error> = 0;

  virtual auto get_properties(std::string_view interface_name)
      -> astarte_tl::expected<std::list<StoredProperty>, Error> = 0;

  virtual auto get_property(std::string_view interface_name, std::string_view path)
      -> astarte_tl::expected<PropertyIndividual, Error> = 0;
 
 protected:
  Device() = default;
};
 
}  // namespace device
}  // namespace astarte
 
#endif  // ASTARTE_DEVICE_SDK_DEVICE_H