interface.h

Go to the documentation of this file.

/*
 * (C) Copyright 2024, SECO Mind Srl
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ASTARTE_DEVICE_SDK_INTERFACE_H
#define ASTARTE_DEVICE_SDK_INTERFACE_H
 
#include "astarte_device_sdk/astarte.h"
#include "astarte_device_sdk/mapping.h"
#include "astarte_device_sdk/result.h"
 
typedef enum
{
    ASTARTE_INTERFACE_OWNERSHIP_DEVICE = 1, 
    ASTARTE_INTERFACE_OWNERSHIP_SERVER, 
} astarte_interface_ownership_t;
 
typedef enum
{
    ASTARTE_INTERFACE_TYPE_DATASTREAM = 1, 
    ASTARTE_INTERFACE_TYPE_PROPERTIES, 
} astarte_interface_type_t;
 
typedef enum
{
    ASTARTE_INTERFACE_AGGREGATION_INDIVIDUAL = 1, 
    ASTARTE_INTERFACE_AGGREGATION_OBJECT, 
} astarte_interface_aggregation_t;
 
#define ASTARTE_INTERFACE_NAME_MAX_SIZE 128
 
typedef struct
{
    const char *name;
    uint32_t major_version;
    uint32_t minor_version;
    astarte_interface_ownership_t ownership;
    astarte_interface_type_t type;
    astarte_interface_aggregation_t aggregation;
    const astarte_mapping_t *mappings;
    size_t mappings_length;
} astarte_interface_t;
 
#endif // ASTARTE_DEVICE_SDK_INTERFACE_H