device.h

Go to the documentation of this file.

/*
 * (C) Copyright 2024, SECO Mind Srl
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ASTARTE_DEVICE_SDK_DEVICE_H
#define ASTARTE_DEVICE_SDK_DEVICE_H
 
#include <zephyr/kernel.h>
 
#include "astarte_device_sdk/astarte.h"
#include "astarte_device_sdk/data.h"
#include "astarte_device_sdk/device_id.h"
#include "astarte_device_sdk/interface.h"
#include "astarte_device_sdk/object.h"
#include "astarte_device_sdk/pairing.h"
#include "astarte_device_sdk/result.h"
 
typedef struct astarte_device *astarte_device_handle_t;
 
typedef enum
{
    ASTARTE_DEVICE_EVENT_ERROR, 
    ASTARTE_DEVICE_EVENT_CONNECTED, 
    ASTARTE_DEVICE_EVENT_DISCONNECTED, 
    ASTARTE_DEVICE_EVENT_DATASTREAM_INDIVIDUAL, 
    ASTARTE_DEVICE_EVENT_DATASTREAM_OBJECT, 
    ASTARTE_DEVICE_EVENT_PROPERTY_SET, 
    ASTARTE_DEVICE_EVENT_PROPERTY_UNSET 
} astarte_device_event_type_t;
 
typedef struct
{
    astarte_result_t result; 
    const char *context; 
} astarte_device_error_event_t;
 
typedef struct
{
    astarte_device_handle_t device; 
} astarte_device_connection_event_t;
 
typedef struct
{
    astarte_device_handle_t device; 
} astarte_device_disconnection_event_t;
 
typedef struct
{
    astarte_device_handle_t device; 
    const char *interface_name; 
    const char *path; 
} astarte_device_data_event_t;
 
typedef struct
{
    astarte_device_data_event_t base_event; 
    astarte_data_t data; 
} astarte_device_datastream_individual_event_t;
 
typedef struct
{
    astarte_device_data_event_t base_event; 
    astarte_object_entry_t *entries; 
    size_t entries_len; 
} astarte_device_datastream_object_event_t;
 
typedef struct
{
    astarte_device_data_event_t base_event; 
    astarte_data_t data; 
} astarte_device_property_set_event_t;
 
typedef struct
{
    astarte_device_event_type_t type; 
    union
    {
        astarte_device_error_event_t error;
        astarte_device_connection_event_t connection;
        astarte_device_disconnection_event_t disconnection;
        astarte_device_datastream_individual_event_t datastream_individual;
        astarte_device_datastream_object_event_t datastream_object;
        astarte_device_property_set_event_t property_set;
        astarte_device_data_event_t property_unset;
    } data; 
} astarte_device_event_t;
 
#ifdef CONFIG_ASTARTE_DEVICE_SDK_PERMANENT_STORAGE
typedef struct
{
    astarte_device_handle_t device; 
    const char *interface_name; 
    const char *path; 
    astarte_data_t data; 
    void *user_data; 
} astarte_device_property_loader_event_t;
 
typedef void (*astarte_device_property_loader_cbk_t)(astarte_device_property_loader_event_t event);
#endif
 
typedef struct
{
    int32_t http_timeout_ms;
    int32_t mqtt_connection_timeout_ms;
    int32_t mqtt_poll_timeout_ms;
    char device_id[ASTARTE_DEVICE_ID_LEN + 1];
    char cred_secr[ASTARTE_PAIRING_CRED_SECR_LEN + 1];
    const astarte_interface_t **interfaces;
    size_t interfaces_size;
} astarte_device_config_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
astarte_result_t astarte_device_new(astarte_device_config_t *cfg, astarte_device_handle_t *device);
 
astarte_result_t astarte_device_destroy(astarte_device_handle_t device);
 
astarte_result_t astarte_device_add_interface(
    astarte_device_handle_t device, const astarte_interface_t *interface);
 
astarte_result_t astarte_device_remove_interface(
    astarte_device_handle_t device, const astarte_interface_t *interface);
 
astarte_result_t astarte_device_connect(astarte_device_handle_t device);
 
astarte_result_t astarte_device_disconnect(astarte_device_handle_t device, k_timeout_t timeout);
 
astarte_result_t astarte_device_force_disconnect(astarte_device_handle_t device);
 
astarte_result_t astarte_device_send_individual(astarte_device_handle_t device,
    const char *interface_name, const char *path, astarte_data_t data, const int64_t *timestamp);
 
astarte_result_t astarte_device_send_object(astarte_device_handle_t device,
    const char *interface_name, const char *path, astarte_object_entry_t *entries,
    size_t entries_len, const int64_t *timestamp);
 
astarte_result_t astarte_device_set_property(astarte_device_handle_t device,
    const char *interface_name, const char *path, astarte_data_t data);
 
astarte_result_t astarte_device_unset_property(
    astarte_device_handle_t device, const char *interface_name, const char *path);
 
#ifdef CONFIG_ASTARTE_DEVICE_SDK_PERMANENT_STORAGE
astarte_result_t astarte_device_get_property(astarte_device_handle_t device,
    const char *interface_name, const char *path, astarte_device_property_loader_cbk_t loader_cbk,
    void *user_data);
#endif
 
astarte_result_t astarte_device_get_event(
    astarte_device_handle_t device, astarte_device_event_t *event, k_timeout_t timeout);
 
void astarte_device_event_cleanup(astarte_device_event_t *event);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ASTARTE_DEVICE_SDK_DEVICE_H */