sensors.h

Go to the documentation of this file.

//
// Copyright 2015 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#pragma once

#include <uhd/config.h>
#include <uhd/error.h>

#ifdef __cplusplus
#    include <uhd/types/sensors.hpp>
#    include <memory>
#    include <string>

struct uhd_sensor_value_t
{
    // No default constructor, so we need a pointer
    std::unique_ptr<uhd::sensor_value_t> sensor_value_cpp;
    std::string last_error;
};
extern "C" {
#else
struct uhd_sensor_value_t;
#endif


typedef struct uhd_sensor_value_t* uhd_sensor_value_handle;

typedef enum {
    UHD_SENSOR_VALUE_BOOLEAN = 98,
    UHD_SENSOR_VALUE_INTEGER = 105,
    UHD_SENSOR_VALUE_REALNUM = 114,
    UHD_SENSOR_VALUE_STRING  = 115
} uhd_sensor_value_data_type_t;


UHD_API uhd_error uhd_sensor_value_make(uhd_sensor_value_handle* h);


UHD_API uhd_error uhd_sensor_value_make_from_bool(uhd_sensor_value_handle* h,
    const char* name,
    bool value,
    const char* utrue,
    const char* ufalse);


UHD_API uhd_error uhd_sensor_value_make_from_int(uhd_sensor_value_handle* h,
    const char* name,
    int value,
    const char* unit,
    const char* formatter);


UHD_API uhd_error uhd_sensor_value_make_from_realnum(uhd_sensor_value_handle* h,
    const char* name,
    double value,
    const char* unit,
    const char* formatter);


UHD_API uhd_error uhd_sensor_value_make_from_string(
    uhd_sensor_value_handle* h, const char* name, const char* value, const char* unit);


UHD_API uhd_error uhd_sensor_value_free(uhd_sensor_value_handle* h);

UHD_API uhd_error uhd_sensor_value_to_bool(uhd_sensor_value_handle h, bool* value_out);

UHD_API uhd_error uhd_sensor_value_to_int(uhd_sensor_value_handle h, int* value_out);

UHD_API uhd_error uhd_sensor_value_to_realnum(
    uhd_sensor_value_handle h, double* value_out);


UHD_API uhd_error uhd_sensor_value_name(
    uhd_sensor_value_handle h, char* name_out, size_t strbuffer_len);


UHD_API uhd_error uhd_sensor_value_value(
    uhd_sensor_value_handle h, char* value_out, size_t strbuffer_len);


UHD_API uhd_error uhd_sensor_value_unit(
    uhd_sensor_value_handle h, char* unit_out, size_t strbuffer_len);

UHD_API uhd_error uhd_sensor_value_data_type(
    uhd_sensor_value_handle h, uhd_sensor_value_data_type_t* data_type_out);


UHD_API uhd_error uhd_sensor_value_to_pp_string(
    uhd_sensor_value_handle h, char* pp_string_out, size_t strbuffer_len);


UHD_API uhd_error uhd_sensor_value_last_error(
    uhd_sensor_value_handle h, char* error_out, size_t strbuffer_len);

#ifdef __cplusplus
}
#endif