RBRInstrumentOther.h

Go to the documentation of this file.

 
#ifndef LIBRBR_RBRINSTRUMENTOTHER_H
#define LIBRBR_RBRINSTRUMENTOTHER_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RBRINSTRUMENT_HWREV_CPU_MAX 5
 
#define RBRINSTRUMENT_PART_NUMBER_MAX 255
 
int RBRInstrumentVersion_compare(const char *a, const char *b);
 
RBRInstrumentError RBRInstrument_getId(RBRInstrument *instrument,
                                       RBRInstrumentId *id);
 
typedef struct RBRInstrumentHardwareRevision
{
    char pcb;
    char cpu[RBRINSTRUMENT_HWREV_CPU_MAX + 1];
    char bsl;
} RBRInstrumentHardwareRevision;
 
RBRInstrumentError RBRInstrument_getHardwareRevision(
    RBRInstrument *instrument,
    RBRInstrumentHardwareRevision *hwrev);
 
typedef enum RBRInstrumentPowerSource
{
    RBRINSTRUMENT_POWER_SOURCE_USB,
    RBRINSTRUMENT_POWER_SOURCE_INTERNAL,
    RBRINSTRUMENT_POWER_SOURCE_EXTERNAL,
    RBRINSTRUMENT_POWER_SOURCE_COUNT,
    RBRINSTRUMENT_UNKNOWN_POWER_SOURCE
} RBRInstrumentPowerSource;
 
const char *RBRInstrumentPowerSource_name(RBRInstrumentPowerSource source);
 
typedef struct RBRInstrumentPower
{
    RBRInstrumentPowerSource source;
    float internal;
    float external;
    float regulator;
} RBRInstrumentPower;
 
RBRInstrumentError RBRInstrument_getPower(RBRInstrument *instrument,
                                          RBRInstrumentPower *power);
 
typedef enum RBRInstrumentInternalBatteryType
{
    RBRINSTRUMENT_INTERNAL_BATTERY_NONE,
    RBRINSTRUMENT_INTERNAL_BATTERY_LISOCL2,
    RBRINSTRUMENT_INTERNAL_BATTERY_LIFES2,
    RBRINSTRUMENT_INTERNAL_BATTERY_ZNMNO2,
    RBRINSTRUMENT_INTERNAL_BATTERY_LINIMNCO,
    RBRINSTRUMENT_INTERNAL_BATTERY_NIMH,
    RBRINSTRUMENT_INTERNAL_BATTERY_COUNT,
    RBRINSTRUMENT_UNKNOWN_INTERNAL_BATTERY
} RBRInstrumentInternalBatteryType;
 
const char *RBRInstrumentInternalBatteryType_name(
    RBRInstrumentInternalBatteryType type);
 
const char *RBRInstrumentInternalBatteryType_displayName(
    RBRInstrumentInternalBatteryType type);
 
typedef struct RBRInstrumentPowerInternal
{
    RBRInstrumentInternalBatteryType batteryType;
    const float capacity;
    float used;
} RBRInstrumentPowerInternal;
 
RBRInstrumentError RBRInstrument_getPowerInternal(
    RBRInstrument *instrument,
    RBRInstrumentPowerInternal *power);
 
RBRInstrumentError RBRInstrument_setInternalBatteryType(
    RBRInstrument *instrument,
    RBRInstrumentInternalBatteryType type);
 
RBRInstrumentError RBRInstrument_resetPowerInternalUsed(
    RBRInstrument *instrument);
 
typedef enum RBRInstrumentExternalBatteryType
{
    RBRINSTRUMENT_EXTERNAL_BATTERY_OTHER,
    RBRINSTRUMENT_EXTERNAL_BATTERY_FERMATA_LISOCL2,
    RBRINSTRUMENT_EXTERNAL_BATTERY_FERMATA_ZNMNO2,
    RBRINSTRUMENT_EXTERNAL_BATTERY_FERMETTE_LIMNO2,
    RBRINSTRUMENT_EXTERNAL_BATTERY_FERMETTE3_LISOCL2,
    RBRINSTRUMENT_EXTERNAL_BATTERY_FERMETTE3_LIFES2,
    RBRINSTRUMENT_EXTERNAL_BATTERY_FERMETTE3_ZNMNO2,
    RBRINSTRUMENT_EXTERNAL_BATTERY_FERMETTE3_LINIMNCO,
    RBRINSTRUMENT_EXTERNAL_BATTERY_FERMETTE3_NIMH,
    RBRINSTRUMENT_EXTERNAL_BATTERY_COUNT,
    RBRINSTRUMENT_UNKNOWN_EXTERNAL_BATTERY
} RBRInstrumentExternalBatteryType;
 
const char *RBRInstrumentExternalBatteryType_name(
    RBRInstrumentExternalBatteryType type);
 
const char *RBRInstrumentExternalBatteryType_displayName(
    RBRInstrumentExternalBatteryType type);
 
typedef struct RBRInstrumentPowerExternal
{
    RBRInstrumentExternalBatteryType batteryType;
    const float capacity;
    float used;
} RBRInstrumentPowerExternal;
 
RBRInstrumentError RBRInstrument_getPowerExternal(
    RBRInstrument *instrument,
    RBRInstrumentPowerExternal *power);
 
RBRInstrumentError RBRInstrument_setPowerExternalBatteryType(
    RBRInstrument *instrument,
    RBRInstrumentExternalBatteryType type);
 
RBRInstrumentError RBRInstrument_resetPowerExternalUsed(
    RBRInstrument *instrument);
 
typedef struct RBRInstrumentInfo
{
    char partNumber[RBRINSTRUMENT_PART_NUMBER_MAX + 1];
    bool fwLock;
} RBRInstrumentInfo;
 
RBRInstrumentError RBRInstrument_getInfo(
    RBRInstrument *instrument,
    RBRInstrumentInfo *info);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIBRBR_RBRINSTRUMENTOTHER_H */