In order to support legacy hardware quickly, Polaris also supports the NTRIP standard (version 1 and 2). This API is not recommended for new designs.
The Point One Navigation Polaris NTRIP API provides GNSS corrections over the NTRIP protocol. The service supports clients using both the NTRIP 1.0 and NTRIP 2.0 specifications.
System Overview
The NTRIP stream endpoints and corresponding messages support RTCM3 streams over HTTP using basic (username and password) authentication.
Connection Details
| Region | Endpoint | Port | Description |
|---|---|---|---|
| North America | polaris.pointonenav.com | 2102 | TLS Encrypted |
| North America | polaris.pointonenav.com | 2101 | plaintext, not recommended for production designs |
| Europe | polaris-eu.pointonenav.com | 2102 | TLS Encrypted |
| Europe | polaris-eu.pointonenav.com | 2101 | plaintext, not recommended for production designs |
Parameters
| Field | Description |
|---|---|
| Username | The username field should be populated with a string that uniquely identifies the connection. There can not be two concurrent connections to the Point One NTRIP service with the same unique ID. The unique ID may only contain letters, numbers, dashes, or underscores and can be at most 32 characters. |
| Password | The password field should be populate with an NTRIP password that will be provided by Point One Navigation. |
| Mountpoint | The user should select POLARIS as the mount point. |
Sending locations
In order to receive corrections, the client must send a location to the Polaris NTRIP service. Locations can either be sent in the initial request using a Ntrip-GGA header, or by sending GGA lines to the server after the initial connection. See the NMEA-0183 GPGGA message section for details on the format of GGA messages.
NMEA-0183 GPGGA message
The NMEA-0183 GPGGA message type is used to send locations, and has the following format:
$GPGGA,235317.000,4003.9039,N,10512.5793,W,1,08,1.6,1577.9,M,-20.7,M,,0000*5F
This example GPGGA sentence contains the following fields:
- Time: 235317.000 is 23:53 and 17.000 seconds in Greenwich mean time
- Longitude: 4003.9040,N is latitude in DDmm.mm, north
- Latitude: 10512.5792,W is longitude in DDmm.mm, west
- Number of satellites seen: 08
- Altitude: 1577 meters
Where DD is degrees, and mm.mm is minutes.
Additional Details
- NTRIP 1.0
- For NTRIP 1.0 responses, clients should include the Ntrip-Version: ntrip/1.0 header. The service will respond with ICY 200 OK followed by a new line and then the binary RTCM stream.
- NTRIP 2.0
-
- For NTRIP 2.0 responses, clients should include the Ntrip-Version: ntrip/2.0 header. The service will respond with the standard HTTP/1.1 200 OK response followed by standard HTTP headers, followed by the binary RTCM stream. For NTRIP 2.0, the RTCM stream will be sent to the client using chunked encoding, as indicated by the Transfer-Encoding: chunked header.
-
Dynamic Credentials
The device submits the API key to receive a username:password pair for use in NTRIP based authentication.
The Dynamic Credential request endpoint is:
https://api.pointonenav.com/api/v1/auth/ntrip
- Method: POST
- Auth required: NO
- Data constraints
{
"grant_type": "authorization_code",
"token_type": "bearer",
"authorization_code": "[API Key]",
"unique_id": "[Unique Id]"
}
- Data example
{
"grant_type": "authorization_code",
"token_type": "bearer",
"authorization_code": "a94fd3abd3a84o494273h28923dh38",
"unique_id": "mydevice-14xfd3c"
}
- Success Response
- Code: 200 OK
- Content example
{
"username": "random_user_name",
"password": "asjkfhlgfkfdl2"
}
Note: These credentials will expire approximately 24 hours after issuance. For longer lived credentials, do not use the dynamic credential endpoint.
- Error Response
- Code: 403 FORBIDDEN
- Condition: If API_KEY is invalid