Subscribe to one rover

WebSocket endpoint

URL
wss://nmea.geodnet.com/rover/v1/subscribe/:id

Headers

Authorization: Bearer Token

Header parameter

Parameter
Example
Description

Authorization

Bearer b2335d2cee91b9a4c05e4585...==

Authorization token

Request path example

id: 68a29126e2cc922e3a08ab57

Response parameter

Parameter
Example
Type
Description

code

0

Number

Status code

msg

Success

String

Status code description

data

Array

Data content

data[idx].id

68a29126e2cc922e3a08ab57

String

Rover Id

data[idx].data

$GPGGA,023617.017,...*5B\r\n

String

NMEA 0183 GGA string(s)

Response example

{
"code": 0,
"data": [
{
  "id": "68a29126e2cc922e3a08ab57",
  "data": "$GPGGA,023617.017,3723.993880,N,12159.157465,W,1,00,0.000,0,M,0,M,1.000,0001*5B\r\n"
},
{
  "id": "68a29126e2cc922e3a08ab57",
  "data": "$GPGGA,023617.017,3723.993880,N,12159.157465,W,1,00,0.000,0,M,0,M,1.000,0001*5B\r\n$GPGGA,023617.017,3723.993880,N,12159.157465,W,1,00,0.000,0,M,0,M,1.000,0001*5B\r\n"
}
]
}

Clients

- Using wscat

ROVER_ID="68a29126e2cc922e3a08ab57"
wscat -c "wss://nmea.geodnet.com/rover/v1/subscribe/$ROVER_ID" \
-H "Authorization: Bearer $TOKEN"

- Using websocat

ROVER_ID="68a29126e2cc922e3a08ab57"
websocat -H="Authorization: Bearer $TOKEN" \
"wss://nmea.geodnet.com/rover/v1/subscribe/$ROVER_ID"

- Using Node.js (ws)

const WebSocket = require('ws');
const token = process.env.TOKEN;
const roverId = '68a29126e2cc922e3a08ab57';

const ws = new WebSocket(`wss://nmea.geodnet.com/rover/v1/subscribe/${roverId}`, {
headers: { Authorization: `Bearer ${token}` }
});

ws.on('open', () => console.log('connected'));
ws.on('message', (data) => console.log('msg:', data.toString()));
ws.on('error', (err) => console.error('error:', err));
ws.on('close', () => console.log('closed'));

Last updated