-
Notifications
You must be signed in to change notification settings - Fork 1
inReach KML Feed Documentation
Technical details about MapShare KML feeds
Excerpts taken from: About inReach KML Feeds
A feed of the data from an inReach® user account is available as a KML (Keyhole Markup Language) feed from the Social tab of the Garmin Explore™ website when using a browser on a computer. These feeds are primarily intended to allow the inReach data to be displayed on other map portals.
The inReach KML feeds are designed to be polled for new point information at a frequency desired by the consumer; there is no ability for the Garmin server to push KML to another server.
Important
For any URLs requiring authentication, web browsers will prompt the user to enter a username and password. When connecting to the Direct URLs using software, the user provides the username and password details using basic HTTP authentication. Always connect to these URLs using SSL (HTTPS) connections to avoid passing authentication details in plain text.
KML feeds require that MapShare™ be enabled, and are tied to the settings selected on the inReach MapShare page. Message types that are disabled for viewing in the MapShare options will not display through the KML feed.
KML feeds may be accessed from the Garmin Explore website using several different URLs depending on the user who will be using the feed and the information desired. The inReach KML feeds are designed to be polled for new point information at the frequency set by the user; there is no ability for the Garmin server to push KML to another server. These feeds are primarily intended to allow inReach data to be displayed on other map portals.
For any URLs requiring authentication, web browsers will prompt the user to enter a username and password. When connecting to the Direct URLs using software, the user provides the username and password details using basic HTTP authentication. Always connect to these URLs using SSL (HTTPS) connections to avoid passing authentication details in plain text.
For convenience, Loader URLs are provided that generate KML files that are suitable for loading directly into Google Earth and are preconfigured with the appropriate element to allow Google Earth to periodically query for new data.
https://inreach.garmin.com/feed/ShareLoader/:MapShareIdentifier
-
:MapShareIdentifiershould be replaced with the appropriate identifier from the explore.delorme.com website - see the Social tab for more details. - Refers to the MapShare Direct URL
https://explore.garmin.com/ECC/Chat/KmlFeed/300200000000000
- Used in the Emergency Call Center (ECC) application to enable export and update of the data for an inReach user in an emergency.
- Refers to the ECC Direct URL
These URLs provide direct access to the data for one or more devices; the KML that is generated does not contain any elements that would allow Google Earth (or other applications) to query the server for additional data.
https://inreach.garmin.com/feed/share/<MapShare Identifier>
- For inReach users, allowing users to access their own accounts. By default only the most recent point is shown.
- Only exports points that meet the MapShare settings for the user.
- If the MapShare settings indicate a username or password, those must be provided using Basic HTTP Authentication.
https://explore.garmin.com/feed/ecc?imei=300200000000000
- By default the last seven days of information is shown.
- Requires an ECC enabled username and password (the tenant username and password for enterprise accounts that have disabled the Garmin Response Center).
- One or more IMEIs is required and specified by the IMEI parameter.
By default, KML feeds will only display the most recent message or track sent to the MapShare page. All of the direct URLs support parameters to change the data that will be returned in the KML response. The Raw KML Feed can be appended with the following parameters to customize a date range.
| Parameter | Description | Example KML Feed |
|---|---|---|
| D1 | Start date for the query -in UTC time | https://inreach.garmin.com/feed/share/SAMPLE1?d1=2012-10-16T06:19z |
| D | End date for the query -in UTC time | https://inreach.garmin.com/feed/share/SAMPLE2?d1=2012-10-16T06:19z&d2=2012-10-18T23:59z |
| IMEI | Comma separated list of IMEIs to show | https://inreach.garmin.com/feed/share/SAMPLE3?imei=300200000001138,300434000012345 |
KML placemarks contain a name (label) and a UTC timestamp (in ISO 8601 format). Additionally, the placemark contains “ExtendedData”. The following table describes those data elements as of the date of this document.
| Name | Description | Example |
|---|---|---|
| ID | Garmin internal ID for the event | 868926 |
| Time UTC | US-formatted version of the event timestamp as UTC | 5/2/2020 6:01:30 AM |
| Time | US-formatted version of the event timestamp in the preferred time zone of the account owner | 5/2/2020 9:01:30 AM |
| Name | First and last name of the user assigned to the device that sent the message | Joe User |
| Map Display Name | Map Display Name for this user. This field is editable by the user in their Account or Settings page. | Joe the inReach User |
| Device Type | The hardware type of the device in use | inReach 2.5 |
| IMEI | The IMEI of the device sending the message | 300000000000000 |
| Incident ID | The ID of the emergency event if there is one. Messages sent while a device is in SOS mode are omitted from KML feeds except for emergency response agencies under special arrangement. | 1234 |
| Latitude | Latitude in degrees WGS84 where negative is south of the equator | 43.790485 |
| Longitude | Longitude in degrees WGS84 where negative is west of the Prime Meridian | -70.192015 |
| Elevation | Value is always meters from Mean Sea Level | 120.39 m from MSL |
| Velocity | Ground speed of the device. Value is always in kilometers per hour. | 1.0 km/h |
| Course | Approximate direction of travel of the device, always in true degrees. | 292.50° True |
| Valid GPS Fix | True of the device has a GPS fix. This not a measure of the quality of GPS fix. It is unlikely that any point will be provided without a valid GPS fix. | True |
| In Emergency | True if the device is in SOS state. Messages sent while a device is in SOS mode are omitted from KML feeds except for emergency response agencies under special arrangement. | False |
| Text | Message text, if any, in Unicode | I am doing good! |
| Event | The even log type. See table below under Event Log Types | Tracking Message Received |
KML elements come from an event log, which records the type of event occurring at the Garmin message gateway. The types of events which are relevant to device activity that appears in KML are listed in the table below. The most common messages appear at the top of the table. All events include a location being sent by the inReach device.
| Type ID | Event Description | Explanation |
|---|---|---|
| 17 | Tracking message received | Device has sent a track point |
| 13 | Text message received | Device has sent text |
| 30 | Tracking interval received | Device has changed how often it sends track points |
| 38 | Tracking turned on from device | Device started tracking |
| 43 | Text quick message received | Device has trigged a Check-In Messages (formerly known as Preset Messages) |
| 29 | Tracking turned off from device | Device has stopped tracking |
| 52 | Quick Text to MapShare received | Device has sent a Check-In Messages (formerly known as Preset Messages) and includes the MapShare as an addressee. |
| 16 | Location received | Device has responded to a Location Request |
| 46 | Append MapShare to txt msg code received | Device has sent a message announcing the MapShare site |
| 45 | Msg to shared map received | Devices has sent a text message that includes the MapShare as an addressee |
| 6 | Emergency canceled | Device canceling SOS |
| 54 | Test message received | Devices replied to a Test |
| 1 | Emergency initiated from device | Device is declaring an SOS |
| 4 | Emergency confirmed | Device has received acknowledgment from the emergency response team and is continuing with SOS |
| 18 | Waypoint/navigation received | Device is sending a new/changed waypoint or route definition |
| 56 | Waypoint/navigation stopped | Device has stopped following a route |
| 55 | Waypoint/navigation started | Device has started following a route |
| 41 | Reference point message received | Device has sent a Reference Point |