v1

latestSwagger 2.02026-07-13383652.9 KB

config

Modify config

Modify generic configuration

put/api/v1/config/generic

Request body

antenna_enabledboolean

Enable use of antenna

channelinteger required

Channel to use

compass'onboard' | 'static' | 'external' required

Compass provider setting

environment'reflective' | 'openwater'

[Deprecated] Environment setting

external_pps_enabledboolean

Enable external PPS input to master

gps'onboard' | 'static' | 'external' required

GPS provider setting

imu_vehicle_enabledboolean

[Deprecated] Enable IMU input from vehicle

locator_type'd1' | 'a1' | 's2' | 'p2' | 'u1' required

Locator type in use

range_max_xnumber

[Deprecated] Max range (meters)

range_max_ynumber

[Deprecated] Max range (meters)

range_max_znumber

[Deprecated] Max range (meters)

range_min_xnumber

[Deprecated] Max range (meters)

range_min_ynumber

[Deprecated] Max range (meters)

search_directionnumber

Direction of circular search area section

search_radiusnumber

Radius of circular search area

search_sectornumber

Sector angle of circular search area

speed_of_soundinteger

Speed of sound use by the system

static_latnumber required

Latitude to use in static mode

static_lonnumber required

Longitude to use in static mode

static_orientationnumber required

Orientation/compass reading to use in static mode (degrees)

Example request

{
  "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

OK