Umbrella namespace for the Astarte device library. More...

Namespaces
namespace	grpc
	Namespace for Astarte device functionality using the gRPC transport layer.

namespace	mqtt
	Namespace for Astarte device functionality using the MQTT transport protocol.

namespace	utils
	Utility functions for formatting data.

Classes
class	Data
	Represents a single Astarte data value. More...

class	DataSerializationError
	Specific error for when a serialization operation failed. More...

class	DatastreamIndividual
	Represents the Astarte individual datastream data. More...

class	DatastreamObject
	Astarte object class, representing the Astarte object datastream data. More...

class	Device
	Interface for an Astarte device. More...

class	ErrorBase
	Base error class representing any possible error from the Astarte device library. More...

class	FileOpenError
	Specific error for when a file cannot be opened. More...

class	GrpcLibError
	Error reported by the gRPC transport library. More...

class	InterfaceValidationError
	Error during the Interface validation process. More...

class	InternalError
	Specific error for when an operation failed due to an internal error. More...

class	InvalidAstarteTypeError
	Error indicating that the provided Astarte type is incorrect. More...

class	InvalidDatabaseRetentionPolicyError
	Error indicating that the provided Astarte database retention policy is incorrect. More...

class	InvalidInputError
	Specific error for when an operation failed due to incompatible user input. More...

class	InvalidInterfaceAggregationError
	Error indicating that the provided interface aggregation is incorrect. More...

class	InvalidInterfaceOwnershipeError
	Error indicating that the provided interface ownership is incorrect. More...

class	InvalidInterfaceTypeError
	Error indicating that the provided interface type is incorrect. More...

class	InvalidInterfaceVersionError
	Error indicating that the minor or major version of an interface is incorrect. More...

class	InvalidReliabilityError
	Error indicating that the provided Astarte reliability is incorrect. More...

class	InvalidRetentionError
	Error indicating that the provided Astarte retention is incorrect. More...

class	Message
	Astarte message class, represents a full message for/from Astarte. More...

class	MsgHubError
	Error reported by the Astarte message hub library. More...

class	OperationRefusedError
	An operation which is not permitted according to the current device status was attempted. More...

class	PropertyIndividual
	Representing the Astarte individual property data. More...

class	StoredProperty
	Represents a stored property on the device. More...

Concepts
concept	DataAllowedType
	C++ concept to restrict the allowed types for instances of an Astarte data class.

Typedefs
using	Error
	Variant type representing any error from the Astarte device library.

Enumerations
enum	Ownership : int8_t { kDevice , kServer }
	Possible Astarte ownership. More...

enum	Type : int8_t { kBinaryBlob , kBoolean , kDatetime , kDouble , kInteger , kLongInteger , kString , kBinaryBlobArray , kBooleanArray , kDatetimeArray , kDoubleArray , kIntegerArray , kLongIntegerArray , kStringArray }
	Enumeration of supported Astarte data types. More...

Functions
auto	ownership_from_str (const std::string &ownership) -> astarte_tl::expected< Ownership, Error >
	Converts a string to an Ownership enum.

auto	astarte_type_from_str (const std::string &type) -> astarte_tl::expected< Type, Error >
	Converts a string representation of a type to a Type enum.

Detailed Description

Umbrella namespace for the Astarte device library.

Typedef Documentation

◆ Error

using astarte::device::Error

Initial value:

 
    std::variant<DataSerializationError, InternalError, FileOpenError, InvalidInputError,
                 InterfaceValidationError, InvalidInterfaceVersionError, InvalidInterfaceTypeError,
                 InvalidInterfaceOwnershipeError, InvalidInterfaceAggregationError,
                 InvalidAstarteTypeError, InvalidReliabilityError, InvalidRetentionError,
                 InvalidDatabaseRetentionPolicyError,
 
                 OperationRefusedError, GrpcLibError, MsgHubError, mqtt::JsonParsingError,
                 mqtt::DeviceRegistrationError, mqtt::PairingApiError, mqtt::MqttError,
                 mqtt::InvalidUrlError, mqtt::RetrieveBrokerUrlError, mqtt::ReadCredentialError,
                 mqtt::WriteCredentialError, mqtt::PairingConfigError, mqtt::CryptoError,
                 mqtt::UuidError, mqtt::HttpError, mqtt::MqttConnectionError>

Variant type representing any error from the Astarte device library.

Intended for use as the error type E in astarte_tl::expected<T, E>. This allows for efficient, stack-allocated error reporting across the SDK.

Enumeration Type Documentation

◆ Ownership

enum astarte::device::Ownership : int8_t

Possible Astarte ownership.

Enumerator
kDevice	Ownership is retained by the device.
kServer	Ownership is retained by the Astarte cloud server.

◆ Type

enum astarte::device::Type : int8_t

Enumeration of supported Astarte data types.

These types correspond to the data types defined in Astarte interfaces and are used to validate and tag data sent to or received from the platform.

Enumerator
kBinaryBlob	Binary blob Astarte type.
kBoolean	Boolean Astarte type.
kDatetime	Date-time Astarte type.
kDouble	Double Astarte type.
kInteger	Integer Astarte type.
kLongInteger	Long integer Astarte type.
kString	String Astarte type.
kBinaryBlobArray	Binary blob array Astarte type.
kBooleanArray	Boolean array Astarte type.
kDatetimeArray	Datetime array Astarte type.
kDoubleArray	Double array Astarte type.
kIntegerArray	Integer array Astarte type.
kLongIntegerArray	Long integer array Astarte type.
kStringArray	String array Astarte type.

Function Documentation

◆ astarte_type_from_str()

auto astarte::device::astarte_type_from_str ( const std::string & type ) -> astarte_tl::expected<Type, Error>

inline

Converts a string representation of a type to a Type enum.

This function maps the string identifiers used in Astarte interface definitions (e.g., "binaryblob", "integer") to their corresponding C++ enum values.

Parameters

[in] type The string representation of the Astarte type.

Returns: An expected containing the Type on success or Error on failure.

◆ ownership_from_str()

auto astarte::device::ownership_from_str ( const std::string & ownership ) -> astarte_tl::expected<Ownership, Error>

inline

Converts a string to an Ownership enum.

Parameters

[in] ownership The string representation of the interface ownership.

Returns: An expected containing the Ownership on success or Error on failure.

Namespaces

Classes

Concepts

Typedefs

Enumerations

Functions