temperature.h

Go to the documentation of this file.

/*
 * Copyright © 2020 UBports Foundation
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Florian Leeber <florian@ubports.com>
 */

#ifndef UBUNTU_APPLICATION_SENSORS_TEMPERATURE_H_
#define UBUNTU_APPLICATION_SENSORS_TEMPERATURE_H_

#include <ubuntu/status.h>
#include <ubuntu/visibility.h>

#include <ubuntu/application/sensors/event/temperature.h>

#ifdef __cplusplus
extern "C" {
#endif

    typedef void UASensorsTemperature;

    typedef void (*on_temperature_event_cb)(UASTemperatureEvent* event,
                                      void* context);

    UBUNTU_DLL_PUBLIC UASensorsTemperature*
    ua_sensors_temperature_new();

    UBUNTU_DLL_PUBLIC UStatus
    ua_sensors_temperature_enable(
        UASensorsTemperature* sensor);

    UBUNTU_DLL_PUBLIC UStatus
    ua_sensors_temperature_disable(
        UASensorsTemperature* sensor);

    UBUNTU_DLL_PUBLIC uint32_t
    ua_sensors_temperature_get_min_delay(
        UASensorsTemperature* sensor);

    UBUNTU_DLL_PUBLIC UStatus
    ua_sensors_temperature_get_min_value(
        UASensorsTemperature* sensor,
        float* value);

    UBUNTU_DLL_PUBLIC UStatus
    ua_sensors_temperature_get_max_value(
        UASensorsTemperature* sensor,
        float* value);

    UBUNTU_DLL_PUBLIC UStatus
    ua_sensors_temperature_get_resolution(
        UASensorsTemperature* sensor,
        float* value);

    UBUNTU_DLL_PUBLIC void
    ua_sensors_temperature_set_reading_cb(
        UASensorsTemperature* sensor,
        on_temperature_event_cb cb,
        void *ctx);

    UBUNTU_DLL_PUBLIC UStatus
    ua_sensors_temperature_set_event_rate(
        UASensorsTemperature* sensor,
        uint32_t rate);

#ifdef __cplusplus
}
#endif

#endif /* UBUNTU_APPLICATION_SENSORS_TEMPERATURE_H_ */