The Water Linked Underwater GPS API

The Water Linked Underwater GPS API

Water Linked creates disruptive sensor technology, allowing divers and underwater vehicles to explore and communicate underwater more confidently.
Subscribe 
                  {
    "antenna_enabled": true,
    "channel": 13,
    "compass": "external",
    "environment": "openwater",
    "external_pps_enabled": false,
    "gps": "external",
    "imu_vehicle_enabled": true,
    "locator_type": "a1",
    "range_max_x": 50,
    "range_max_y": 50,
    "range_max_z": 50,
    "range_min_x": -50,
    "range_min_y": -50,
    "search_direction": 30,
    "search_radius": 150,
    "search_sector": 90,
    "speed_of_sound": 1475,
    "static_lat": 63.422,
    "static_lon": 10.424,
    "static_orientation": 42
}

Response example. If you want to see more check the documentation.

API for the Water Linked Underwater GPS. For more details:

Recommended approach for connecting to a Underwater GPS via the API is:

  • If "GET /api/" times out, the Underwater GPS is not running (on this IP address)
  • If "GET /api/" responds with 200 OK, check that the api version returned (e.g. "v1") is supported by the client (e.g. also supports "v1")
  • If the api version returned does not match what the client supports: give an error to the user and recommend upgrading (e.g. response is "v2" while client only supports "v1")
  • If "GET /api/" responds with 301 Moved permanently, "GET /api/v1/version" to check if the kit has a version earlier than 1.5
  • "GET /api/v1/version" will always respond with 200 OK on Underwater GPS earlier than 1.5 release

Configuration API is not considered stable and will potentially be changed