WebSocket V1 Server

View AsyncAPI Definition The AsyncAPI Definition for this API is available to view and download here.

WebSocket V1 Server 1.0.0 documentation

Table of Contents

• Servers
  • websocket-v1-friendly
  • websocket-v1-localhost
  • websocket-v1-loopback
• Operations
  • SEND /

Servers

websocket-v1-friendly Server

• URL: ws://tmm-api-local.fieldsystems.trimble.com:9635/
• Protocol: ws

websocket-v1-localhost Server

• URL: ws://localhost:9635/
• Protocol: ws

websocket-v1-loopback Server

• URL: ws://127.0.0.1:9635/
• Protocol: ws

Operations

SEND / Operation

• Operation ID: sendlocationV1

Message LocationV1DataMessage

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
latitude	number	Latitude in decimal degrees North positive, south negative	-	format (double)	-
longitude	number	Longitude in decimal degrees East positive, west negative	-	format (double)	-
altitude	number	Altitude in meters	-	format (double)	-
speed	number	Speed in meters per second	-	format (float)	-
bearing	number	Bearing in decimal degrees Measured clockwise from north for North Azimuth projections, or clockwise from south for South Azimuth projections.	-	format (float)	-
accuracy	number	Accuracy in meters	-	format (float)	-
verticalAccuracyMeters	number	Vertical accuracy in meters	-	format (float)	-
satellites	integer	Number of satellites observed	-	-	-
totalSatInView	integer	Number of satellites in view, identical to satellites	-	-	-
pdop	number	Position Dilution of Precision	-	format (float)	-
hdop	number	Horizontal Dilution of Precision	-	format (float)	-
vdop	number	Vertical Dilution of Precision	-	format (float)	-
diffAge	number	Message age of any RTK message in seconds	-	format (float)	-
diffStatus	integer	Position solution status: 1=Autonomous, 2=DGPS, 4=Fixed, 5=Float	-	-	-
diffID	string	ID of the RTK base station -1 if unknown, otherwise 4-digit ID	-	-	-
vrms	number	Vertical Root Mean Square in meters	-	format (float)	-
hrms	number	Horizontal Root Mean Square in meters	-	format (float)	-
receiverModel	string	Receiver model type	-	-	-
mockProvider	string	Mock provider name “Trimble Mobile Manager”	-	-	-
appVersion	string	TMM build version semantic versioning Major.Minor.Patch (0.0.0)	-	-	-
battery	integer | null	Battery percentage if the receiver has an internal battery	-	-	-
geoidModel	string	Geoid model used for height calculations	-	-	-
mslHeight	number | null	Height above mean sea level in meters Includes geoid undulation if geoid is available	-	format (float)	-
undulation	number | null	Height difference between ellipsoid and geoid	-	format (float)	-
utcTime	number	UTC time as a float	-	format (float)	-
gpsTimeStamp	string	GPS time formatted as ISO string	-	-	-
utcTimeStamp	string	UTC time formatted as ISO string	-	-	-
satelliteView	array<object>	List of satellites in view	-	-	-
satelliteView.Id	integer	ID of the satellite	-	-	-
satelliteView.Elv	integer	Elevation angles of the satellite above the horizon in degrees.	-	-	-
satelliteView.Azm	integer	Azimuth angle of the satellite in degrees.	-	-	-
satelliteView.Snr	integer	Signal-to-noise ratio (SNR) for the satellite.	-	-	-
satelliteView.Use	boolean	Satellite is is use true/false	-	-	-
satelliteView.Type	integer	Type of GNSS system of the satellite.	-	-	-
subscriptionType	integer	The type of the currently used subscription 0 == Catalyst Free; 1 == Catalyst 60; 2 == Catalyst 30; 3 == Catalayst 10; 4 == Catalyst 1; 5 == Catalyst On Demand; 100 == GNSS receiver	-	-	-

Examples of payload (generated)

{
  "latitude": 0.1,
  "longitude": 0.1,
  "altitude": 0.1,
  "speed": 0.1,
  "bearing": 0.1,
  "accuracy": 0.1,
  "verticalAccuracyMeters": 0.1,
  "satellites": 0,
  "totalSatInView": 0,
  "pdop": 0.1,
  "hdop": 0.1,
  "vdop": 0.1,
  "diffAge": 0.1,
  "diffStatus": 0,
  "diffID": "string",
  "vrms": 0.1,
  "hrms": 0.1,
  "receiverModel": "string",
  "mockProvider": "string",
  "appVersion": "string",
  "battery": 0,
  "geoidModel": "string",
  "mslHeight": 0,
  "undulation": 0,
  "utcTime": 0.1,
  "gpsTimeStamp": "string",
  "utcTimeStamp": "string",
  "satelliteView": [
    {
      "Id": 0,
      "Elv": 0,
      "Azm": 0,
      "Snr": 0,
      "Use": true,
      "Type": 0
    }
  ],
  "subscriptionType": 0
}