edgehog_device.h

Go to the documentation of this file.

/*
 * This file is part of Edgehog.
 *
 * Copyright 2021 SECO Mind Srl
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef EDGEHOG_DEVICE_H
#define EDGEHOG_DEVICE_H
 
typedef struct edgehog_device_t *edgehog_device_handle_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "edgehog.h"
#include <astarte_device.h>
#include <esp_err.h>
#include <nvs.h>
 
typedef enum
{
    EDGEHOG_TELEMETRY_INVALID = 0, 
    EDGEHOG_TELEMETRY_HW_INFO = 1, 
    EDGEHOG_TELEMETRY_WIFI_SCAN = 2, 
    EDGEHOG_TELEMETRY_SYSTEM_STATUS = 3, 
    EDGEHOG_TELEMETRY_STORAGE_USAGE = 4, 
    EDGEHOG_TELEMETRY_BATTERY_STATUS = 5, 
    EDGEHOG_TELEMETRY_GEOLOCATION_INFO = 6 
} telemetry_type_t;
 
typedef struct
{
    telemetry_type_t type;
    long period_seconds;
} edgehog_device_telemetry_config_t;
 
typedef struct
{
    astarte_device_handle_t astarte_device;
    const char *partition_label;
    edgehog_device_telemetry_config_t *telemetry_config;
    size_t telemetry_config_len;
} edgehog_device_config_t;
 
edgehog_device_handle_t edgehog_device_new(edgehog_device_config_t *config);
 
void edgehog_device_destroy(edgehog_device_handle_t edgehog_device);
 
esp_err_t edgehog_device_set_system_serial_number(
    edgehog_device_handle_t edgehog_device, const char *serial_num);
 
esp_err_t edgehog_device_set_system_part_number(
    edgehog_device_handle_t edgehog_device, const char *part_num);
 
void edgehog_device_astarte_event_handler(
    edgehog_device_handle_t edgehog_device, astarte_device_data_event_t *event);
 
edgehog_err_t edgehog_device_start(edgehog_device_handle_t edgehog_device);
 
#ifdef __cplusplus
}
#endif
 
#endif // EDGEHOG_DEVICE_H