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/device_id.h"
#include "astarte_device_sdk/individual.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 struct
{
    astarte_device_handle_t device; 
    void *user_data; 
} astarte_device_connection_event_t;
 
typedef void (*astarte_device_connection_cbk_t)(astarte_device_connection_event_t event);
 
typedef struct
{
    astarte_device_handle_t device; 
    void *user_data; 
} astarte_device_disconnection_event_t;
 
typedef void (*astarte_device_disconnection_cbk_t)(astarte_device_disconnection_event_t event);
 
typedef struct
{
    astarte_device_handle_t device; 
    const char *interface_name; 
    const char *path; 
    void *user_data; 
} astarte_device_data_event_t;
 
typedef struct
{
    astarte_device_data_event_t data_event; 
    astarte_individual_t individual; 
} astarte_device_datastream_individual_event_t;
 
typedef void (*astarte_device_datastream_individual_cbk_t)(
    astarte_device_datastream_individual_event_t event);
 
typedef struct
{
    astarte_device_data_event_t data_event; 
    astarte_object_entry_t *entries; 
    size_t entries_len; 
} astarte_device_datastream_object_event_t;
 
typedef void (*astarte_device_datastream_object_cbk_t)(
    astarte_device_datastream_object_event_t event);
 
typedef struct
{
    astarte_device_data_event_t data_event; 
    astarte_individual_t individual; 
} astarte_device_property_set_event_t;
 
typedef void (*astarte_device_property_set_cbk_t)(astarte_device_property_set_event_t event);
 
typedef void (*astarte_device_property_unset_cbk_t)(astarte_device_data_event_t event);
 
#if defined(CONFIG_ASTARTE_DEVICE_SDK_PERMANENT_STORAGE)
typedef struct
{
    astarte_device_handle_t device; 
    const char *interface_name; 
    const char *path; 
    astarte_individual_t individual; 
    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];
    astarte_device_connection_cbk_t connection_cbk;
    astarte_device_disconnection_cbk_t disconnection_cbk;
    astarte_device_datastream_individual_cbk_t datastream_individual_cbk;
    astarte_device_datastream_object_cbk_t datastream_object_cbk;
    astarte_device_property_set_cbk_t property_set_cbk;
    astarte_device_property_unset_cbk_t property_unset_cbk;
    void *cbk_user_data;
    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_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_poll(astarte_device_handle_t device);
 
astarte_result_t astarte_device_stream_individual(astarte_device_handle_t device,
    const char *interface_name, const char *path, astarte_individual_t individual,
    const int64_t *timestamp);
 
astarte_result_t astarte_device_stream_aggregated(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_individual_t individual);
 
astarte_result_t astarte_device_unset_property(
    astarte_device_handle_t device, const char *interface_name, const char *path);
 
#if defined(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
 
#ifdef __cplusplus
}
#endif
 
#endif /* ASTARTE_DEVICE_SDK_DEVICE_H */