TMM Websockets
Consuming position data from the TMM websockets.
Use the TMM websocket to receive detailed position information in your application when the TMM app is controlling a Trimble GNSS receiver.
Table of Contents
Servers
localhost Server
- URL:
localhost - Protocol:
ws
The TMM websocket is served on 127.0.0.1 or localhost on the Android or iOS device.
Operations
PUB localhost:v2SocketPort Operation
The version 2 websocket sends extended position information. This websocket is only available for registered applications.
Message PositionInfoV2Message
The positionInfo version 2 message contains extended position information.
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 (double) | - |
| bearing | number | Bearing in decimal degrees Measured clockwise from north for North Azimuth projections, or clockwise from south for South Azimuth projections. | - | format (double) | - |
| geoidModel | string | Geoid model used for height calculations | - | - | - |
| hrms | number | Horizontal Root Mean Square in meters | - | format (double) | - |
| vrms | number | Vertical Root Mean Square in meters | - | format (double) | - |
| satellites | integer | Number of satellites observed | - | - | - |
| totalSatInUse | integer | Number of satellites that are used for the position solution | - | - | - |
| totalSatInView | integer | Number of satellites in view, identical to satellites | - | - | - |
| pdop | number | Position Dilution of Precision | - | format (double) | - |
| hdop | number | Horizontal Dilution of Precision | - | format (double) | - |
| vdop | number | Vertical Dilution of Precision | - | format (double) | - |
| diffAge | number | Message age of any RTK message in seconds | - | format (double) | - |
| 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 | - | - | - |
| 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 | Battery percentage if the receiver has an internal battery | - | - | - |
| mslHeight | number | Height above mean sea level in meters Includes geoid undulation if geoid is available | - | format (float) | - |
| undulation | number | Height difference between ellipsoid and geoid | - | format (float) | - |
| utcTimeStamp | string | UTC time formatted as ISO string | - | - | - |
| gpsTimeStamp | string | GPS time formatted as ISO string | - | - | - |
| satelliteView | array | 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 | - | - | - |
| sourceReferenceFrameName | string | Name of the source reference frame used for the GNSS. | - | - | - |
| sourceReferenceFrameEpoch | number | Epoch of the realization of the source reference frame. It’s the date at which the coordinates of the reference frame are exactly as given. | - | format (double) | - |
| targetReferenceFrameEpoch | number | Specific point in time that is used as a reference for the geodetic datum. | - | format (double) | - |
| targetReferenceFrameName | string | Name of the target reference frame used for the GNSS. | - | - | - |
| imuAlignmentStatus | integer | Current IMU alignment status 0: NotAvailable, IMU is not available 1: Unaligned, IMU is not aligned, start moving the receiver to align 2: Coarse, IMU is partially aligned, keep moving the receiver to complete alignment 3: Fine, IMU is fully aligned and ready for TIP measurement | - | - | - |
| isTIP | boolean | True if this is a Trimble TIP position | - | - | - |
| pitch | number | Pitch of the receiver body in degrees | - | format (double) | - |
| roll | number | Roll of the receiver body in degrees | - | format (double) | - |
| yaw | number | Yaw of the receiver body in degrees | - | format (double) | - |
| pitchPrecision | number | Precision of the pitch in degrees | - | format (double) | - |
| rollPrecision | number | Precision of the roll in degrees | - | format (double) | - |
| yawPrecision | number | Precision of the yaw in degrees | - | format (double) | - |
| igsAntenna | string | IGS antenna name | - | - | - |
| antennaHeight | number | Antenna height in meters, measured from the ground to the Antenna Reference Point (usually Bottom of antenna mount) | - | format (double) | - |
Examples of payload (generated)
{ "latitude": 0, "longitude": 0, "altitude": 0, "speed": 0, "bearing": 0, "geoidModel": "string", "hrms": 0, "vrms": 0, "satellites": 0, "totalSatInUse": 0, "totalSatInView": 0, "pdop": 0, "hdop": 0, "vdop": 0, "diffAge": 0, "diffStatus": 0, "diffID": "string", "receiverModel": "string", "mockProvider": "string", "appVersion": "string", "battery": 0, "mslHeight": 0, "undulation": 0, "utcTimeStamp": "string", "gpsTimeStamp": "string", "satelliteView": [ { "Id": 0, "Elv": 0, "Azm": 0, "Snr": 0, "Use": true, "Type": 0 } ], "subscriptionType": 0, "sourceReferenceFrameName": "string", "sourceReferenceFrameEpoch": 0, "targetReferenceFrameEpoch": 0, "targetReferenceFrameName": "string", "imuAlignmentStatus": 0, "isTIP": true, "pitch": 0, "roll": 0, "yaw": 0, "pitchPrecision": 0, "rollPrecision": 0, "yawPrecision": 0, "igsAntenna": "string", "antennaHeight": 0}PUB localhost:v1SocketPort Operation
The version 1 websocket sends v1 position information. This websocket is available to any application on the device.
Message PositionInfoMessage
The positionInfo message contains v1 position information.
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 | Battery percentage if the receiver has an internal battery | - | - | - |
| geoidModel | string | Geoid model used for height calculations | - | - | - |
| mslHeight | number | Height above mean sea level in meters Includes geoid undulation if geoid is available | - | format (float) | - |
| undulation | number | 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 | 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, "longitude": 0, "altitude": 0, "speed": 0, "bearing": 0, "accuracy": 0, "verticalAccuracyMeters": 0, "satellites": 0, "totalSatInView": 0, "pdop": 0, "hdop": 0, "vdop": 0, "diffAge": 0, "diffStatus": 0, "diffID": "string", "vrms": 0, "hrms": 0, "receiverModel": "string", "mockProvider": "string", "appVersion": "string", "battery": 0, "geoidModel": "string", "mslHeight": 0, "undulation": 0, "utcTime": 0, "gpsTimeStamp": "string", "utcTimeStamp": "string", "satelliteView": [ { "Id": 0, "Elv": 0, "Azm": 0, "Snr": 0, "Use": true, "Type": 0 } ], "subscriptionType": 0}