sol-power-supply.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * 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.
 */

#pragma once

#include <stdlib.h>

#include <sol-vector.h>
#include <sol-buffer.h>

#ifdef __cplusplus
extern "C" {
#endif

enum sol_power_supply_type {
    SOL_POWER_SUPPLY_TYPE_UNKNOWN,
    SOL_POWER_SUPPLY_TYPE_BATTERY,
    SOL_POWER_SUPPLY_TYPE_UPS,
    SOL_POWER_SUPPLY_TYPE_MAINS,
    SOL_POWER_SUPPLY_TYPE_USB,
    SOL_POWER_SUPPLY_TYPE_USB_DCP,
    SOL_POWER_SUPPLY_TYPE_USB_CDP,
    SOL_POWER_SUPPLY_TYPE_USB_ACA
};

enum sol_power_supply_status {
    SOL_POWER_SUPPLY_STATUS_UNKNOWN,
    SOL_POWER_SUPPLY_STATUS_CHARGING,
    SOL_POWER_SUPPLY_STATUS_DISCHARGING,
    SOL_POWER_SUPPLY_STATUS_NOT_CHARGING,
    SOL_POWER_SUPPLY_STATUS_FULL
};

enum sol_power_supply_capacity_level {
    SOL_POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN,
    SOL_POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
    SOL_POWER_SUPPLY_CAPACITY_LEVEL_LOW,
    SOL_POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
    SOL_POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
    SOL_POWER_SUPPLY_CAPACITY_LEVEL_FULL
};

int sol_power_supply_get_list(struct sol_ptr_vector *list);

int sol_power_supply_free_list(struct sol_ptr_vector *list);

int sol_power_supply_get_list_by_type(struct sol_ptr_vector *list, enum sol_power_supply_type type);

int sol_power_supply_get_type(const char *name, enum sol_power_supply_type *type);

int sol_power_supply_exists(const char *name, bool *exist);

int sol_power_supply_is_online(const char *name, bool *online);

int sol_power_supply_is_present(const char *name, bool *present);

int sol_power_supply_get_status(const char *name, enum sol_power_supply_status *status);

int sol_power_supply_get_capacity(const char *name, int *capacity);

int sol_power_supply_get_capacity_level(const char *name, enum sol_power_supply_capacity_level *capacity_level);

int sol_power_supply_get_model_name(const char *name, struct sol_buffer *model_name_buf);

int sol_power_supply_get_manufacturer(const char *name, struct sol_buffer *manufacturer_buf);

int sol_power_supply_get_serial_number(const char *name, struct sol_buffer *serial_number_buf);

int sol_power_supply_get_voltage(const char *name, int *voltage);

int sol_power_supply_get_min_voltage(const char *name, int *voltage);

int sol_power_supply_get_max_voltage(const char *name, int *voltage);

int sol_power_supply_get_min_voltage_design(const char *name, int *voltage);

int sol_power_supply_get_max_voltage_design(const char *name, int *voltage);

#ifdef __cplusplus
}
#endif