/usr/include/fap.h is in libfap5-dev 1.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 | /* $Id: fap.h 187 2011-02-16 21:58:11Z oh2gve $
*
* Copyright 2005, 2006, 2007, 2008, 2009, 2010 Tapio Sokura
* Copyright 2007, 2008, 2009, 2010 Heikki Hannikainen
*
* Perl-to-C modifications
* Copyright 2009, 2010, 2011 Tapio Aaltonen
*
* This file is part of libfap.
*
* Libfap is free software; you can redistribute it and/or modify it under the
* terms of either:
*
* a) the GNU General Public License as published by the Free Software
* Foundation; either version 1, or (at your option) any later
* version, or
*
* b) the "Artistic License".
*
* Both licenses can be found in the licenses directory of this source code
* package.
*
* APRS is a registered trademark of APRS Software and Bob Bruninga, WB4APR.
*/
/**
* \file fap.h
* \brief Declaration of libfap's public interface.
*
* This file declares data types used to represent a single APRS packet.
* Functions include the parser, some utility functions and library
* initialization stuff.
*
* Note: it is very important to call fap_init() before calling any other
* function. Also note that fap_cleanup() should be called when shutting
* down, or memory leaks will occur.
*
* \author Tapio Aaltonen
*/
#ifndef FAP_H
#define FAP_H
#include <time.h>
#ifdef __cplusplus
extern "C" {
#endif
/// Packet error code type.
typedef enum
{
fapPACKET_NO,
fapPACKET_SHORT,
fapPACKET_NOBODY,
fapSRCCALL_NOAX25,
fapSRCCALL_BADCHARS,
fapDSTPATH_TOOMANY,
fapDSTCALL_NONE,
fapDSTCALL_NOAX25,
fapDIGICALL_NOAX25,
fapDIGICALL_BADCHARS,
fapTIMESTAMP_INV_LOC,
fapTIMESTAMP_INV_OBJ,
fapTIMESTAMP_INV_STA,
fapTIMESTAMP_INV_GPGGA,
fapTIMESTAMP_INV_GPGLL,
fapPACKET_INVALID,
fapNMEA_INV_CVAL,
fapNMEA_LARGE_EW,
fapNMEA_LARGE_NS,
fapNMEA_INV_SIGN,
fapNMEA_INV_CKSUM,
fapGPRMC_FEWFIELDS,
fapGPRMC_NOFIX,
fapGPRMC_INV_TIME,
fapGPRMC_INV_DATE,
fapGPRMC_DATE_OUT,
fapGPGGA_FEWFIELDS,
fapGPGGA_NOFIX,
fapGPGLL_FEWFIELDS,
fapGPGLL_NOFIX,
fapNMEA_UNSUPP,
fapOBJ_SHORT,
fapOBJ_INV,
fapOBJ_DEC_ERR,
fapITEM_SHORT,
fapITEM_INV,
fapITEM_DEC_ERR,
fapLOC_SHORT,
fapLOC_INV,
fapLOC_LARGE,
fapLOC_AMB_INV,
fapMICE_SHORT,
fapMICE_INV,
fapMICE_INV_INFO,
fapMICE_AMB_LARGE,
fapMICE_AMB_INV,
fapMICE_AMB_ODD,
fapCOMP_INV,
fapCOMP_SHORT,
fapMSG_INV,
fapWX_UNSUPP,
fapUSER_UNSUPP,
fapDX_INV_SRC,
fapDX_INF_FREQ,
fapDX_NO_DX,
fapTLM_INV,
fapTLM_LARGE,
fapTLM_UNSUPP,
fapEXP_UNSUPP,
fapSYM_INV_TABLE,
fapNOT_IMPLEMENTED,
fapNMEA_NOFIELDS,
fapNO_APRS
} fap_error_code_t;
/// Packet type type.
typedef enum
{
fapLOCATION,
fapOBJECT,
fapITEM,
fapMICE,
fapNMEA,
fapWX,
fapMESSAGE,
fapCAPABILITIES,
fapSTATUS,
fapTELEMETRY,
fapTELEMETRY_MESSAGE,
fapDX_SPOT,
fapEXPERIMENTAL
} fap_packet_type_t;
/// Position format type.
typedef enum
{
fapPOS_COMPRESSED,
fapPOS_UNCOMPRESSED,
fapPOS_MICE,
fapPOS_NMEA
} fap_pos_format_t;
/// Weather report type.
typedef struct
{
/// Wind gust in m/s.
double* wind_gust;
/// Wind direction in degrees.
unsigned int* wind_dir;
/// Wind speed in m/s.
double* wind_speed;
/// Temperature in degrees Celcius.
double* temp;
/// Indoor temperature in degrees Celcius.
double* temp_in;
/// Rain from last 1 hour, in millimeters.
double* rain_1h;
/// Rain from last day, in millimeters.
double* rain_24h;
/// Rain since midnight, in millimeters.
double* rain_midnight;
/// Relative humidity percentage.
unsigned int* humidity;
/// Relative inside humidity percentage.
unsigned int* humidity_in;
/// Air pressure in millibars.
double* pressure;
/// Luminosity in watts per square meter.
unsigned int* luminosity;
/// Show depth increasement from last day, in millimeters.
double* snow_24h;
/// Software type indicator.
char* soft;
} fap_wx_report_t;
/// Telemetry report type.
typedef struct
{
/// Id of report.
unsigned int seq;
/// First value.
double val1;
/// Second value.
double val2;
/// Third value.
double val3;
/// Fourth value.
double val4;
/// Fifth value.
double val5;
/// Telemetry bits as ASCII 0s and 1s. Unknowns are marked with question marks.
char bits[8];
} fap_telemetry_t;
/// APRS packet type.
typedef struct
{
/// Error code.
fap_error_code_t* error_code;
/// Packet type.
fap_packet_type_t* type;
/// Exact copy of the original packet, if such thing was given.
char* orig_packet;
/// Length of orig_packet.
unsigned int orig_packet_len;
/// Header part of the packet.
char* header;
/// Body of the packet. No null termination.
char* body;
/// Lenght of body.
unsigned int body_len;
/// AX.25-level source callsign.
char* src_callsign;
/// AX.25-level destination callsign.
char* dst_callsign;
/// Array of path elements.
char** path;
/// Number of path elements.
unsigned int path_len;
/// Latitude, west is negative.
double* latitude;
/// Longitude, south is negative.
double* longitude;
/// Position format.
fap_pos_format_t* format;
/// Position resolution in meters.
double* pos_resolution;
/// Position ambiguity, number of digits.
unsigned int* pos_ambiguity;
/// Datum character from !DAO! extension. 0x00 = undef.
char dao_datum_byte;
/// Altitude in meters.
double* altitude;
/// Course in degrees, zero is unknown and 360 is north.
unsigned int* course;
/// Land speed in km/h.
double* speed;
/// Symbol table designator. 0x00 = undef.
char symbol_table;
/// Slot of symbol table 0x00 = undef.
char symbol_code;
/// Zero for no messaging capability, 1 for yes.
short* messaging;
/// Destination of message.
char* destination;
/// The actual message text.
char* message;
/// Id of the message which is acked with this packet.
char* message_ack;
/// Id of the message which was rejected with this packet.
char* message_nack;
/// Id of this message.
char* message_id;
/// Station, object or item comment. No null termination.
/**
* Here's a difference between Perl module and C library. Perl
* module removes whitespace characters from beginning and end of
* the comment. C library returns comment exactly as seen in
* original packet.
*/
char* comment;
/// Length of comment.
unsigned int comment_len;
/// Name of object or item in packet.
char* object_or_item_name;
/// Object or item status. 1 = alive, 0 = killed.
short* alive;
/// Zero if GPS has no fix, one if it has.
short* gps_fix_status;
/// Radio range of the station in km.
unsigned int* radio_range;
/// TX power, antenna height, antenna gain and possibly beacon rate.
char* phg;
/// Timestamp of the packet in unixtime.
time_t* timestamp;
/// NMEA checksum validity indicator, 1 = valid.
short* nmea_checksum_ok;
/// Weather report.
fap_wx_report_t* wx_report;
/// Telemetry report.
fap_telemetry_t* telemetry;
/// Message bits in case of mic-e packet.
char* messagebits;
/// Status message. No 0-termination.
char* status;
/// Amount of bytes in status message.
unsigned int status_len;
/// Capabilities list. Indexes 0, 2, 4, ... store keys and 1, 3, 5, ... the values (or NULL if the key has no value).
char** capabilities;
/// Amount of capabilities in list.
unsigned int capabilities_len;
} fap_packet_t;
/// The parser.
/**
* Resulting packet object will be filled with as much data as possible
* based on the packet given as parameter. Unfilled fields are set to NULL.
*
* When parsing in AX.25 mode, source callsign and path elements are checked
* to be strictly compatible with AX.25 specs so that they can be sent into
* AX.25 network. Destination callsign is always checked this way.
*
* The parser should handle null bytes, newline chars and other badness
* sometimes seen in packets without crashing as long as input_len is given
* correctly.
*
* \param input TNC-2 mode APRS packet string.
* \param input_len Amount of bytes in input.
* \param is_ax25 If 1, packet is parsed as AX.25 network packet. If 0, packet is parsed as APRS-IS packet.
* \return A packet is always returned, no matter how the parsing went. Use
* error_code to check how it did. If library is not initialized, returns
* NULL.
*/
fap_packet_t* fap_parseaprs(char const* input, unsigned int const input_len, short const is_ax25);
/// Return human-readable error message for given error code.
/**
* \param error Error code from fap_packet_t.
* \param buffer Pre-allocated space for the message. Must be at least 60 bytes long.
*/
void fap_explain_error(fap_error_code_t const error, char* buffer);
/// Convert mic-e message bits (three numbers 0-2) to a textual message.
/**
* \param bits Bits as returned by fap_parseaprs().
* \param buffer Pre-allocated space for the message. Must be at least 20 bytes long.
*/
void fap_mice_mbits_to_message(char const* bits, char* buffer);
/// Calculate distance between given locations.
/**
* Returns the distance in kilometers between two locations given in decimal
* degrees. Arguments are given in order as lon0, lat0, lon1, lat1, east and
* north positive. The calculation uses the great circle distance, it is not
* too exact, but good enough for us.
*/
double fap_distance(double lon0, double lat0, double lon1, double lat1);
/// Calculate direction from first to second location.
/**
* Returns the initial great circle direction in degrees from lat0/lon0 to
* lat1/lon1. Locations are input in decimal degrees, north and east
* positive.
*/
double fap_direction(double lon0, double lat0, double lon1, double lat1);
/// Count amount of digihops the packet has gone through.
/**
* The number returned is just an educated guess, not absolute truth.
*
* \return Number of digipeated hops or -1 in case of error.
*/
int fap_count_digihops(fap_packet_t const* packet);
/// Check if the callsign is a valid AX.25 callsign.
/**
* \param input Callsign to be checked. If SSID is 0, the "-0" suffix can be omitted.
* \param add_ssid0 If 1, a missing SSID 0 (in practice "-0") is appended to the
* returned callsign. If 0, valid callsign is returned as is.
* \return Given input if it was valid. NULL if the input was not a valid
* AX.25 address or library is not initialized.
*
* Please note that it's very common to use invalid callsigns on the
* APRS-IS.
*/
char* fap_check_ax25_call(char const* input, short const add_ssid0);
/// Convert a KISS-frame into a TNC-2 compatible UI-frame.
/**
* Non-UI and non-pid-F0 frames are dropped. The KISS-frame to be decoded
* may or may not have a FEND (0xC0) character at beginning. If there's a
* FEND in the frame before or at the end, the frame is cutted just before
* the FEND. Byte unstuffing must not be done before calling this function.
*
* \param kissframe KISS-frame.
* \param kissframe_len Amount of bytes in kissframe. Must be less than 512.
* \param tnc2frame Result of conversion is stored here. In case of error an error message may be found here.
* \param tnc2frame_len Amount of bytes available in tnc2frame is read from
* here. Amount of bytes written to tnc2frame is written to here upon
* return.
* \param tnc_id TNC ID from the kissframe, usually zero.
* \return 1 in case of success, 0 when error occured.
*/
int fap_kiss_to_tnc2(char const* kissframe, unsigned int kissframe_len,
char* tnc2frame, unsigned int* tnc2frame_len, unsigned int* tnc_id);
/// Convert a TNC-2 compatible UI-frame into a KISS data frame.
/**
* The frame will be complete, i.e. it has byte stuffing done and FEND
* (0xC0) characters on both ends.
*
* \param tnc2frame TNC-2 frame.
* \param tnc2frame_len Amount of bytes in tnc2frame.
* \param tnc_id TNC ID to use in KISS frame. When is doubt, use zero.
* \param kissframe Where to store the KISS-frame. Be sure to allocate enough space.
* \param kissframe_len Amount of bytes stored into kissframe during successfull conversion.
* \return 1 in case of success, 0 when error occured.
*/
int fap_tnc2_to_kiss(char const* tnc2frame, unsigned int tnc2frame_len, unsigned int const tnc_id,
char* kissframe, unsigned int* kissframe_len);
/* Implementation-specific functions. */
/// Convert raw AX.25 frame into TNC-2 compatible UI-frame.
/**
* Params and return value work just like similar ones in fap_kiss_to_tnc2().
*/
int fap_ax25_to_tnc2(char const* ax25frame, unsigned int ax25frame_len,
char* tnc2frame, unsigned int* tnc2frame_len);
/// Convert TNC-2 compatible UI-frame into raw AX.25-frame.
/**
* Params and return value work just like similar ones in fap_tnc2_to_kiss().
*/
int fap_tnc2_to_ax25(char const* tnc2frame, unsigned int tnc2frame_len,
char* ax25frame, unsigned int* ax25frame_len);
/// Custom free() for fap_packet_t*.
/**
* Use this in place of normal free() when disposing a packet. Will free()
* all non-NULL fields for you.
*/
void fap_free(fap_packet_t* packet);
/// Library initialization.
/**
* This must be called once and before anything else when starting to use
* libfap in your program.
*/
void fap_init();
/// Library cleanup.
/**
* This must be called once when closing your app. Make sure that no fap
* calls are issued after this.
*/
void fap_cleanup();
#ifdef __cplusplus
}
#endif
#endif // FAP_H
|