@furkot/garmin-data 1.0.1 → 2.0.0

package/index.js

@@ -1 +1 @@
-module.exports = require('./lib/garmin');
+module.exports = require('./lib');

package/lib/garmin.js

@@ -7,7 +7,7 @@ module.exports = {
     4: 'Trail Head',              // snowshoeing
     5: 'Library',                 // book
     6: 'Bank',                    // deal
-  //7: '',                        // pin
+    7: 'Pin, Blue',               // pin
     8: 'Bike Trail',              // biking
     9: 'Picnic Area',             // picnic
     10: 'Gas Station',            // charging
@@ -26,7 +26,7 @@ module.exports = {
     23: 'Airport',                // airplane
     24: 'Restaurant',             // restaurant
     25: 'Gas Station',            // fillingstation
-  //26: '',                       // motorcycle
+    26: 'Bike Trail',             // motorcycle
     27: 'Food Source',            // farmstand
     28: 'Bar',                    // brewery
     29: 'Amusement Park',         // amusementpark
@@ -43,7 +43,7 @@ module.exports = {
     40: 'Building',               // worldheritagesite
     41: 'City Hall',              // officebuilding
     42: 'Church',                 // shrine
-    43: 'Tower',                  // tower
+    43: 'Tall Tower',             // tower
     44: 'Church',                 // temple
     45: 'Museum',                 // sciencemuseum
     46: 'Building',               // landmark
@@ -69,13 +69,13 @@ module.exports = {
     66: 'Library',                // library
     67: 'Zoo',                    // zoo
     68: 'Stadium',                // stadium
-  //69: '',                       // windmill
-  //70: '',                       // square
+    69: 'Short Tower',            // windmill
+    70: 'Square, Green',          // square
     71: 'City (Medium)',          // town
-  //72: '',                       // statue
+    72: 'Buoy, White',            // statue
     73: 'Information',            // information
-  //74: '',                       // amphitheater
-  //75: '',                       // observatory
+    74: 'Diamond, Green',         // amphitheater
+    75: 'Scenic Area',            // observatory
   //76: '',                       // passthru
     77: 'Drinking Water',         // tap
     78: 'Convenience Store',      // minimarket
@@ -86,27 +86,129 @@ module.exports = {
     83: 'Truck Stop',             // truck
     84: 'RV Park',                // rvpark
     85: 'Bridge',                 // bridge
-    86: 'City (Capitol)',         // star
+    86: 'Favorite',               // star
     87: 'Geocache',               // treasure
-  //88: '',                       // teleport
+    88: 'Parachute Area',         // teleport
     89: 'Crossing',               // railroadcrossing
     90: 'Restaurant',             // coffee
     91: 'ATV',                    // atv
     92: 'Dog, sitting',           // pets
-  //93: '',                       // fire
+    93: 'Triangle, Red',          // fire
     94: 'Fishing Area',           // pier
     95: 'Ferry',                  // ferry
     96: 'Live Theater',           // theater
     97: 'Railway',                // train
     98: 'Parking Area',           // parking
     99: 'Shopping Center',        // cart
-    100: 'Boat Ramp'              // boatramp
+    100: 'Boat Ramp',             // boatramp
+    101: 'Covey',                 // bird
+    102: 'Mile Marker',           // clock
+    103: 'Movie Theater',         // film
+    104: 'Horn',                  // music
+    105: 'Contact, clown',        // entertain
+    106: 'Ground Transportation', // bus
+    107: 'Ground Transportation', // taxi
+    108: 'ATV',                   // off-road
+    109: 'Dam',                   // dam
+    110: 'Skull and Crossbones',  // danger
+    111: 'Exit',                  // enter
+    112: 'Geocache',              // gift
+    113: 'Contact, Blonde',       // hairdresser
+    114: 'Favorite',              // heart
+    115: 'Oil Field',             // industry
+    116: 'Happy Face',            // laundry
+    117: 'Beacon',                // lighthouse
+    118: 'Controlled Area',       // one-way
+    119: 'Fitness Center',        // playground
+    120: 'Police Station',        // police
+    121: 'Police Station',        // prison
+    122: 'Laydown',               // roadblock
+    123: 'Contact, Alien',        // rocket
+    124: 'School',                // school
+    125: 'Fishing Hot Spot Facility',// shelter
+    126: 'Shipwreck',             // suitcase
+    127: 'Dog, running',          // veterinary
+    128: 'Sad Face',              // remove
+    129: 'Underwater Grass',      // wetland
+    130: 'Circle with X',         // wheelchair
+    131: 'Golf Course',           // golf
+    132: 'Post Office',           // envelope
+    133: 'Funicular',             // aerialway
+    134: 'Ultralight Area',       // airfield
+    135: 'Bar',                   // alcohol_shop
+    136: 'Stadium',               // american_football
+    137: 'Fishing Area',          // aquarium
+    138: 'Scenic Area',           // attraction
+    139: 'Pizza',                 // bakery
+    140: 'Ball Park',             // baseball
+    141: 'Stadium',               // basketball
+    142: 'Building',              // building
+    143: 'Contact, Pig',          // butcher
+    144: 'Building',              // castle
+    145: 'Navaid, White',         // radio-unchecked
+    146: 'Circle, Blue',          // circle
+    147: 'Department Store',      // clothing_store
+    148: 'School',                // college
+    149: 'Scales',                // commercial
+    150: 'Stadium',               // cricket
+    151: 'Crossing',              // cross
+    152: 'Hospital',              // dentist
+    153: 'Hospital',              // doctor
+    154: 'City Hall',             // embassy
+    155: 'Exit',                  // entrance
+    156: 'Fast Food',             // fast_food
+    157: 'Heliport',              // heliport
+    158: 'Fast Food',             // ice_cream
+    159: 'Pin, Green',            // marker
+    160: 'Summit',                // mountain
+    161: 'Parking, Pay',          // parking_garage
+    162: 'Pharmacy',              // pharmacy
+    163: 'Telephone',             // phone
+    164: 'Stadium',               // pitch
+    165: 'Church',                // place_of_worship
+    166: 'Railway',               // rail_light
+    167: 'Railway',               // rail_metro
+    168: 'Stadium',               // soccer
+    169: 'Square, Yellow',        // square-stroke
+    170: 'Square, Blue',          // square-fill
+    171: 'City (Capitol)',        // star-stroke
+    172: 'Restaurant',            // sushi
+    173: 'Stadium',               // tennis
+    174: 'Triangle, Blue',        // triangle
+    175: 'Triangle, Yellow',      // triangle_stroked
+    176: 'Multi-Cache',           // warehouse
+    177: 'Weed Bed',              // garden
+    178: 'Gas Station',           // diesel
+    179: 'Gas Station',           // ethanol-free
+    180: 'Swimming Area',         // swimming
+    181: 'Puzzle Cache'           // question
   },
   toFurkot: {
+    'ATV': 91,                    // atv
+    'Bar': 31,                    // bar
+    'Bike Trail': 8,              // biking
+    'Building': 51,               // structure
     'Church': 34,                 // church
+    'City Hall': 41,              // officebuilding
+    'Crossing': 89,               // railroadcrossing
+    'Exit': 155,                  // entrance
+    'Fast Food': 156,             // fast_food
+    'Favorite': 86,               // star
+    'Fishing Area': 137,          // aquarium
+    'Gas Station': 25,            // fillingstation
+    'Geocache': 87,               // treasure
+    'Ground Transportation': 106, // bus'
+    'Hospital': 81,               // hospital
     'Lodging': 0,                 // hotel
     'Museum': 33,                 // museum
     'Park': 50,                   // park
+    'Police Station': 120,        // police
+    'Railway': 97,                // train
+    'Residence': 12,              // house
+    'Restaurant': 24,             // restaurant
+    'Scenic Area': 61,            // lookout
+    'School': 124,                // school
+    'Stadium': 68,                // stadium
     'Summit': 59,                 // mountains
     'Swimming Area': 54,          // watersport
     'Trail Head': 3               // guide

package/lib/index.js

@@ -0,0 +1,233 @@
+const {
+  toGarmin,
+  toFurkot,
+  colors
+} = require('./garmin');
+
+const schema = [
+  [
+    'xmlns:gpxx', 'http://www.garmin.com/xmlschemas/GpxExtensions/v3',
+    'http://www8.garmin.com/xmlschemas/GpxExtensionsv3.xsd'
+  ],
+  [
+    'xmlns:trp', 'http://www.garmin.com/xmlschemas/TripExtensions/v1',
+    'http://www.garmin.com/xmlschemas/TripExtensionsv1.xsd'
+  ],
+  [
+    'xmlns:tmd', 'http://www.garmin.com/xmlschemas/TripMetaDataExtensions/v1',
+    'http://www.garmin.com/xmlschemas/TripMetaDataExtensionsv1.xsd'
+  ],
+  [
+    'xmlns:vptm', 'http://www.garmin.com/xmlschemas/ViaPointTransportationModeExtensions/v1',
+    'http://www.garmin.com/xmlschemas/ViaPointTransportationModeExtensionsv1.xsd'
+  ]
+];
+
+const modeMap = [
+  'Motorcycling',
+  'Automotive',
+  'Bicycling',
+  'Walking',
+  'Direct',
+  'Direct',
+  'RV',
+  'Direct'
+];
+
+function getMode(rMode, mMode) {
+  if (rMode !== undefined) {
+    return modeMap[rMode + 1] || 'Unknown';
+  }
+  return modeMap[(mMode || 0) + 1] || 'Unknown';
+}
+
+const millisInMinute = 60 * 1000;
+const millisInHour = 60 * millisInMinute;
+
+function formatDuration(step) {
+  const duration = ['P'];
+  if (step.nights) {
+    duration.push(step.nights, 'D');
+  }
+  if (step.visit_duration) {
+    duration.push('T');
+    let dur = Math.floor(step.visit_duration / millisInHour);
+    if (dur) {
+      duration.push(dur, 'H');
+    }
+    dur = Math.floor((step.visit_duration % millisInHour) / millisInMinute);
+    if (dur) {
+      duration.push(dur, 'M');
+    }
+  }
+  if (duration.length > 2) {
+    return duration.join('');
+  }
+}
+
+function getWptExt({ start, end, el, elIfText, each }) {
+  return function* (st) {
+    yield* start('gpxx:WaypointExtension');
+    if (st.tags && st.tags.length) {
+      yield* start('gpxx:Categories');
+      yield* each(st.tags, function* (cat) {
+        yield* el('gpxx:Category', null, cat);
+      });
+      yield* end();
+    }
+    if (st.address) {
+      yield* start('gpxx:Address');
+      yield* elIfText('gpxx:StreetAddress', st.stopStreetAddress);
+      if (st.locality) {
+        yield* elIfText('gpxx:City', st.locality.town);
+        yield* elIfText('gpxx:State', st.locality.province);
+        yield* elIfText('gpxx:Country', st.locality.country_long);
+      }
+      yield* end();
+    }
+    yield* elIfText('gpxx:PhoneNumber', st.phone);
+    yield* end();
+  };
+}
+
+function getRteExt({ ctx, start, end, el, elIfText }) {
+  return function* (rt) {
+    yield* start('gpxx:RouteExtension');
+    yield* elIfText('gpxx:IsAutoNamed', 'false');
+    yield* elIfText('gpxx:DisplayColor', colors[rt.color] || 'Blue');
+    yield* end();
+
+    const { mode, name } = ctx?.metadata || {};
+
+    if (rt.mode !== undefined || mode !== undefined) {
+      yield* start('trp:Trip');
+      //- The <trp:TransportationMode> extension tells the devices Trip Planner algorithm what calculation type to use:
+      //- Automotive, Motorcycling, Walking, Bicycling, Direct.
+      yield* elIfText('trp:TransportationMode', getMode(rt.mode, mode));
+      yield* end();
+
+      if (name || rt.routeTimestamp || rt.day) {
+        yield* start('tmd:TripMetaData');
+        yield* el('tmd:TripName', null, name || '');
+        if (rt.routeTimestamp) {
+          yield* elIfText('tmd:Date', rt.routeTimestamp);
+        }
+        yield* elIfText('tmd:DayNumber', rt.day);
+        yield* end();
+      }
+    }
+  };
+}
+
+function getRtePtExt({ ctx, precision, start, end, each, el, elIfText }) {
+
+  function* $gpxxRpt(p, subclass) {
+    const attribs = {
+      lat: p[1].toFixed(precision),
+      lon: p[0].toFixed(precision)
+    };
+
+    if (subclass) {
+      yield* start('gpxx:rpt', attribs);
+      yield* el('gpxx:Subclass', null, subclass);
+      yield* end();
+    } else {
+      yield* el('gpxx:rpt', attribs);
+    }
+  }
+
+  return function* (rt, st, index, next) {
+    let shapingPoint;
+
+    if (st.stopIsActualStop || index % 124 === 0 || !next) {
+      //- The <trp:ViaPoint> is equivalent to a Furkot Stop.
+      yield* start('trp:ViaPoint');
+      if (st.stopDeparture && next) {
+        yield* elIfText('trp:DepartureTime', st.stopDeparture);
+      }
+      if (index && next) {
+        yield* elIfText('trp:StopDuration', formatDuration(st));
+      }
+      if (st.stopTimestamp && index > 0) {
+        yield* elIfText('trp:ArrivalTime', st.stopTimestamp);
+      }
+      yield* elIfText('trp:CalculationMode', 'FasterTime');
+      yield* elIfText('trp:ElevationMode', 'Standard');
+      yield* end();
+    } else {
+      shapingPoint = true;
+      //- The <trp:ShapingPoint> is equivalent to Furkot Pass-through Points.
+      //- These points are displayed in the Route point list on the GPS but are not announced during navigation.
+      //- There can be up to 124 ShapingPoints between each ViaPoint.
+      yield* el('trp:ShapingPoint');
+    }
+    if (next && next.mode !== undefined) {
+
+      //- The <vptm:ViaPointTransportationMode> extension tells the devices Trip Planner algorithm
+      //- what calculation type to use between this and next point:
+      //- Automotive, Motorcycling, Walking, Bicycling, Direct.
+      yield* start('vptm:ViaPointTransportationMode');
+      yield* elIfText('vptm:TransportationMode', getMode(next.mode));
+      yield* end();
+    }
+    if (ctx.RoutePointExtension) {
+      yield* start('gpxx:RoutePointExtension');
+
+      //- The <gpxx:Subclass> is a special Garmin code for older Garmin devices that do not use
+      //- the Trip Planner algorithm. This specific code says to use the above RoutePoint as a waypoint.
+      //- Older Garmin devices don't use the Trip Planner algorithm.
+      yield* el('gpxx:Subclass', null, '000000000000FFFFFFFFFFFFFFFFFFFFFFFF');
+      const expanded = next && next.track;
+
+      if (expanded) {
+        yield* each(expanded, function* (p) {
+          let subclass;
+
+          //- All of the <gpxx:rpt> are equivalent to Furkot Track Points generated between Stops.
+          //- These points are not displayed on the GPS or announced during navigation.
+          if (next.custom || next.mode === 3) {
+            //- This Subclass code denotes a route point that is not on a mapped road (off-road).
+            //- There are usually many of these in succession to define the route path
+            //- and each off-road point needs to have this Subclass.
+            subclass = 'FFFF00000000FFFFFFFF2117000000000000';
+          } else if (shapingPoint) {
+            shapingPoint = false;
+            //- A Subclass other than 000000000000FFFFFFFFFFFFFFFFFFFFFFFF must be added after a ShapingPoint.
+            //- Any other ‘valid’ Subclass code works.
+            subclass = '0300F2F7C403DD6E00002116000025490404';
+          }
+
+          yield* $gpxxRpt(p, subclass);
+        });
+        yield* $gpxxRpt(expanded[expanded.length - 1], '000000000000FFFFFFFFFFFFFFFFFFFFFFFF');
+      }
+
+      yield* end();
+    }
+  };
+}
+
+function getTrkExt({ start, end, elIfText }) {
+  return function* (tr) {
+    yield* start('gpxx:TrackExtension');
+    yield* elIfText('gpxx:DisplayColor', colors[tr.color]);
+    yield* end();
+  };
+}
+
+module.exports = {
+  getWptCmt: st => st.notes,
+  getWptSym: st => toGarmin[st.sym],
+  hasWptExt: st => st.address || st.phone || st.tags?.length,
+  getWptExt,
+  hasRteExt: () => true,
+  getRteExt,
+  hasRtePtExt: () => true,
+  getRtePtExt,
+  hasTrkExt: tr => tr.color,
+  getTrkExt,
+  schema,
+  toGarmin,
+  toFurkot,
+  colors
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@furkot/garmin-data",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Data used by Furkot modules dealing with Garmin GPX format.",
   "author": {
     "name": "Damian Krzeminski",