edgehog_battery_status.h

Go to the documentation of this file.

/*
 * This file is part of Edgehog.
 *
 * Copyright 2021,2022 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_BATTERY_STATUS_H
#define EDGEHOG_BATTERY_STATUS_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "edgehog_device.h"
 
// clang-format off
 
typedef enum
{
    BATTERY_INVALID = 0, 
    BATTERY_IDLE, 
    BATTERY_CHARGING, 
    BATTERY_DISCHARGING, 
    BATTERY_IDLE_OR_CHARGING, 
    BATTERY_FAILURE, 
    BATTERY_REMOVED, 
    BATTERY_UNKNOWN 
} edgehog_battery_state;
 
typedef struct {
    const char *battery_slot; 
    double level_percentage; 
    double level_absolute_error; 
    edgehog_battery_state battery_state; 
} edgehog_battery_status_t;
 
// clang-format on
 
void edgehog_battery_status_update(
    edgehog_device_handle_t edgehog_device, const edgehog_battery_status_t *battery_status);
 
void edgehog_battery_status_publish(edgehog_device_handle_t edgehog_device);
 
#ifdef __cplusplus
}
#endif
 
#endif // EDGEHOG_BATTERY_STATUS_H