cf104bb8de
The libdivecomputer sample flag field for events is fairly useless,
traditionally just having a "begin/end" bit.
This extends the flags field with a severity marker ("state", "info",
"warning", "alarm") so that subsurface can report the event with the
proper kind of notice (ie big red error marker for an alarm, but not
show divecomputer state changes by default, for example).
For Shearwater events we can also add the type of event ("interest",
"navpoint", "danger", "animal", "injury").
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
297 lines
8.3 KiB
C
297 lines
8.3 KiB
C
/*
|
|
* libdivecomputer
|
|
*
|
|
* Copyright (C) 2008 Jef Driesen
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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 library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
* MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef DC_PARSER_H
|
|
#define DC_PARSER_H
|
|
|
|
#include "common.h"
|
|
#include "context.h"
|
|
#include "descriptor.h"
|
|
#include "device.h"
|
|
#include "datetime.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
typedef enum dc_sample_type_t {
|
|
DC_SAMPLE_TIME,
|
|
DC_SAMPLE_DEPTH,
|
|
DC_SAMPLE_PRESSURE,
|
|
DC_SAMPLE_TEMPERATURE,
|
|
DC_SAMPLE_EVENT,
|
|
DC_SAMPLE_RBT,
|
|
DC_SAMPLE_HEARTBEAT,
|
|
DC_SAMPLE_BEARING,
|
|
DC_SAMPLE_VENDOR,
|
|
DC_SAMPLE_SETPOINT,
|
|
DC_SAMPLE_PPO2,
|
|
DC_SAMPLE_CNS,
|
|
DC_SAMPLE_DECO,
|
|
DC_SAMPLE_GASMIX,
|
|
DC_SAMPLE_TTS, // time to surface in seconds
|
|
} dc_sample_type_t;
|
|
|
|
// Make it easy to test support compile-time with "#ifdef DC_SAMPLE_TTS"
|
|
#define DC_SAMPLE_TTS DC_SAMPLE_TTS
|
|
|
|
typedef enum dc_field_type_t {
|
|
DC_FIELD_DIVETIME,
|
|
DC_FIELD_MAXDEPTH,
|
|
DC_FIELD_AVGDEPTH,
|
|
DC_FIELD_GASMIX_COUNT,
|
|
DC_FIELD_GASMIX,
|
|
DC_FIELD_SALINITY,
|
|
DC_FIELD_ATMOSPHERIC,
|
|
DC_FIELD_TEMPERATURE_SURFACE,
|
|
DC_FIELD_TEMPERATURE_MINIMUM,
|
|
DC_FIELD_TEMPERATURE_MAXIMUM,
|
|
DC_FIELD_TANK_COUNT,
|
|
DC_FIELD_TANK,
|
|
DC_FIELD_DIVEMODE,
|
|
DC_FIELD_STRING,
|
|
} dc_field_type_t;
|
|
|
|
// Make it easy to test support compile-time with "#ifdef DC_FIELD_STRING"
|
|
#define DC_FIELD_STRING DC_FIELD_STRING
|
|
|
|
typedef enum parser_sample_event_t {
|
|
SAMPLE_EVENT_NONE,
|
|
SAMPLE_EVENT_DECOSTOP,
|
|
SAMPLE_EVENT_RBT,
|
|
SAMPLE_EVENT_ASCENT,
|
|
SAMPLE_EVENT_CEILING,
|
|
SAMPLE_EVENT_WORKLOAD,
|
|
SAMPLE_EVENT_TRANSMITTER,
|
|
SAMPLE_EVENT_VIOLATION,
|
|
SAMPLE_EVENT_BOOKMARK,
|
|
SAMPLE_EVENT_SURFACE,
|
|
SAMPLE_EVENT_SAFETYSTOP,
|
|
SAMPLE_EVENT_GASCHANGE, /* Deprecated: replaced by DC_SAMPLE_GASMIX. */
|
|
SAMPLE_EVENT_SAFETYSTOP_VOLUNTARY,
|
|
SAMPLE_EVENT_SAFETYSTOP_MANDATORY,
|
|
SAMPLE_EVENT_DEEPSTOP,
|
|
SAMPLE_EVENT_CEILING_SAFETYSTOP,
|
|
SAMPLE_EVENT_FLOOR,
|
|
SAMPLE_EVENT_DIVETIME,
|
|
SAMPLE_EVENT_MAXDEPTH,
|
|
SAMPLE_EVENT_OLF,
|
|
SAMPLE_EVENT_PO2,
|
|
SAMPLE_EVENT_AIRTIME,
|
|
SAMPLE_EVENT_RGBM,
|
|
SAMPLE_EVENT_HEADING,
|
|
SAMPLE_EVENT_TISSUELEVEL,
|
|
SAMPLE_EVENT_GASCHANGE2, /* Deprecated: replaced by DC_SAMPLE_GASMIX. */
|
|
SAMPLE_EVENT_STRING,
|
|
} parser_sample_event_t;
|
|
|
|
/* To let the compile know we have this */
|
|
#define SAMPLE_EVENT_STRING SAMPLE_EVENT_STRING
|
|
|
|
/* For backwards compatibility */
|
|
#define SAMPLE_EVENT_UNKNOWN SAMPLE_EVENT_FLOOR
|
|
|
|
typedef enum parser_sample_flags_t {
|
|
SAMPLE_FLAGS_NONE = 0,
|
|
SAMPLE_FLAGS_BEGIN = (1 << 0),
|
|
SAMPLE_FLAGS_END = (1 << 1),
|
|
SAMPLE_FLAGS_SEVERITY_MASK = (7 << 2),
|
|
} parser_sample_flags_t;
|
|
|
|
#define SAMPLE_FLAGS_SEVERITY_SHIFT 2
|
|
|
|
#define SAMPLE_FLAGS_SEVERITY_MISSING (0 << SAMPLE_FLAGS_SEVERITY_SHIFT)
|
|
#define SAMPLE_FLAGS_SEVERITY_STATE (1 << SAMPLE_FLAGS_SEVERITY_SHIFT)
|
|
#define SAMPLE_FLAGS_SEVERITY_INFO (2 << SAMPLE_FLAGS_SEVERITY_SHIFT)
|
|
#define SAMPLE_FLAGS_SEVERITY_WARN (3 << SAMPLE_FLAGS_SEVERITY_SHIFT)
|
|
#define SAMPLE_FLAGS_SEVERITY_ALARM (4 << SAMPLE_FLAGS_SEVERITY_SHIFT)
|
|
|
|
/* these are used for the types of TAGs in Shearwater PNF info events */
|
|
#define SAMPLE_FLAGS_TYPE_SHIFT 5
|
|
#define SAMPLE_FLAGS_TYPE_MASK (7 << SAMPLE_FLAGS_TYPE_SHIFT)
|
|
#define SAMPLE_FLAGS_TYPE_NONE (0 << SAMPLE_FLAGS_TYPE_SHIFT)
|
|
#define SAMPLE_FLAGS_TYPE_INTEREST (1 << SAMPLE_FLAGS_TYPE_SHIFT)
|
|
#define SAMPLE_FLAGS_TYPE_NAVPOINT (2 << SAMPLE_FLAGS_TYPE_SHIFT)
|
|
#define SAMPLE_FLAGS_TYPE_DANGER (3 << SAMPLE_FLAGS_TYPE_SHIFT)
|
|
#define SAMPLE_FLAGS_TYPE_ANIMAL (4 << SAMPLE_FLAGS_TYPE_SHIFT)
|
|
#define SAMPLE_FLAGS_TYPE_ISSUE (5 << SAMPLE_FLAGS_TYPE_SHIFT)
|
|
#define SAMPLE_FLAGS_TYPE_INJURY (6 << SAMPLE_FLAGS_TYPE_SHIFT)
|
|
|
|
typedef enum parser_sample_vendor_t {
|
|
SAMPLE_VENDOR_NONE,
|
|
SAMPLE_VENDOR_UWATEC_ALADIN,
|
|
SAMPLE_VENDOR_UWATEC_SMART,
|
|
SAMPLE_VENDOR_OCEANIC_VTPRO,
|
|
SAMPLE_VENDOR_OCEANIC_VEO250,
|
|
SAMPLE_VENDOR_OCEANIC_ATOM2
|
|
} parser_sample_vendor_t;
|
|
|
|
typedef enum dc_water_t {
|
|
DC_WATER_FRESH,
|
|
DC_WATER_SALT
|
|
} dc_water_t;
|
|
|
|
typedef enum dc_divemode_t {
|
|
DC_DIVEMODE_FREEDIVE,
|
|
DC_DIVEMODE_GAUGE,
|
|
DC_DIVEMODE_OC, /* Open circuit */
|
|
DC_DIVEMODE_CCR, /* Closed circuit rebreather */
|
|
DC_DIVEMODE_SCR /* Semi-closed circuit rebreather */
|
|
} dc_divemode_t;
|
|
|
|
/* For backwards compatibility */
|
|
#define DC_DIVEMODE_CC DC_DIVEMODE_CCR
|
|
|
|
typedef enum dc_deco_type_t {
|
|
DC_DECO_NDL,
|
|
DC_DECO_SAFETYSTOP,
|
|
DC_DECO_DECOSTOP,
|
|
DC_DECO_DEEPSTOP
|
|
} dc_deco_type_t;
|
|
|
|
typedef struct dc_salinity_t {
|
|
dc_water_t type;
|
|
double density;
|
|
} dc_salinity_t;
|
|
|
|
typedef struct dc_gasmix_t {
|
|
double helium;
|
|
double oxygen;
|
|
double nitrogen;
|
|
} dc_gasmix_t;
|
|
|
|
#define DC_GASMIX_UNKNOWN 0xFFFFFFFF
|
|
|
|
typedef unsigned int dc_tankinfo_t;
|
|
#define DC_TANKINFO_METRIC 1
|
|
#define DC_TANKINFO_IMPERIAL 2
|
|
#define DC_TANKINFO_CC_DILUENT 4
|
|
#define DC_TANKINFO_CC_O2 8
|
|
|
|
// For backwards compatibility
|
|
#define DC_TANKVOLUME_NONE 0
|
|
#define DC_TANKVOLUME_METRIC DC_TANKINFO_METRIC
|
|
#define DC_TANKVOLUME_IMPERIAL DC_TANKINFO_IMPERIAL
|
|
|
|
/*
|
|
* Tank volume
|
|
*
|
|
* There are two different ways to specify the volume of a tank. In the
|
|
* metric system, the tank volume is specified as the water capacity,
|
|
* while in the imperial system the tank volume is specified as the air
|
|
* capacity at the surface (1 ATM) when the tank is filled at its
|
|
* working pressure. Libdivecomputer will always convert the tank volume
|
|
* to the metric representation, and indicate the original tank type:
|
|
*
|
|
* DC_TANKVOLUME_NONE: Tank volume is not available. Both the volume and
|
|
* workpressure will be zero.
|
|
*
|
|
* DC_TANKVOLUME_METRIC: A metric tank. The workpressure is optional and
|
|
* may be zero.
|
|
*
|
|
* DC_TANKVOLUME_IMPERIAL: An imperial tank. Both the volume and
|
|
* workpressure are mandatory and always non-zero. The volume has been
|
|
* converted from air capacity to water capacity. To calculate the
|
|
* original air capacity again, multiply with the workpressure and
|
|
* divide by 1 ATM (Vair = Vwater * Pwork / Patm).
|
|
*/
|
|
|
|
typedef struct dc_tank_t {
|
|
unsigned int gasmix; /* Gas mix index, or DC_GASMIX_UNKNOWN */
|
|
dc_tankinfo_t type; /* Tank type - metric/imperial and oc/cc */
|
|
double volume; /* Volume (liter) */
|
|
double workpressure; /* Work pressure (bar) */
|
|
double beginpressure; /* Begin pressure (bar) */
|
|
double endpressure; /* End pressure (bar) */
|
|
} dc_tank_t;
|
|
|
|
typedef struct dc_field_string_t {
|
|
const char *desc;
|
|
const char *value;
|
|
} dc_field_string_t;
|
|
|
|
typedef union dc_sample_value_t {
|
|
unsigned int time;
|
|
double depth;
|
|
struct {
|
|
unsigned int tank;
|
|
double value;
|
|
} pressure;
|
|
double temperature;
|
|
struct {
|
|
unsigned int type;
|
|
unsigned int time;
|
|
unsigned int flags;
|
|
unsigned int value;
|
|
const char *name;
|
|
} event;
|
|
unsigned int rbt;
|
|
unsigned int heartbeat;
|
|
unsigned int bearing;
|
|
struct {
|
|
unsigned int type;
|
|
unsigned int size;
|
|
const void *data;
|
|
} vendor;
|
|
double setpoint;
|
|
double ppo2;
|
|
double cns;
|
|
struct {
|
|
unsigned int type;
|
|
unsigned int time;
|
|
double depth;
|
|
} deco;
|
|
unsigned int gasmix; /* Gas mix index */
|
|
} dc_sample_value_t;
|
|
|
|
typedef struct dc_parser_t dc_parser_t;
|
|
|
|
typedef void (*dc_sample_callback_t) (dc_sample_type_t type, dc_sample_value_t value, void *userdata);
|
|
|
|
dc_status_t
|
|
dc_parser_new (dc_parser_t **parser, dc_device_t *device);
|
|
|
|
dc_status_t
|
|
dc_parser_new2 (dc_parser_t **parser, dc_context_t *context, dc_descriptor_t *descriptor, unsigned int devtime, dc_ticks_t systime);
|
|
|
|
dc_family_t
|
|
dc_parser_get_type (dc_parser_t *parser);
|
|
|
|
dc_status_t
|
|
dc_parser_set_data (dc_parser_t *parser, const unsigned char *data, unsigned int size);
|
|
|
|
dc_status_t
|
|
dc_parser_get_datetime (dc_parser_t *parser, dc_datetime_t *datetime);
|
|
|
|
dc_status_t
|
|
dc_parser_get_field (dc_parser_t *parser, dc_field_type_t type, unsigned int flags, void *value);
|
|
|
|
dc_status_t
|
|
dc_parser_samples_foreach (dc_parser_t *parser, dc_sample_callback_t callback, void *userdata);
|
|
|
|
dc_status_t
|
|
dc_parser_destroy (dc_parser_t *parser);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif /* DC_PARSER_H */
|