Astarte device API for Zephyr 0.7.2
Astarte device SDK for Zephyr RTOS
Loading...
Searching...
No Matches

Astarte interface representation. More...

Data Structures

struct  astarte_interface_t
 Astarte interface definition. More...
 

Macros

#define ASTARTE_INTERFACE_NAME_MAX_SIZE   128
 Maximum allowed length of an interface name.
 

Enumerations

enum  astarte_interface_ownership_t { ASTARTE_INTERFACE_OWNERSHIP_DEVICE = 1 , ASTARTE_INTERFACE_OWNERSHIP_SERVER }
 interface ownership More...
 
enum  astarte_interface_type_t { ASTARTE_INTERFACE_TYPE_DATASTREAM = 1 , ASTARTE_INTERFACE_TYPE_PROPERTIES }
 interface type More...
 
enum  astarte_interface_aggregation_t { ASTARTE_INTERFACE_AGGREGATION_INDIVIDUAL = 1 , ASTARTE_INTERFACE_AGGREGATION_OBJECT }
 interface aggregation More...
 

Detailed Description

Astarte interface representation.

See: https://docs.astarte-platform.org/astarte/latest/040-interface_schema.html

Macro Definition Documentation

◆ ASTARTE_INTERFACE_NAME_MAX_SIZE

#define ASTARTE_INTERFACE_NAME_MAX_SIZE   128

Maximum allowed length of an interface name.

Includes the terminating null char. https://docs.astarte-platform.org/astarte/latest/040-interface_schema.html#astarte-interface-schema-interface_name

Enumeration Type Documentation

◆ astarte_interface_aggregation_t

interface aggregation

This enum represents the possible Astarte interface aggregation https://docs.astarte-platform.org/astarte/latest/040-interface_schema.html#astarte-interface-schema-aggregation

Enumerator
ASTARTE_INTERFACE_AGGREGATION_INDIVIDUAL 

Aggregation individual.

ASTARTE_INTERFACE_AGGREGATION_OBJECT 

Aggregation object.

◆ astarte_interface_ownership_t

interface ownership

This enum represents the possible ownerhips of an Astarte interface https://docs.astarte-platform.org/astarte/latest/040-interface_schema.html#astarte-interface-schema-ownership

Enumerator
ASTARTE_INTERFACE_OWNERSHIP_DEVICE 

Device owned interface.

ASTARTE_INTERFACE_OWNERSHIP_SERVER 

Server owned interface.

◆ astarte_interface_type_t

interface type

This enum represents the possible types of an Astarte interface https://docs.astarte-platform.org/astarte/latest/040-interface_schema.html#astarte-interface-schema-type

Enumerator
ASTARTE_INTERFACE_TYPE_DATASTREAM 

Datastream interface.

ASTARTE_INTERFACE_TYPE_PROPERTIES 

Properties interface.