The Water Linked Underwater GPS API
API for the Water Linked Underwater GPS. For more details: http://www.waterlinked.com Recommended approach for connecting to a Underwater GPS via the API is:…
Maps & location#openapi#location
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API for the Water Linked Underwater GPS. For more details: http://www.waterlinked.com
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 returrned (eg "v1") is supported by the client (eg: also supports "v1").
- If the api version returned does not match what the client supports: give an error to the user and recommend upgrading. (Eg: 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 is not considered stable and will potentially be changed
Endpoints 38
about
- GETApiVersion about
/api/ - GETGet about
/api/v1/aboutGet about information - POSTFactoryReset about
/api/v1/about/factoryresetReset all settings on master electronics - GETLED about
/api/v1/about/ledFlash LED1 on master electronics - GETStatus about
/api/v1/about/statusGet current IMU and GPS status - GETTemperature about
/api/v1/about/temperatureGet board temperature
config
- GETGetAntennaConfig config
/api/v1/config/antennaGet Antenna configuration - PUTModifyAntennaConfig config
/api/v1/config/antennaModify Antenna configuration - GETGet config
/api/v1/config/genericGet generic configuration - PUTModify config
/api/v1/config/genericModify generic configuration - GETGetIP config
/api/v1/config/ipGet IP configuration - PUTModifyIP config
/api/v1/config/ipModify IP configuration - GETListReceiver config
/api/v1/config/receivers/(Re)Load current receiver settings and return them - GETShowReceiver config
/api/v1/config/receivers/:IDGet receiver configuration by id - PUTModifyReceiver config
/api/v1/config/receivers/:IDModify receiver configuration, does not apply the change until generic modify is called. Calling list will discard changes - GETGetWIFI config
/api/v1/config/wifiGet WIFI configuration - PUTModifyWIFI config
/api/v1/config/wifiModify WIFI configuration
external
- PUTSetDepth external
/api/v1/external/depthSet depth from external source. If Locator A1 is used, this is required to get a position - GETGetVehicleIMU external
/api/v1/external/imu[DEPRECATED]Get rotation and acceleration of vehicle Locator is mounted on which was previously set - PUTSetVehicleIMU external
/api/v1/external/imu[DEPRECATED]Set rotation and acceleration of vehicle Locator is mounted on. This is used to improve positioning of vehicle - PUTSetMaster external
/api/v1/external/masterSet current global position of master electronics from external source. Values are only used if GPS mode is set to use external GPS - GETGetOrientation external
/api/v1/external/orientationGet orientation of Vehicle/ROV/Locator set by SetOrientation - PUTSetOrientation external
/api/v1/external/orientationSet orientation/compass heading of Vehicle/ROV/Locator. This is used only for visualization in GUI
imu
- GETGet imu
/api/v1/imu/calibrateGet IMU status and orientation - POSTCalibrate imu
/api/v1/imu/calibrate[DEPRECATED]Start calibration - POSTResetGyro imu
/api/v1/imu/resetgyrosReset Gyro - POSTSetNorth imu
/api/v1/imu/setnorthSet north point
poi
- GETList poi
/api/v1/poi/List all points of interest - POSTCreate poi
/api/v1/poi/Create a new POI - GETShow poi
/api/v1/poi/:IDGet a POI - DELETEDelete poi
/api/v1/poi/:ID - PATCHUpdate poi
/api/v1/poi/:ID
position
- GETAcousticFiltered position
/api/v1/position/acoustic/filteredGet current Kalman filtered acoustic position relative to master acoustics. Expected update frequency: 4 Hz - GETAcousticRaw position
/api/v1/position/acoustic/rawGet current unfiltered acoustic position relative to master acoustics. Expected update frequency: 4 Hz - GETGet position
/api/v1/position/globalGet current global position of locator. Locator position is calculated from the current acoustic position and the global position of the master electronics.… - GETGetMaster position
/api/v1/position/masterGet current global position of master electronics. Expected update frequency: 1 Hz
status_report
- GETGet status_report
/api/v1/status_report/Get list of status reports from all status groups
warnings
- GETGet warnings
/api/v1/warnings/[DEPRECATED] Get current list of messages
API details
- Base URL
http://demo.waterlinked.com- Authentication
- None declared in the description
- Operations
- 38 operations on 27 pathsGET 22PUT 9POST 5PATCH 1DELETE 1
- Main resources
- config 11about 6external 6poi 5imu 4position 4status_report 1warnings 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the The Water Linked Underwater GPS API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the The Water Linked Underwater GPS API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “ApiVersion about” (GET /api/), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the The Water Linked Underwater GPS API?
API for the Water Linked Underwater GPS. For more details: http://www.waterlinked.com Recommended approach for connecting to a Underwater GPS via the API is:… It is listed under Maps & location and has 38 endpoints.
Who publishes the The Water Linked Underwater GPS API?
It is listed from Water Linked's public API description (an OpenAPI document), not published by Water Linked on Swastik Codes. Anyone who controls waterlinked.com can claim the profile by adding a DNS TXT record.
What is the base URL of the The Water Linked Underwater GPS API?
Requests go to http://demo.waterlinked.com. Endpoint paths are added to this base URL.
How do I authenticate with the The Water Linked Underwater GPS API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the The Water Linked Underwater GPS API have?
38 operations on 27 paths (22 GET, 9 PUT, 5 POST, 1 PATCH, 1 DELETE). The largest groups are config, about, external, poi.
Is forking the The Water Linked Underwater GPS API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.