README.md

   1 marnav
   2 ======
   3
   4 [![Build Status](https://travis-ci.org/mariokonrad/marnav.svg?branch=master)](https://travis-ci.org/mariokonrad/marnav)
   5
   6 Copyright (c) 2015 Mario Konrad (mario.konrad@gmx.net)
   7
   8 ---
   9
  10 Abstract
  11 --------
  12
  13 This is a C++ library for **MAR**itime **NAV**igation purposes.
  14
  15 It supports (partially):
  16 - NMEA-0183
  17 - AIS
  18 - SeaTalk (Raymarine device communication)
  19 - Reading data from serial ports (NMEA, SeaTalk)
  20 - Basic geodesic functions, suitable for martime navigation.
  21
  22 See chapter _Features_ for a complete and detailed list.
  23
  24 ---
  25
  26 Goals
  27 -----
  28
  29 There are already implementaions for reading and writing NMEA-0183 or AIS.
  30 The goal of this library is
  31 - to have an implementation in modern C++ (C++11 right now, C++14 as soon as compilers
  32   catch up, but not necessarily bleeding edge)
  33 - easy to use API (std lib like, integrating well)
  34 - unit tested (high test coverage)
  35 - trivial integration into projects (liberal license, as few dependencies as
  36   possible)
  37 - (more or less) well documented
  38 - (more or less) complete, as far as information is freely available
  39 - having fun
  40
  41 ---
  42
  43 Features
  44 --------
  45
  46 ### NMEA-0183
  47
  48 Supported sentences for NMEA-0183 (read and write):
  49 - AAM: Waypoint Arrival Alarm
  50 - ALM: GPS Almanac Data
  51 - APB: Autopilot Sentence "B"
  52 - BOD: Bearing - Waypoint to Waypoint
  53 - BWC: Bearing & Distance to Waypoint - Geat Circle
  54 - BWR: Bearing and Distance to Waypoint - Rhumb Line
  55 - BWW: Bearing - Waypoint to Waypoint
  56 - DBT: Depth Below Transducer
  57 - DPT: Depth of Water
  58 - DSC: Digital Selective Calling Information (**experimental**)
  59 - DSE: Extended DSC (**experimental**)
  60 - DTM: Datum Reference
  61 - FSI: Frequency Set Information
  62 - GBS: GPS Satellite Fault Detection
  63 - GGA: Global Positioning System Fix Data
  64 - GLC: Geographic Position, Loran-C
  65 - GLL: Geographic Position - Latitude/Longitude
  66 - GNS: Fix data
  67 - GRS: GPS Range Residuals
  68 - GSA: Geographic Position - Latitude/Longitude
  69 - GST: GPS Pseudorange Noise Statistics
  70 - GSV: Satellites in view
  71 - GTD: Geographic Location in Time Differences
  72 - HDG: Heading - Deviation & Variation
  73 - HFB: Trawl Headrope to Footrope and Bottom
  74 - HSC: Heading Steering Command
  75 - ITS: Trawl Door Spread 2 Distance
  76 - LCD: Loran-C Signal Data
  77 - MSK: Control for a Beacon Receiver
  78 - MSS: Beacon Receiver Status
  79 - MTW: Mean Temperature of Water
  80 - MWD: Wind Direction and Speed
  81 - MWV: Wind Speed and Angle
  82 - OSD: Own Ship Data
  83 - RMA: Recommended Minimum Navigation Information
  84 - RMB: Recommended Minimum Navigation Information
  85 - RMC: Recommended Minimum Navigation Information
  86 - ROT: Rate Of Turn
  87 - RPM: Revolutions
  88 - RSA: Rudder Sensor Angle
  89 - RSD: RADAR System Data (**experimental**)
  90 - RTE: Routes
  91 - SFI: Scanning Frequency Information
  92 - TDS: Trawl Door Spread Distance
  93 - TFI: Trawl Filling Indicator
  94 - TLL: Target Latitude and Longitude
  95 - TPC: Trawl Position Cartesian Coordinates
  96 - TPR: Trawl Position Relative Vessel
  97 - TPT: Trawl Position True
  98 - TTM: Tracked Target Message
  99 - VBW: Dual Ground/Water Speed
 100 - VDM: AIS VHF Data-Link Message
 101 - VDO: AIS VHF Data-Link Own-Vessel Report
 102 - VDR: Set and Drift
 103 - VHW: Water speed and heading
 104 - VLW: Distance Traveled through Water
 105 - VTG: Track made good and Ground speed
 106 - VWR: Relative Wind Speed and Angle.
 107 - VPW: Speed - Measured Parallel to Wind
 108 - WCV: Waypoint Closure Velocity
 109 - WNC: Distance - Waypoint to Waypoint
 110 - WPL: Waypoint Location
 111 - XDR: Transducer Measurement
 112 - XTE: Cross-Track Error, Measured
 113 - XTR: Cross Track Error - Dead Reckoning
 114 - ZDA: Time & Date - UTC, day, month, year and local time zone
 115 - ZDL: Time and Distance to Variable Point
 116 - ZFO: UTC & Time from origin Waypoint
 117 - ZTG: UTC & Time to Destination Waypoint
 118
 119 Obsolete (according to the standard) but implemented:
 120 - DBK: Depth Below Keel
 121 - HDM: Heading - Magnetic (obsolete as of 2009)
 122 - R00: Waypoints in active route
 123
 124 Vendor Extensions:
 125 - PGRME: Garmin Estimated Error
 126
 127
 128 ### AIS
 129
 130 Supported messages for AIS (decode and encode):
 131 - Type 01: Position Report Class A
 132 - Type 02: Position Report Class A (Assigned Schedule)
 133 - Type 03: Position Report Class A (Response to Interrogation)
 134 - Type 04: Base Station Report
 135 - Type 05: Static and Voyage Related Data
 136 - Type 09: Standard SAR Aircraft Position Report
 137 - Type 10: UTC/Date Inquiry
 138 - Type 11: UTC/Date Response
 139 - Type 18: Standard Class B CS Position Report
 140 - Type 19: Extended Class B CS Position Report
 141 - Type 21: Aid-to-Navigation Report
 142 - Type 22: Channel Management
 143 - Type 23: Group Assignment Command
 144 - Type 24: Static Data Report (part A and B, norma and auxiliary vessel)
 145
 146
 147 ### SeaTalk
 148
 149 Suported messages for SeaTalk (decode and encode):
 150 - Type 00: depth below transducer
 151 - Type 01: equipment id
 152 - Type 05: Engine RPM and PITCH
 153 - Type 10: apparent wind angle
 154 - Type 11: apparent wind speed
 155 - Type 20: speed through water
 156 - Type 21: trip mileage
 157 - Type 22: total mileage
 158 - Type 23: water temperature 1
 159 - Type 24: Display unit for Mileage and Speed
 160 - Type 25: total and trip log
 161 - Type 26: Speed through Water
 162 - Type 27: water temperature 2
 163 - Type 30: Set Lamp Intensity
 164 - Type 36: Cancel MOB condition
 165 - Type 38: Codelock data (**experimental**)
 166 - Type 50: LAT Postion
 167 - Type 51: LON Postion
 168 - Type 52: Speed over Ground
 169 - Type 53: Magnetic Course in Degrees
 170 - Type 54: GMT Time
 171 - Type 56: Date
 172 - Type 58: LAT/LON
 173 - Type 66: Wind Alarm
 174
 175
 176 ### IO
 177
 178 - Reading data from serial ports (NMEA, SeaTalk)
 179
 180
 181 ### Geodesic Functions
 182
 183 Basic geodesic functions, suitable for martime navigation.
 184
 185 - Calculation of CPA (closest point of approach)
 186   and TCPA (time to closest point of approach)
 187 - Distance of two points on a sphere
 188 - Distance of two points on an ellipsoid using formula of Vincenty
 189 - Distance of two points on an ellipsoid using formula of Lambert
 190
 191
 192 ---
 193
 194 Examples
 195 --------
 196
 197 More examples [here](doc/examples.md).
 198
 199 ### Parse NMEA Sentence
 200
 201 ~~~~~~~~~~~~~{.cpp}
 202 using namespace marnav;
 203
 204 auto sentence = nmea::make_sentence(
 205         "$GPRMC,201034,A,4702.4040,N,00818.3281,E,0.0,328.4,260807,0.6,E,A*17");
 206 std::cout << sentence->tag() << "\n";
 207 auto rmc = nmea::sentence_cast<nmea::rmc>(sentence);
 208 std::cout << "latitude : " << nmea::to_string(rmc->get_lat()) << "\n";
 209 std::cout << "longitude: " << nmea::to_string(rmc->get_lon()) << "\n";
 210 ~~~~~~~~~~~~~
 211
 212 ### Write NMEA Sentence
 213
 214 ~~~~~~~~~~~~~{.cpp}
 215 nmea::mtw mtw;
 216 mtw.set_temperature(22.5);
 217 std::string data = nmea::to_string(mtw);
 218 ~~~~~~~~~~~~~
 219
 220 ### Parse AIS Message from NMEA data
 221
 222 ~~~~~~~~~~~~~{.cpp}
 223 using namespace marnav;
 224
 225 // received sentences
 226 const std::vector<std::string> received_strings
 227         = {"!AIVDM,2,1,3,B,55P5TL01VIaAL@7WKO@mBplU@<PDhh000000001S;AJ::4A80?4i@E53,0*3E",
 228                 "!AIVDM,2,2,3,B,1@0000000000000,2*55"};
 229
 230 // parse NMEA sentences
 231 std::vector<std::unique_ptr<nmea::sentence>> sentences;
 232 for (auto const & txt : received_strings) {
 233         auto sentence = nmea::make_sentence(txt);
 234         if (sentence->id() == nmea::sentence_id::VDM) {
 235                 sentences.push_back(std::move(sentence));
 236         }
 237 }
 238
 239 // parse and and process AIS messags
 240 auto payload = nmea::collect_payload(sentences.begin(), sentences.end());
 241 auto message = ais::make_message(payload);
 242 if (message->type() == ais::message_id::static_and_voyage_related_data) {
 243         auto report = ais::message_cast<ais::message_05>(message);
 244         std::cout << "shipname: " << report->get_shipname() << "\n";
 245         std::cout << "callsign: " << report->get_callsign() << "\n";
 246 }
 247 ~~~~~~~~~~~~~
 248
 249 ### Create NMEA sentences from AIS data
 250
 251 ~~~~~~~~~~~~~{.cpp}
 252 using namespace marnav;
 253
 254 // prepare AIS data
 255 ais::message_01 pos_report;
 256 pos_report.set_sog(82);
 257 // ... most data not shown here
 258
 259 // create payload
 260 auto payload = ais::encode_message(pos_report);
 261
 262 // create NMEA sentences
 263 for (uint32_t fragment = 0; fragment < payload.size(); ++fragment) {
 264         nmea::vdm vdm;
 265         vdm.set_n_fragments(payload.size());
 266         vdm.set_fragment(fragment + 1);
 267         vdm.set_radio_channel(nmea::ais_channel::B);
 268         vdm.set_payload(payload[fragment]);
 269
 270         // collect, send or do something with the sentence...
 271         std::string s = nmea::to_string(vdm);
 272         std::cout << s << "\n";
 273 }
 274 ~~~~~~~~~~~~~
 275
 276 ---
 277
 278 Requirements
 279 ------------
 280
 281 This chapter describes the requirements in order to build the library.
 282 Tools and their versions are listed below, newer/older/other tools
 283 (i.e. compilers, etc.) may work, but not tested.
 284
 285 Compiler:
 286 - GCC 4.9.2
 287 - GCC 5.1.0
 288 - Clang 3.6
 289 - Clang 3.7
 290
 291 Tools needed to build the library:
 292 - cmake 3.0
 293
 294 Tools needed to develop the library:
 295 - git
 296 - clang-format 3.7
 297
 298 Tools needed to build the documentation:
 299 - doxygen
 300 - graphviz
 301 - LaTeX (there are formulas!)
 302
 303 Optional used for development:
 304 - lcov / genhtml, c++filt
 305 - cppcheck
 306 - clang-analyze (3.7 or newer)
 307 - ctags, cscope
 308
 309 Optional (no core dependency):
 310 - Boost.ASIO (used only for some examples)
 311 - Qt 5 (used only for some examples)
 312
 313 Opeating system:
 314 - Linux
 315
 316 There are no other dependencies despite the standard library (C++11)
 317 to build this library.
 318
 319 ---
 320
 321 Build
 322 -----
 323
 324 The following build types `-DCMAKE_BUILD_TYPE=x` are possible:
 325 - Debug
 326 - Release
 327 - Coverage
 328
 329 Build options:
 330 - `ENABLE_STATIC` : enables static build, if `OFF`, a shared library is being built.
 331   Default: `ON`
 332 - `ENABLE_WARNING_HELL` : enables _much_ more warnings, used for development purposes.
 333   Currently implemented only for GCC.  Default is `OFF`
 334 - `ENABLE_PROFILING` : enables profiling
 335
 336
 337 ### Library
 338
 339         mkdir build
 340         cd build
 341         cmake -DCMAKE_BUILD_TYPE=Release ..
 342         make
 343
 344
 345 ### Documentation
 346
 347         mkdir build
 348         cd build
 349         cmake ..
 350         make doc
 351
 352
 353 ### Package
 354
 355         make package
 356
 357 or individual package types:
 358
 359         cpack -G TGZ
 360         cpack -G DEB
 361
 362
 363 ### Developpers Choice
 364
 365         mkdir build
 366         cd build
 367         cmake -DCMAKE_BUILD_TYPE=Coverage -DENABLE_WARNING_HELL=YES ..
 368         make -j 8
 369         make coverage doc cppcheck
 370
 371
 372 ### Static Analysis with Clang
 373
 374         mkdir build
 375         cd build
 376         cmake -DCMAKE_CXX_COMPILER=/usr/share/clang/scan-build-3.7/c++-analyzer ..
 377         scan-build-3.7 --use-analyzer=/usr/bin/clang++-3.7 make
 378
 379 After the build, ```scan-build``` will tell you what to do in order to inspect
 380 the findings.
 381
 382
 383 ### Formatting Test
 384
 385 There is a helper script ```bin/check-format``` which uses ```clang-format``` to
 386 check the formatting of all files in the directories containing code (```src```,
 387 ```test``` and ```examples```). This script can be used manually:
 388
 389         bin/check-format
 390
 391 or used as git pre-commit hook:
 392
 393         cd .git/hooks
 394         ln -s ../../bin/check-format pre-commit
 395
 396 which prevents a commit if there are files not complying with the formatting
 397 rules. Be aware of using the script as pre-commit hook, the checking can take
 398 several seconds.
 399
 400
 401 ---
 402
 403 Authors
 404 -------
 405
 406 Mario Konrad (mario.konrad@gmx.net) with help from others.
 407
 408 Search the repository for a complete list:
 409
 410         git log --format=%an | sort -u
 411
 412 ---
 413
 414 Links
 415 -----
 416
 417 A (non-complete) collection of resources from where information was gathered.
 418
 419 - [NMEA Revealed](http://www.catb.org/gpsd/NMEA.html) (by Eric S. Raymond)
 420 - [NMEA FAQ](http://www.kh-gps.de/nmea.faq)
 421 - [it-digin's blog](http://www.it-digin.com/blog/?cat=4)
 422 - [AIVDM/AIVDO Protocol decoding](http://www.catb.org/gpsd/AIVDM.html) (by Eric S. Raymond)
 423 - [DSC Position Request](http://www.thehulltruth.com/marine-electronics-forum/43945-dsc-position-request.html)
 424 - [NMEA-0183 Sentences DSC,DSE](http://www.cruisersforum.com/forums/f13/nmea-0183-sentences-dsc-dse-124887.html)
 425 - [SerialMon - NMEA 0183 Protocol](http://www.serialmon.com/protocols/nmea0183.html)
 426 - [SeaTalk Reference](http://thomasknauf.de/seatalk.htm) (by Thomas Knauf)
 427 - [Navigation Center - AIS Standard Class B Equipment Position Report](http://www.navcen.uscg.gov/?pageName=AISMessagesB)
 428 - [GPS Forums](http://www.gps-forums.net)
 429 - [NMEA Datensaetze](http://www.nmea.de/nmea0183datensaetze.html)
 430
 431 ---
 432
 433 LICENSE
 434 -------
 435
 436 > NOTE:
 437 > The official NMEA 0183 Standard document is not available for free. It was not
 438 > consulted at any point during the development of this library. All information
 439 > was found from free sources on the internet. This library (especially the NMEA
 440 > part) is not derivative work of this standard.
 441
 442
 443 See also [LICENSE](LICENSE)
 444
 445 (BSD)
 446
 447 ```
 448 Copyright (c) 2015, Mario Konrad
 449 All rights reserved.
 450
 451 Redistribution and use in source and binary forms, with or without
 452 modification, are permitted provided that the following conditions are met:
 453 1. Redistributions of source code must retain the above copyright
 454    notice, this list of conditions and the following disclaimer.
 455 2. Redistributions in binary form must reproduce the above copyright
 456    notice, this list of conditions and the following disclaimer in the
 457    documentation and/or other materials provided with the distribution.
 458 3. All advertising materials mentioning features or use of this software
 459    must display the following acknowledgement:
 460    This product includes software developed by Mario Konrad.
 461 4. Neither the name of the software nor the names of its contributors
 462    may be used to endorse or promote products derived from this software
 463    without specific prior written permission.
 464
 465 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 466 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 467 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 468 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 469 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 470 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 471 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 472 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 473 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 474 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 475 ```
 476
 477