The Jaia REST API provides a way to query and command a JaiaBot fleet via web URL endpoints. These endpoints are directly generated from the APIRequest Protobuf message for input and APIResponse for output (jaiabot/src/lib/messages/rest_api.proto). For information on units, look at the DCCL extensions in the source Protobuf files (generally jaiabot/src/lib/messages/jaia_dccl.proto). An APIResponse will not be returned for queries of text or binary files. The file contents will be the body of the response.
It accepts GET requests for the subset of requests that only have singular (non-repeated) non-recursive (no submessages) data. This is generally suitable for simple requests (e.g. STOP all bots, query status, etc) but not for more complicated MISSION_PLAN type commands.
It also accepts POST for all requests, using JSON (which is required for the more complicated messages).
The API has no key of its own. On a CloudHub it is reached through the authentication front end, which grants a client in the rest_api_read group the read-only actions (status, metadata, task_packets, missions) and one in rest_api_all everything under /jaia. Both are one-factor, so a password is enough for an unattended client; see "Coming from `api_key`" in src/web/rest_api/README.md.
There are 2 variants of the API:
- "simple" variant (e.g., https://fleet0.jaia.tech/jaia/v1/status/all) where the action and the target(s) are specified in the url and any data may be passed via GET arguments (subject to limitations mentioned above). This allows for easy testing as the entire request is contained within the URL. (The "simple" version can be used for POST requests as well. Here the POST data (if any) contains the "action" submessage contents. This option is not documented in detail below, but will follow a similar pattern to the "full" variant).
- "full" variant (e.g., https://fleet0.jaia.tech/jaia/v1) where the entire request is POSTed as a JSON formatted APIRequest Protobuf message.
Table of Contents
- REST API
- Simple variant (GET) formatting
- Full variant (POST) formatting
- Request Actions
- status (request)
- Simple API Syntax (GET) [status (request)]
- Full API Syntax (POST) [status (request)]
- JSON [Full API Syntax (POST) [status (request)]]
- Example [status (request)]
- Request JSON [Example [status (request)]]
- Response JSON [Example [status (request)]]
- metadata (request)
- Simple API Syntax (GET) [metadata (request)]
- Full API Syntax (POST) [metadata (request)]
- JSON [Full API Syntax (POST) [metadata (request)]]
- Example [metadata (request)]
- Request JSON [Example [metadata (request)]]
- Response JSON [Example [metadata (request)]]
- task_packets (request)
- Parameters [task_packets (request)]
- Simple API Syntax (GET) [task_packets (request)]
- Enumerations [Simple API Syntax (GET) [task_packets (request)]]
- Full API Syntax (POST) [task_packets (request)]
- JSON [Full API Syntax (POST) [task_packets (request)]]
- Enumerations [Full API Syntax (POST) [task_packets (request)]]
- Example [task_packets (request)]
- Request JSON [Example [task_packets (request)]]
- Response JSON [Example [task_packets (request)]]
- missions (request)
- Parameters [missions (request)]
- Simple API Syntax (GET) [missions (request)]
- Full API Syntax (POST) [missions (request)]
- JSON [Full API Syntax (POST) [missions (request)]]
- Example [missions (request)]
- Request JSON [Example [missions (request)]]
- Response JSON [Example [missions (request)]]
- command (request)
- Simple API Syntax (GET) [command (request)]
- Enumerations [Simple API Syntax (GET) [command (request)]]
- Full API Syntax (POST) [command (request)]
- JSON [Full API Syntax (POST) [command (request)]]
- Enumerations [Full API Syntax (POST) [command (request)]]
- Variant: command_data = plan [command (request)]
- JSON [Variant: command_data = plan [command (request)]]
- Enumerations [Variant: command_data = plan [command (request)]]
- Variant: command_data = rc [command (request)]
- JSON [Variant: command_data = rc [command (request)]]
- Enumerations [Variant: command_data = rc [command (request)]]
- Example [command (request)]
- Request JSON [Example [command (request)]]
- Response JSON [Example [command (request)]]
- command_for_hub (request)
- Simple API Syntax (GET) [command_for_hub (request)]
- Enumerations [Simple API Syntax (GET) [command_for_hub (request)]]
- Full API Syntax (POST) [command_for_hub (request)]
- JSON [Full API Syntax (POST) [command_for_hub (request)]]
- Enumerations [Full API Syntax (POST) [command_for_hub (request)]]
- Example [command_for_hub (request)]
- Request JSON [Example [command_for_hub (request)]]
- Response JSON [Example [command_for_hub (request)]]
- take_control (request)
- Full API Syntax (POST) [take_control (request)]
- JSON [Full API Syntax (POST) [take_control (request)]]
- Example [take_control (request)]
- Request JSON [Example [take_control (request)]]
- Response JSON [Example [take_control (request)]]
- engineering_command (request)
- Simple API Syntax (GET) [engineering_command (request)]
- Full API Syntax (POST) [engineering_command (request)]
- JSON [Full API Syntax (POST) [engineering_command (request)]]
- Example [engineering_command (request)]
- Request JSON [Example [engineering_command (request)]]
- Response JSON [Example [engineering_command (request)]]
- task_packet_include (request)
- Simple API Syntax (GET) [task_packet_include (request)]
- Full API Syntax (POST) [task_packet_include (request)]
- JSON [Full API Syntax (POST) [task_packet_include (request)]]
- Example [task_packet_include (request)]
- Request JSON [Example [task_packet_include (request)]]
- Response JSON [Example [task_packet_include (request)]]
- download_ctd_profiles (request)
- Simple API Syntax (GET) [download_ctd_profiles (request)]
- Full API Syntax (POST) [download_ctd_profiles (request)]
- JSON [Full API Syntax (POST) [download_ctd_profiles (request)]]
- Example [download_ctd_profiles (request)]
- Request JSON [Example [download_ctd_profiles (request)]]
- Response [Example [download_ctd_profiles (request)]]
- record_query (request)
- Simple API Syntax (GET) [record_query (request)]
- Enumerations [Simple API Syntax (GET) [record_query (request)]]
- Full API Syntax (POST) [record_query (request)]
- JSON [Full API Syntax (POST) [record_query (request)]]
- Enumerations [Full API Syntax (POST) [record_query (request)]]
- Example [record_query (request)]
- Request JSON [Example [record_query (request)]]
- Response JSON [Example [record_query (request)]]
- depth_contours (request)
- Simple API Syntax (GET) [depth_contours (request)]
- Full API Syntax (POST) [depth_contours (request)]
- JSON [Full API Syntax (POST) [depth_contours (request)]]
- Enumerations [Full API Syntax (POST) [depth_contours (request)]]
- Variant: vertical_data = dive [depth_contours (request)]
- JSON [Variant: vertical_data = dive [depth_contours (request)]]
- Enumerations [Variant: vertical_data = dive [depth_contours (request)]]
- Example [depth_contours (request)]
- Request JSON [Example [depth_contours (request)]]
- Response JSON [Example [depth_contours (request)]]
- engineering_status (request)
- Simple API Syntax (GET) [engineering_status (request)]
- Full API Syntax (POST) [engineering_status (request)]
- JSON [Full API Syntax (POST) [engineering_status (request)]]
- Example [engineering_status (request)]
- Request JSON [Example [engineering_status (request)]]
- Response JSON [Example [engineering_status (request)]]
- Response Actions
- error (response)
- Response Syntax [error (response)]
- JSON [Response Syntax [error (response)]]
- Enumerations [error (response)]
- status (response)
- Response Syntax [status (response)]
- JSON [Response Syntax [status (response)]]
- Enumerations [status (response)]
- metadata (response)
- Response Syntax [metadata (response)]
- JSON [Response Syntax [metadata (response)]]
- task_packets (response)
- Response Syntax [task_packets (response)]
- JSON [Response Syntax [task_packets (response)]]
- Enumerations [task_packets (response)]
- Variant: vertical_data = dive
- JSON [Variant: vertical_data = dive]
- Enumerations [task_packets (response)]
- missions (response)
- Response Syntax [missions (response)]
- JSON [Response Syntax [missions (response)]]
- command_result (response)
- Response Syntax [command_result (response)]
- JSON [Response Syntax [command_result (response)]]
- controlling_client_id (response)
- Response Syntax [controlling_client_id (response)]
- JSON [Response Syntax [controlling_client_id (response)]]
- task_packet_include_response (response)
- Response Syntax [task_packet_include_response (response)]
- JSON [Response Syntax [task_packet_include_response (response)]]
- record_query_response (response)
- Response Syntax [record_query_response (response)]
- JSON [Response Syntax [record_query_response (response)]]
- engineering_status (response)
- Response Syntax [engineering_status (response)]
- JSON [Response Syntax [engineering_status (response)]]
Simple variant (GET) formatting
The URL expected for the simple variant of the API is:
https://fleet<N>.jaia.tech/jaia/v1/<action>/<target>?var1=val1&var2=val2
Where:
- fleet<N> is the fleet to command
- <action> is one of the specified actions (below)
- <target> is the target bots and or hubs in the following format:
- 'all' for all known bots and the hub (if relevant)
- comma separated list of 'bN' and/or 'hN' where N is the bot/hub ID, e.g., 'b1,b2,b3' would target bots 1-3, or 'h1,b3' would target hub 1 and bot 3
- var1 and var2 are variables affecting the action (see action documentation below)
- val1 and val2 are the values for var1 and var2, respectively.
Full variant (POST) formatting
The URL expected for the full variant of the API is:
https://fleet<N>.jaia.tech/jaia/v1
All data are expected to be sent as a POST request using the JSON formatted version of the APIRequest message as the POST variable 'json'. For example, to request status from all the bots you would POST the following to the above URL, for example using Python to command Fleet0:
#!/usr/bin/env python3
import requests
jaia_request={"target": {"all": True}, "status": True}
res = requests.post(f'https://fleet0.jaia.tech/jaia/v1', json=jaia_request)
Key for placeholders:
- <STRING>: String field
- False: Boolean field
- {float_dummy}: Floating point field
- {max_int32}: Int32 field
- {max_uint32}: UInt32 field
- {max_int64}: Int64 field
- {max_uint64}: UInt64 field
See the action documentation below for more details.
Request Actions
status (request)
Query the status of bots/hubs. Expect a response of type 'status'.
Simple API Syntax (GET) [status (request)]
https://fleet<N>.jaia.tech/jaia/v1/status/<target>
Full API Syntax (POST) [status (request)]
JSON [Full API Syntax (POST) [status (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"status": true
}
Example [status (request)]
Request JSON [Example [status (request)]]
{
"status": true,
"target": {
"all": true
}
}
Response JSON [Example [status (request)]]
{
"request": {
"status": true,
"target": {
"all": true
}
},
"status": {
"bots": [
{
"attitude": {
"course_over_ground": 180.0,
"heading": 166.0,
"pitch": 85.0,
"roll": -57.0
},
"battery_percent": 95.0,
"bot_id": 1,
"bot_type": "HYDRO",
"calibration_status": 3,
"depth": 0.0,
"hdop": 0.25,
"health_state": "HEALTH__OK",
"location": {
"lat": 41.657645,
"lon": -71.27212
},
"mission_state": "PRE_DEPLOYMENT__IDLE",
"pdop": 2.07,
"received_time": "1722893284636801",
"salinity": 20.0,
"speed": {
"over_ground": 0.0
},
"temperature": 15.06,
"time": "1722878885000000",
"vcc_voltage": 24.0,
"wifi_link_quality_percentage": 100
},
{
"attitude": {
"course_over_ground": 180.0,
"heading": 166.0,
"pitch": 85.0,
"roll": -57.0
},
"battery_percent": 95.0,
"bot_id": 2,
"bot_type": "HYDRO",
"calibration_status": 3,
"depth": 0.0,
"hdop": 1.03,
"health_state": "HEALTH__OK",
"location": {
"lat": 41.65765,
"lon": -71.27212
},
"mission_state": "PRE_DEPLOYMENT__IDLE",
"pdop": 1.47,
"received_time": "1722893284635458",
"salinity": 20.0,
"speed": {
"over_ground": 0.0
},
"temperature": 15.04,
"time": "1722878885000000",
"vcc_voltage": 24.0,
"wifi_link_quality_percentage": 100
}
],
"hubs": [
{
"bot_ids_in_radio_file": [
1,
2
],
"fleet_id": 0,
"health_state": "HEALTH__OK",
"hub_id": 1,
"known_bot": [
{
"id": 1,
"last_status_time": "1722893284000000"
},
{
"id": 2,
"last_status_time": "1722893285000000"
}
],
"linux_hardware_status": {
"wifi": {
"is_connected": true,
"link_quality": 70,
"link_quality_percentage": 100,
"noise_level": 0,
"signal_level": 33
}
},
"location": {
"lat": 41.66268,
"lon": -71.273018
},
"received_time": "1722893284552504",
"time": "8614394422756020"
}
]
},
"target": {
"bots": [
1,
2
],
"hubs": [
1
]
}
}
metadata (request)
Query the metadata of the hub. Expect a response of type 'metadata'.
Simple API Syntax (GET) [metadata (request)]
https://fleet<N>.jaia.tech/jaia/v1/metadata/<target>
Full API Syntax (POST) [metadata (request)]
JSON [Full API Syntax (POST) [metadata (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"metadata": true
}
Example [metadata (request)]
Request JSON [Example [metadata (request)]]
{
"target": {
"all": true
},
"metadata": true
}
Response JSON [Example [metadata (request)]]
{
"metadata": {
"hubs": [
{
"goby_version": "3.1.5",
"intervehicle_api_version": 7,
"is_simulation": true,
"ivp_version": "19.8.1+svn9395-10~ubuntu20.04.1",
"jaiabot_image_build_date": "Thu Aug 15 16:20:53 UTC 2024",
"jaiabot_image_first_boot_date": "Thu Aug 15 13:50:13 UTC 2024",
"jaiabot_image_version": "1.12.0~beta2",
"jaiabot_version": {
"deb_release_branch": "1.y",
"deb_repository": "beta",
"major": "1",
"minor": "12",
"patch": "0~beta2"
},
"moos_version": "10.4.0",
"name": "hub2-fleet6",
"raspi_firmware_version": "1.20220331",
"xbee_node_id": "Not Available",
"xbee_serial_number": "Not Available"
},
{
"goby_version": "3.1.5",
"intervehicle_api_version": 7,
"is_simulation": true,
"ivp_version": "19.8.1+svn9395-10~ubuntu20.04.1",
"jaiabot_image_build_date": "Thu Aug 15 16:20:53 UTC 2024",
"jaiabot_image_first_boot_date": "Thu Aug 15 13:50:11 UTC 2024",
"jaiabot_image_version": "1.12.0~beta2",
"jaiabot_version": {
"deb_release_branch": "1.y",
"deb_repository": "beta",
"major": "1",
"minor": "12",
"patch": "0~beta2"
},
"moos_version": "10.4.0",
"name": "hub1-fleet6",
"raspi_firmware_version": "1.20220331",
"xbee_node_id": "Not Available",
"xbee_serial_number": "Not Available"
}
]
},
"request": {
"metadata": true,
"target": {
"all": true
}
},
"target": {
"hubs": [
2,
1
]
}
}
task_packets (request)
Query task packets from a given range of time. Expect a response of type 'task_packets'.
Parameters [task_packets (request)]
- start_time Start of time range as a Unix timestamp in microseconds. If not set, returns an open-ended search, starting from the earliest available data.
- end_time End of time range as a Unix timestamp in microseconds. If not set, returns an open-ended search, ending at the latest available data.
- mission_name If set, only return task packets associated with the given mission name(s).
- included_only Whether to only return included (non-excluded) task packets.
- excluded_only Whether to only return excluded task packets. Takes precedence over included_only.
- known_version The version from an earlier response to this same query. If the task packets haven't changed since, the response has no packets and 'unchanged' is set. Only used with the JSON format.
- limit Maximum number of task packets to return. When more match, the most recent are returned.
Simple API Syntax (GET) [task_packets (request)]
https://fleet<N>.jaia.tech/jaia/v1/task_packets/<target>?limit=<UINT32>&format=<ENUM Format>
Enumerations [Simple API Syntax (GET) [task_packets (request)]]
- <ENUM Format>: JSON, KMZ, CSV, GEOJSON_CONTOURS
Full API Syntax (POST) [task_packets (request)]
JSON [Full API Syntax (POST) [task_packets (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"task_packets": {
"included_only": true,
"excluded_only": true,
"limit": 4294967295,
"format": "<ENUM Format>"
}
}
Enumerations [Full API Syntax (POST) [task_packets (request)]]
- <ENUM Format>: JSON, KMZ, CSV, GEOJSON_CONTOURS
Example [task_packets (request)]
Request JSON [Example [task_packets (request)]]
{
"target": {
"bots": [
1
]
},
"task_packets": {
"start_time": 1722797666581176.0,
"end_time": 1722970466581176.0
}
}
Response JSON [Example [task_packets (request)]]
{
"request": {
"target": {
"bots": [
1
]
},
"task_packets": {
"end_time": "1722970466581176",
"start_time": "1722797666581176"
}
},
"task_packets": {
"packets": [
{
"bot_id": 1,
"drift": {
"drift_duration": 10,
"end_location": {
"lat": 41.658228,
"lon": -71.275736
},
"estimated_drift": {
"heading": 237.0,
"speed": 0.9
},
"significant_wave_height": 0.0,
"start_location": {
"lat": 41.658275,
"lon": -71.275645
}
},
"end_time": "1722895675000000",
"start_time": "1722895664000000",
"type": "SURFACE_DRIFT"
},
{
"bot_id": 1,
"drift": {
"drift_duration": 10,
"end_location": {
"lat": 41.65826,
"lon": -71.2757
},
"estimated_drift": {
"heading": 316.0,
"speed": 0.6
},
"significant_wave_height": 0.0,
"start_location": {
"lat": 41.658225,
"lon": -71.275651
}
},
"end_time": "1722896712000000",
"start_time": "1722896702000000",
"type": "SURFACE_DRIFT"
},
{
"bot_id": 1,
"drift": {
"drift_duration": 10,
"end_location": {
"lat": 41.659469,
"lon": -71.272064
},
"estimated_drift": {
"heading": 72.0,
"speed": 0.7
},
"significant_wave_height": 0.0,
"start_location": {
"lat": 41.659448,
"lon": -71.272146
}
},
"end_time": "1722896904000000",
"start_time": "1722896893000000",
"type": "SURFACE_DRIFT"
}
],
"version": 1593724481
}
}
missions (request)
Query missions from a given range of time. Expect a response of type 'missions'.
Parameters [missions (request)]
- start_time Start of time range as a Unix timestamp in microseconds. If not set, returns an open-ended search, starting from the earliest available data.
- end_time End of time range as a Unix timestamp in microseconds. If not set, returns an open-ended search, ending at the latest available data.
Simple API Syntax (GET) [missions (request)]
https://fleet<N>.jaia.tech/jaia/v1/missions/<target>
Full API Syntax (POST) [missions (request)]
JSON [Full API Syntax (POST) [missions (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
}
}
Example [missions (request)]
Request JSON [Example [missions (request)]]
{
"target": {
"all": true
},
"missions": {
"start_time": 1722797666581176.0,
"end_time": 1722970466581176.0
}
}
Response JSON [Example [missions (request)]]
{
"missions": {
"mission_summaries": [
{
"end_time": "1722896904000000",
"mission_name": "mission1",
"start_time": "1722895664000000",
"task_packet_count": 3
}
]
},
"request": {
"missions": {
"end_time": "1722970466581176",
"start_time": "1722797666581176"
},
"target": {
"all": true
}
},
"target": {
"hubs": [
1
],
"bots": [
1
]
}
}
command (request)
Send a command to one or more bots. Expect a response of type 'command_result'.
Simple API Syntax (GET) [command (request)]
https://fleet<N>.jaia.tech/jaia/v1/command/<target>?type=<ENUM CommandType>
Enumerations [Simple API Syntax (GET) [command (request)]]
- <ENUM CommandType>: MISSION_PLAN, ACTIVATE, START_MISSION, NEXT_TASK, RETURN_TO_HOME, STOP, PAUSE, RESUME, RECOVERED, SHUTDOWN
Full API Syntax (POST) [command (request)]
JSON [Full API Syntax (POST) [command (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"command": {
"type": "<ENUM CommandType>"
}
}
Enumerations [Full API Syntax (POST) [command (request)]]
- <ENUM CommandType>: MISSION_PLAN, ACTIVATE, START_MISSION, NEXT_TASK, RETURN_TO_HOME, STOP, PAUSE, RESUME, RECOVERED, SHUTDOWN
Variant: command_data = plan [command (request)]
Used with "command": { "type" : "MISSION_PLAN" }
JSON [Variant: command_data = plan [command (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"command": {
"type": "<ENUM CommandType>",
"plan": {
"start": "<ENUM MissionStart>",
"movement": "<ENUM MovementType>",
"goal": [
{
"location": {
"lat": 1.2345,
"lon": 1.2345
},
"task": {
"type": "<ENUM TaskType>",
"dive": {
"max_depth": 1.2345,
"depth_interval": 1.2345,
"hold_time": 1.2345,
"bottom_dive": true
},
"surface_drift": {
"drift_time": 2147483647
},
"constant_heading": {
"constant_heading": 1.2345,
"constant_heading_time": 2147483647,
"constant_heading_speed": 4294967295
},
"start_pam": true,
"station_keep": {
"station_keep_time": 2147483647
}
}
},
{
"location": {
"lat": 1.2345,
"lon": 1.2345
},
"task": {
"type": "<ENUM TaskType>",
"dive": {
"max_depth": 1.2345,
"depth_interval": 1.2345,
"hold_time": 1.2345,
"bottom_dive": true
},
"surface_drift": {
"drift_time": 2147483647
},
"constant_heading": {
"constant_heading": 1.2345,
"constant_heading_time": 2147483647,
"constant_heading_speed": 4294967295
},
"start_pam": true,
"station_keep": {
"station_keep_time": 2147483647
}
}
}
],
"recovery": {
"recover_at_final_goal": true,
"location": {
"lat": 1.2345,
"lon": 1.2345
}
},
"repeats": 4294967295,
"segments": [
{},
{}
]
}
}
}
Enumerations [Variant: command_data = plan [command (request)]]
- <ENUM CommandType>: MISSION_PLAN, ACTIVATE, START_MISSION, NEXT_TASK, RETURN_TO_HOME, STOP, PAUSE, RESUME, RECOVERED, SHUTDOWN
- <ENUM MissionStart>: START_IMMEDIATELY, START_ON_COMMAND
- <ENUM MovementType>: TRANSIT, REMOTE_CONTROL, TRAIL
- <ENUM TaskType>: NONE, DIVE, STATION_KEEP, SURFACE_DRIFT, CONSTANT_HEADING, STORM_AIR_DESCENT, STORM_CTD_PROFILE
Variant: command_data = rc [command (request)]
Used with "command": { "type" : "REMOTE_CONTROL_SETPOINT" }
JSON [Variant: command_data = rc [command (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"command": {
"type": "<ENUM CommandType>",
"rc": {
"duration": 2147483647,
"heading": 1.2345,
"speed": 1.2345
}
}
}
Enumerations [Variant: command_data = rc [command (request)]]
- <ENUM CommandType>: MISSION_PLAN, ACTIVATE, START_MISSION, NEXT_TASK, RETURN_TO_HOME, STOP, PAUSE, RESUME, RECOVERED, SHUTDOWN
Example [command (request)]
Request JSON [Example [command (request)]]
{
"target": {
"all": true
},
"command": {
"type": "STOP"
}
}
Response JSON [Example [command (request)]]
{
"command_result": {
"command_sent": true
},
"request": {
"command": {
"bot_id": 1,
"time": "1722895468966813",
"type": "STOP"
},
"target": {
"all": true
}
},
"target": {
"hubs": [
1
],
"bots": [
2,
1
]
}
}
command_for_hub (request)
Send a command to the hub. Expect a response of type 'command_result'.
Simple API Syntax (GET) [command_for_hub (request)]
https://fleet<N>.jaia.tech/jaia/v1/command_for_hub/<target>?type=<ENUM HubCommandType>
Enumerations [Simple API Syntax (GET) [command_for_hub (request)]]
- <ENUM HubCommandType>: SET_HUB_LOCATION
Full API Syntax (POST) [command_for_hub (request)]
JSON [Full API Syntax (POST) [command_for_hub (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"command_for_hub": {
"type": "<ENUM HubCommandType>",
"hub_location": {
"lat": 1.2345,
"lon": 1.2345
}
}
}
Enumerations [Full API Syntax (POST) [command_for_hub (request)]]
- <ENUM HubCommandType>: SET_HUB_LOCATION
Example [command_for_hub (request)]
Request JSON [Example [command_for_hub (request)]]
{
"target": {
"all": true
},
"command_for_hub": {
"type": "SET_HUB_LOCATION",
"hub_location": {
"lat": 41.7,
"lon": -70.3
}
}
}
Response JSON [Example [command_for_hub (request)]]
{
"command_result": {
"command_sent": true
},
"request": {
"command_for_hub": {
"hub_id": 1,
"hub_location": {
"lat": 41.7,
"lon": -70.3
},
"time": "1722895686821358",
"type": "SET_HUB_LOCATION"
},
"target": {
"all": true
}
},
"target": {
"hubs": [
1
]
}
}
take_control (request)
The client ID of the operator who wants to take control. Expect a response of type 'controlling_client_id'.
Full API Syntax (POST) [take_control (request)]
JSON [Full API Syntax (POST) [take_control (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"take_control": "<STRING>"
}
Example [take_control (request)]
Request JSON [Example [take_control (request)]]
{
"target": {
"all": true
},
"take_control": "6CaPKsnbVhkLzq3jNXpgSU"
}
Response JSON [Example [take_control (request)]]
{
"controlling_client_id": "6CaPKsnbVhkLzq3jNXpgSU",
"request": {
"target": {
"all": true
},
"take_control": "6CaPKsnbVhkLzq3jNXpgSU"
}
}
engineering_command (request)
Send an engineering command to bot(s). Expect a response of type 'command_result'.
Simple API Syntax (GET) [engineering_command (request)]
https://fleet<N>.jaia.tech/jaia/v1/engineering_command/<target>
Full API Syntax (POST) [engineering_command (request)]
JSON [Full API Syntax (POST) [engineering_command (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
}
}
Example [engineering_command (request)]
Request JSON [Example [engineering_command (request)]]
{
"target": {
"bots": [
1
]
},
"engineering_command": {
"bot_id": 1,
"query_engineering_status": true
}
}
Response JSON [Example [engineering_command (request)]]
{
"target": {
"hubs": [
1,
2
],
"bots": [
1
]
},
"command_result": {
"command_sent": true
},
"request": {
"target": {
"bots": [
1
]
},
"engineering_command": {
"bot_id": 1,
"time": "1722895468966813",
"query_engineering_status": true
}
}
}
task_packet_include (request)
Include or exclude a task packet. Expect a response of type 'task_packet_include_response'.
Simple API Syntax (GET) [task_packet_include (request)]
https://fleet<N>.jaia.tech/jaia/v1/task_packet_include/<target>?task_packet_id=<STRING>
Full API Syntax (POST) [task_packet_include (request)]
JSON [Full API Syntax (POST) [task_packet_include (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"task_packet_include": {
"task_packet_id": "<STRING>",
"include": true
}
}
Example [task_packet_include (request)]
Request JSON [Example [task_packet_include (request)]]
{
"target": {
"all": true
},
"task_packet_include": {
"task_packet_id": "1_1722895664",
"include": false
}
}
Response JSON [Example [task_packet_include (request)]]
{
"request": {
"target": {
"all": true
},
"task_packet_include": {
"task_packet_id": "1_1722895664",
"include": false
}
},
"task_packet_include_response": {
"success": true
}
}
download_ctd_profiles (request)
Download the CTD profiles not yet downloaded from the hub as a zip file rather than an APIResponse. Responds with 204 No Content when there are none.
Simple API Syntax (GET) [download_ctd_profiles (request)]
https://fleet<N>.jaia.tech/jaia/v1/download_ctd_profiles/<target>
Full API Syntax (POST) [download_ctd_profiles (request)]
JSON [Full API Syntax (POST) [download_ctd_profiles (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"download_ctd_profiles": true
}
Example [download_ctd_profiles (request)]
Request JSON [Example [download_ctd_profiles (request)]]
{
"target": {
"all": true
},
"download_ctd_profiles": true
}
Response [Example [download_ctd_profiles (request)]]
jaia-ctd.zip (application/zip) containing the not yet downloaded *.unb files from /var/log/jaiabot/bot_offload
record_query (request)
List, get, save or delete the exclusion zones and mission sets stored on the hub. Expect a response of type 'record_query_response'.
Simple API Syntax (GET) [record_query (request)]
https://fleet<N>.jaia.tech/jaia/v1/record_query/<target>?type=<ENUM RecordType>&get_name=<STRING>&delete_name=<STRING>&save_name=<STRING>&save_content=<STRING>
Enumerations [Simple API Syntax (GET) [record_query (request)]]
- <ENUM RecordType>: EXCLUSION_ZONE, MISSION_SET
Full API Syntax (POST) [record_query (request)]
JSON [Full API Syntax (POST) [record_query (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"record_query": {
"list": true,
"get_name": "<STRING>",
"delete_name": "<STRING>",
"save_name": "<STRING>",
"save_content": "<STRING>",
"type": "<ENUM RecordType>"
}
}
Enumerations [Full API Syntax (POST) [record_query (request)]]
- <ENUM RecordType>: EXCLUSION_ZONE, MISSION_SET
Example [record_query (request)]
Request JSON [Example [record_query (request)]]
{
"target": {
"all": true
},
"record_query": {
"type": "EXCLUSION_ZONE",
"list": true
}
}
Response JSON [Example [record_query (request)]]
{
"request": {
"target": {
"all": true
},
"record_query": {
"list": true,
"type": "EXCLUSION_ZONE"
}
},
"record_query_response": {
"names": [
"harbor-entrance",
"north-pier"
]
}
}
depth_contours (request)
Generate depth contours from the given task packets. Responds with GeoJSON rather than an APIResponse.
Simple API Syntax (GET) [depth_contours (request)]
https://fleet<N>.jaia.tech/jaia/v1/depth_contours/<target>
Full API Syntax (POST) [depth_contours (request)]
JSON [Full API Syntax (POST) [depth_contours (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"depth_contours": {
"packets": [
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
}
]
}
}
Enumerations [Full API Syntax (POST) [depth_contours (request)]]
- <ENUM TaskType>: NONE, DIVE, STATION_KEEP, SURFACE_DRIFT, CONSTANT_HEADING, STORM_AIR_DESCENT, STORM_CTD_PROFILE
Variant: vertical_data = dive [depth_contours (request)]
JSON [Variant: vertical_data = dive [depth_contours (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"depth_contours": {
"packets": [
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"dive": {
"dive_rate": 1.2345,
"unpowered_rise_rate": 1.2345,
"powered_rise_rate": 1.2345,
"depth_achieved": 1.2345,
"measurement": [
{
"mean_depth": 1.2345,
"mean_temperature": 1.2345,
"mean_salinity": 1.2345
},
{
"mean_depth": 1.2345,
"mean_temperature": 1.2345,
"mean_salinity": 1.2345
}
],
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"duration_to_acquire_gps": 1.2345,
"bottom_dive": true,
"reached_min_depth": true,
"bottom_type": "<ENUM BottomType>",
"max_acceleration": 1.2345,
"subsurface_current": {
"velocity": 1.2345,
"heading": 1.2345
}
},
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"dive": {
"dive_rate": 1.2345,
"unpowered_rise_rate": 1.2345,
"powered_rise_rate": 1.2345,
"depth_achieved": 1.2345,
"measurement": [
{
"mean_depth": 1.2345,
"mean_temperature": 1.2345,
"mean_salinity": 1.2345
},
{
"mean_depth": 1.2345,
"mean_temperature": 1.2345,
"mean_salinity": 1.2345
}
],
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"duration_to_acquire_gps": 1.2345,
"bottom_dive": true,
"reached_min_depth": true,
"bottom_type": "<ENUM BottomType>",
"max_acceleration": 1.2345,
"subsurface_current": {
"velocity": 1.2345,
"heading": 1.2345
}
},
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
}
]
}
}
Enumerations [Variant: vertical_data = dive [depth_contours (request)]]
- <ENUM TaskType>: NONE, DIVE, STATION_KEEP, SURFACE_DRIFT, CONSTANT_HEADING, STORM_AIR_DESCENT, STORM_CTD_PROFILE
- <ENUM BottomType>: HARD, SOFT
Example [depth_contours (request)]
Request JSON [Example [depth_contours (request)]]
{
"target": {
"all": true
},
"depth_contours": {
"packets": [
{
"bot_id": 1,
"start_time": "1722895664000000",
"end_time": "1722895700000000",
"type": "DIVE",
"dive": {
"bottom_dive": true,
"depth_achieved": 4.2,
"start_location": {
"lat": 41.658,
"lon": -71.276
},
"dive_rate": 0.5,
"duration_to_acquire_gps": 8.0
}
},
{
"bot_id": 1,
"start_time": "1722895724000000",
"end_time": "1722895760000000",
"type": "DIVE",
"dive": {
"bottom_dive": true,
"depth_achieved": 6.8,
"start_location": {
"lat": 41.6585,
"lon": -71.275
},
"dive_rate": 0.5,
"duration_to_acquire_gps": 8.0
}
},
{
"bot_id": 1,
"start_time": "1722895784000000",
"end_time": "1722895820000000",
"type": "DIVE",
"dive": {
"bottom_dive": true,
"depth_achieved": 9.5,
"start_location": {
"lat": 41.659,
"lon": -71.2762
},
"dive_rate": 0.5,
"duration_to_acquire_gps": 8.0
}
}
]
}
}
Response JSON [Example [depth_contours (request)]]
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"features": [
{
"type": "Feature",
"properties": {
"type": "depth-contour",
"value": 4.73,
"fill": "#c9ebb1",
"stroke-width": 0
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-71.276,
41.658
],
[
-71.27602,
41.6581
],
[
-71.275796,
41.658102
],
[
-71.276,
41.658
],
[
-71.276,
41.658
]
]
]
}
},
{
"type": "Feature",
"properties": {
"type": "depth-contour",
"value": 4.73,
"fill": "#c9ebb1",
"stroke-width": 0
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-71.27602,
41.6581
],
[
-71.27602,
41.6581
],
[
-71.275796,
41.658102
],
[
-71.275796,
41.658102
],
[
-71.27602,
41.6581
]
]
]
}
}
]
}
engineering_status (request)
Query the most recent engineering status of bots. Expect a response of type 'engineering_status'.
Simple API Syntax (GET) [engineering_status (request)]
https://fleet<N>.jaia.tech/jaia/v1/engineering_status/<target>
Full API Syntax (POST) [engineering_status (request)]
JSON [Full API Syntax (POST) [engineering_status (request)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
],
"all": false
},
"engineering_status": true
}
Example [engineering_status (request)]
Request JSON [Example [engineering_status (request)]]
{
"target": {
"bots": [
1
]
},
"engineering_status": true
}
Response JSON [Example [engineering_status (request)]]
{
"target": {
"bots": [
1
]
},
"request": {
"target": {
"bots": [
1
]
},
"engineering_status": true
},
"engineering_status": {
"bots": [
{
"bot_id": 1,
"time": "1722895470000000",
"pid_control": {
"speed": {
"Kp": 1.0,
"Ki": 0.0,
"Kd": 0.0
},
"heading": {
"Kp": 0.7,
"Ki": 0.0,
"Kd": 0.3
}
},
"bot_status_rate": "BotStatusRate_1_Hz",
"gps_requirements": {
"transit_hdop_req": 1.3,
"transit_pdop_req": 2.2,
"after_dive_hdop_req": 1.3,
"after_dive_pdop_req": 2.2,
"transit_gps_fix_checks": 5
},
"rf_disable_options": {
"rf_disable": false,
"rf_disable_timeout_mins": 10
}
}
]
}
}
Response Actions
error (response)
Error with API Request. This can be sent in response to any failed Request action.
Response Syntax [error (response)]
JSON [Response Syntax [error (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"error": {
"code": "<ENUM APIErrorCode>",
"details": "<STRING>"
},
"request": {
"copy of original request": "..."
}
}
Enumerations [error (response)]
- <ENUM APIErrorCode>: API_ERROR__UNSUPPORTED_API_VERSION, API_ERROR__INVALID_ACTION, API_ERROR__TARGETS_STRING_MALFORMATTED, API_ERROR__ACTION_REQUIRES_JSON_POST_DATA, API_ERROR__INVALID_TARGET, API_ERROR__COULD_NOT_PARSE_API_REQUEST_JSON, API_ERROR__REQUEST_NOT_INITIALIZED, API_ERROR__NO_ACTION_SPECIFIED, API_ERROR__INVALID_TYPE, API_ERROR__NOT_IN_CONTROL, API_ERROR__RECORD_NOT_FOUND, API_ERROR__INVALID_RECORD_NAME, API_ERROR__INTERNAL_ERROR
status (response)
Bot/Hub status. This is sent in response to a successful Request 'status' action.
Response Syntax [status (response)]
JSON [Response Syntax [status (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"status": {
"bots": [
{
"bot_id": 4294967295,
"time": "18446744073709551615",
"last_command_time": "18446744073709551615",
"health_state": "<ENUM HealthState>",
"error": [
"<ENUM Error>",
"<ENUM Error>"
],
"warning": [
"<ENUM Warning>",
"<ENUM Warning>"
],
"bot_type": "<ENUM BotType>",
"location": {
"lat": 1.2345,
"lon": 1.2345
},
"sensor_depth": 1.2345,
"depth": 1.2345,
"attitude": {
"roll": 1.2345,
"pitch": 1.2345,
"heading": 1.2345,
"course_over_ground": 1.2345
},
"speed": {
"over_ground": 1.2345
},
"mission_state": "<ENUM MissionState>",
"active_goal": 2147483647,
"distance_to_active_goal": 1.2345,
"active_goal_timeout": 4294967295,
"repeat_index": 2147483647,
"battery_percent": 1.2345,
"wifi_link_quality_percentage": 2147483647,
"received_time": "18446744073709551615",
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"time": "18446744073709551615",
"last_command_time": "18446744073709551615",
"health_state": "<ENUM HealthState>",
"error": [
"<ENUM Error>",
"<ENUM Error>"
],
"warning": [
"<ENUM Warning>",
"<ENUM Warning>"
],
"bot_type": "<ENUM BotType>",
"location": {
"lat": 1.2345,
"lon": 1.2345
},
"sensor_depth": 1.2345,
"depth": 1.2345,
"attitude": {
"roll": 1.2345,
"pitch": 1.2345,
"heading": 1.2345,
"course_over_ground": 1.2345
},
"speed": {
"over_ground": 1.2345
},
"mission_state": "<ENUM MissionState>",
"active_goal": 2147483647,
"distance_to_active_goal": 1.2345,
"active_goal_timeout": 4294967295,
"repeat_index": 2147483647,
"battery_percent": 1.2345,
"wifi_link_quality_percentage": 2147483647,
"received_time": "18446744073709551615",
"mission_command_time": "18446744073709551615"
}
],
"hubs": [
{
"hub_id": 4294967295,
"fleet_id": 4294967295,
"time": "18446744073709551615",
"health_state": "<ENUM HealthState>",
"error": [
"<ENUM Error>",
"<ENUM Error>"
],
"warning": [
"<ENUM Warning>",
"<ENUM Warning>"
],
"location": {
"lat": 1.2345,
"lon": 1.2345
},
"received_time": "18446744073709551615",
"known_bot": [
{
"id": 4294967295,
"last_status_time": "18446744073709551615"
},
{
"id": 4294967295,
"last_status_time": "18446744073709551615"
}
]
},
{
"hub_id": 4294967295,
"fleet_id": 4294967295,
"time": "18446744073709551615",
"health_state": "<ENUM HealthState>",
"error": [
"<ENUM Error>",
"<ENUM Error>"
],
"warning": [
"<ENUM Warning>",
"<ENUM Warning>"
],
"location": {
"lat": 1.2345,
"lon": 1.2345
},
"received_time": "18446744073709551615",
"known_bot": [
{
"id": 4294967295,
"last_status_time": "18446744073709551615"
},
{
"id": 4294967295,
"last_status_time": "18446744073709551615"
}
]
}
],
"time": "18446744073709551615"
},
"request": {
"copy of original request": "..."
}
}
Enumerations [status (response)]
- <ENUM HealthState>: HEALTH__OK, HEALTH__DEGRADED, HEALTH__FAILED
- <ENUM Error>: ERROR__TOO_MANY_ERRORS_TO_REPORT_ALL, ERROR__FAILED__UNKNOWN, ERROR__FAILED__GOBYD, ERROR__FAILED__GOBY_LIAISON, ERROR__FAILED__GOBY_GPS, ERROR__FAILED__GOBY_LOGGER, ERROR__FAILED__GOBY_CORONER, ERROR__FAILED__GOBY_MOOS_GATEWAY, ERROR__FAILED__JAIABOT_HEALTH, ERROR__FAILED__JAIABOT_METADATA, ERROR__FAILED__JAIABOT_HUB_MANAGER, ERROR__FAILED__JAIABOT_WEB_PORTAL, ERROR__FAILED__JAIABOT_FUSION, ERROR__FAILED__JAIABOT_MISSION_MANAGER, ERROR__FAILED__JAIABOT_PID_CONTROL, ERROR__FAILED__JAIABOT_BLUEROBOTICS_PRESSURE_SENSOR_DRIVER, ERROR__FAILED__JAIABOT_ATLAS_SCIENTIFIC_EZO_EC_DRIVER, ERROR__FAILED__JAIABOT_DRIVER_ARDUINO, ERROR__FAILED__JAIABOT_ENGINEERING, ERROR__FAILED__MOOS_MOOSDB, ERROR__FAILED__MOOS_PHELMIVP, ERROR__FAILED__MOOS_UPROCESSWATCH, ERROR__FAILED__MOOS_PNODEREPORTER, ERROR__FAILED__PYTHON_JAIABOT_WEB_APP, ERROR__FAILED__PYTHON_JAIABOT_IMU, ERROR__FAILED__PYTHON_JAIABOT_PRESSURE_SENSOR, ERROR__FAILED__PYTHON_JAIABOT_AS_EZO_EC, ERROR__FAILED__JAIABOT_LOG_CONVERTER, ERROR__FAILED__JAIABOT_DATA_VISION, ERROR__FAILED__JAIABOT_SIMULATOR, ERROR__FAILED__MOOS_SIM_MOOSDB, ERROR__FAILED__MOOS_SIM_USIMMARINE, ERROR__FAILED__GOBY_INTERVEHICLE_PORTAL, ERROR__FAILED__JAIABOT_PAM_DRIVER, ERROR__FAILED__PYTHON_JAIABOT_PAM, ERROR__FAILED__JAIABOT_TSYS01_TEMPERATURE_SENSOR_DRIVER, ERROR__FAILED__PYTHON_JAIABOT_TSYS01_TEMPERATURE_SENSOR_DRIVER, ERROR__FAILED__PYTHON_JAIABOT_MOTOR_LISTENER, ERROR__FAILED__JAIABOT_SENSORS, ERROR__FAILED__JAIABOT_COMMS_MANAGER, ERROR__FAILED__JAIABOT_CTD_MANAGER, ERROR__FAILED__JAIABOT_PPK, ERROR__NOT_RESPONDING__UNKNOWN_APP, ERROR__NOT_RESPONDING__GOBYD, ERROR__NOT_RESPONDING__GOBY_LIAISON, ERROR__NOT_RESPONDING__GOBY_GPS, ERROR__NOT_RESPONDING__GOBY_LOGGER, ERROR__NOT_RESPONDING__GOBY_CORONER, ERROR__NOT_RESPONDING__JAIABOT_HEALTH, ERROR__NOT_RESPONDING__JAIABOT_METADATA, ERROR__NOT_RESPONDING__JAIABOT_HUB_MANAGER, ERROR__NOT_RESPONDING__JAIABOT_WEB_PORTAL, ERROR__NOT_RESPONDING__JAIABOT_FUSION, ERROR__NOT_RESPONDING__GOBY_MOOS_GATEWAY, ERROR__NOT_RESPONDING__JAIABOT_MISSION_MANAGER, ERROR__NOT_RESPONDING__JAIABOT_PID_CONTROL, ERROR__NOT_RESPONDING__JAIABOT_BLUEROBOTICS_PRESSURE_SENSOR_DRIVER, ERROR__NOT_RESPONDING__JAIABOT_ATLAS_SCIENTIFIC_EZO_EC_DRIVER, ERROR__NOT_RESPONDING__JAIABOT_DRIVER_ARDUINO, ERROR__NOT_RESPONDING__JAIABOT_ENGINEERING, ERROR__NOT_RESPONDING__JAIABOT_SINGLE_THREAD_PATTERN, ERROR__NOT_RESPONDING__JAIABOT_MULTI_THREAD_PATTERN, ERROR__NOT_RESPONDING__JAIABOT_SIMULATOR, ERROR__NOT_RESPONDING__GOBY_INTERVEHICLE_PORTAL, ERROR__NOT_RESPONDING__JAIABOT_PAM_DRIVER, ERROR__NOT_RESPONDING__JAIABOT_TSYS01_TEMPERATURE_SENSOR_DRIVER, ERROR__NOT_RESPONDING__JAIABOT_DRIVER_CAMERA, ERROR__NOT_RESPONDING__JAIABOT_COMMS_MANAGER, ERROR__NOT_RESPONDING__JAIABOT_IMU, ERROR__NOT_RESPONDING__JAIABOT_TURNER_C_FLUOR_SENSOR_DRIVER, ERROR__NOT_RESPONDING__JAIABOT_AML_SENSOR_DRIVER, ERROR__NOT_RESPONDING__JAIABOT_CTD_MANAGER, ERROR__NOT_RESPONDING__JAIABOT_DRIVER_TSYS01, ERROR__NOT_RESPONDING__JAIABOT_DRIVER_SALINITY, ERROR__NOT_RESPONDING__JAIABOT_DRIVER_PRESSURE, ERROR__NOT_RESPONDING__JAIABOT_DRIVER_IMU, ERROR__NOT_RESPONDING__JAIABOT_DRIVER_PAM, ERROR__NOT_RESPONDING__JAIABOT_PPK_LOGGER, ERROR__NOT_RESPONDING__JAIABOT_IMU_TEST, ERROR__NOT_RESPONDING__JAIABOT_STORM_MANAGER, ERROR__MISSING_DATA__GPS_FIX, ERROR__MISSING_DATA__GPS_POSITION, ERROR__MISSING_DATA__PRESSURE, ERROR__MISSING_DATA__HEADING, ERROR__MISSING_DATA__SPEED, ERROR__MISSING_DATA__COURSE, ERROR__MISSING_DATA__CALIBRATION_SYS, ERROR__MISSING_DATA__CALIBRATION_GYRO, ERROR__MISSING_DATA__CALIBRATION_ACCEL, ERROR__MISSING_DATA__CALIBRATION_MAG, ERROR__NOT_CALIBRATED_SYS, ERROR__NOT_CALIBRATED_GYRO, ERROR__NOT_CALIBRATED_ACCEL, ERROR__NOT_CALIBRATED_MAG, ERROR__NOT_CALIBRATED_IMU, ERROR__MOOS__HELMIVP_STATE_NOT_DRIVE, ERROR__MOOS__HELMIVP_NO_DESIRED_DATA, ERROR__MOOS__NO_DATA, ERROR__SYSTEM__CANNOT_READ_MEMINFO, ERROR__SYSTEM__RAM_SPACE_CRITICAL, ERROR__SYSTEM__CANNOT_READ_SYSINFO, ERROR__SYSTEM__CPU_LOAD_FACTOR_CRITICAL, ERROR__SYSTEM__CANNOT_READ_DISK_USAGE, ERROR__SYSTEM__ROOTFS_DISK_SPACE_CRITICAL, ERROR__SYSTEM__DATA_DISK_SPACE_CRITICAL, ERROR__SYSTEM__CHRONY_SOURCES_QUERY_FAILED, ERROR__SYSTEM__CHRONY_TRACKING_QUERY_FAILED, ERROR__VEHICLE__VERY_LOW_BATTERY, ERROR__VEHICLE__CRITICALLY_LOW_BATTERY, ERROR__VEHICLE__MISSING_DATA_BATTERY, ERROR__VERSION__MISMATCH_ARDUINO, ERROR__MISSING_DATA__ARDUINO_REPORT, ERROR__VERSION__MISMATCH_INTERVEHICLE__UPGRADE_HUB, ERROR__VERSION__MISMATCH_INTERVEHICLE__UPGRADE_BOT, ERROR__ARDUINO_CONNECTION_FAILED, ERROR__VERSION__MISMATCH_INTERVEHICLE__UPGRADE_OTHER_HUB, ERROR__INIT_FAILED__BLUE_ROBOTICS__BAR30, ERROR__MISSING_DATA__BLUEROBOTICS_BAR30_DATA
- <ENUM Warning>: WARNING__TOO_MANY_WARNINGS_TO_REPORT_ALL, WARNING__NOT_RESPONDING__UNKNOWN_APP, WARNING__NOT_RESPONDING__JAIABOT_ATLAS_SCIENTIFIC_EZO_EC_DRIVER, WARNING__NOT_RESPONDING__JAIABOT_BLUEROBOTICS_PRESSURE_SENSOR_DRIVER, WARNING__NOT_RESPONDING__JAIABOT_ADAFRUIT_BNO055_DRIVER, WARNING__NOT_RESPONDING__JAIABOT_ADAFRUIT_BNO085_DRIVER, WARNING__NOT_RESPONDING__JAIABOT_PAM_DRIVER, WARNING__NOT_RESPONDING__JAIABOT_TSYS01_TEMPERATURE_SENSOR_DRIVER, WARNING__NOT_RESPONDING__JAIABOT_AML_SENSOR_DRIVER, WARNING__MISSING_DATA__PITCH, WARNING__MISSING_DATA__ROLL, WARNING__MISSING_DATA__TEMPERATURE, WARNING__MISSING_DATA__COURSE, WARNING__NOT_CALIBRATED_SYS, WARNING__IMU_ISSUE, WARNING__TEMPERATURE__ARDUINO_TOO_HIGH, WARNING__TEMPERATURE__LINUX_TOO_HIGH, WARNING__COMMS_LOW_SIGNAL_STRENGTH, WARNING__VEHICLE__LOW_BATTERY, WARNING__SYSTEM__CHRONY_NOT_SYNCHRONIZED, WARNING__SYSTEM__CHRONY_OFFSET_HIGH, WARNING__SYSTEM__CHRONY_STD_DEV_HIGH, WARNING__SYSTEM__RAM_SPACE_LOW, WARNING__SYSTEM__CPU_LOAD_FACTOR_HIGH, WARNING__SYSTEM__ROOTFS_DISK_SPACE_LOW, WARNING__SYSTEM__DATA_DISK_SPACE_LOW, WARNING__NOT_RESPONDING__JAIABOT_RPM_LISTENER, WARNING__NOT_RESPONDING__JAIABOT_ARDUINO_MOTOR_TEMP, WARNING__MISSION__INFEASIBLE_MISSION__TRANSIT_MUST_HAVE_A_GOAL, WARNING__MISSION__INFEASIBLE_MISSION__TRANSIT_CANNOT_RECOVER_AT_FINAL_GOAL_WITHOUT_A_GOAL, WARNING__MISSION__INFEASIBLE_MISSION__MUST_HAVE_RECOVERY_LOCATION_IF_NOT_RECOVERING_AT_FINAL_GOAL, WARNING__MISSION__INFEASIBLE_MISSION__MINIMUM_BOTTOM_DEPTH_REACHED, WARNING__MISSION__INFEASIBLE_MISSION__GOAL_DESIRED_DEPTH_EXCEEDED_MAX, WARNING__VEHICLE__NO_FORWARD_PROGRESS, WARNING__MISSION__DATA_OFFLOAD_FAILED, WARNING__MISSION__DATA__GPS_FIX_DEGRADED, WARNING__MISSION__DATA_PRE_OFFLOAD_FAILED, WARNING__MISSION__DATA_POST_OFFLOAD_FAILED, WARNING__INIT_FAILED__ATLAS_SCIENTIFIC__OEM_DO, WARNING__INIT_FAILED__ATLAS_SCIENTIFIC__OEM_EC, WARNING__INIT_FAILED__ATLAS_SCIENTIFIC__OEM_PH, WARNING__INIT_FAILED__TURNER__C_FLUOR, WARNING__MISSING_DATA__ATLAS_OEM_EC_DATA, WARNING__MISSING_DATA__ATLAS_OEM_PH_DATA, WARNING__MISSING_DATA__ATLAS_OEM_DO_DATA, WARNING__MISSING_DATA__TURNER_C_FLUOR_DATA, WARNING__MISSING_DATA__AML_DATA, WARNING__INIT_FAILED__AML, WARNING__INIT_FAILED__TSYS01, WARNING__MISSING_DATA__TSYS01_DATA
- <ENUM BotType>: HYDRO, PAM, BIO, STORM
- <ENUM MissionState>: PRE_DEPLOYMENT__STARTING_UP, PRE_DEPLOYMENT__IDLE, PRE_DEPLOYMENT__SELF_TEST, PRE_DEPLOYMENT__FAILED, PRE_DEPLOYMENT__WAIT_FOR_MISSION_PLAN, PRE_DEPLOYMENT__READY, IN_MISSION__UNDERWAY__REPLAN, IN_MISSION__UNDERWAY__MOVEMENT__TRANSIT, IN_MISSION__UNDERWAY__MOVEMENT__REMOTE_CONTROL__SETPOINT, IN_MISSION__UNDERWAY__MOVEMENT__REMOTE_CONTROL__STATION_KEEP, IN_MISSION__UNDERWAY__MOVEMENT__REMOTE_CONTROL__SURFACE_DRIFT, IN_MISSION__UNDERWAY__MOVEMENT__TRAIL, IN_MISSION__UNDERWAY__TASK__STATION_KEEP, IN_MISSION__UNDERWAY__TASK__SURFACE_DRIFT, IN_MISSION__UNDERWAY__TASK__DIVE__DIVE_PREP, IN_MISSION__UNDERWAY__TASK__DIVE__POWERED_DESCENT, IN_MISSION__UNDERWAY__TASK__DIVE__HOLD, IN_MISSION__UNDERWAY__TASK__DIVE__UNPOWERED_ASCENT, IN_MISSION__UNDERWAY__TASK__DIVE__POWERED_ASCENT, IN_MISSION__UNDERWAY__TASK__DIVE__REACQUIRE_GPS, IN_MISSION__UNDERWAY__TASK__DIVE__SURFACE_DRIFT, IN_MISSION__UNDERWAY__TASK__DIVE__CONSTANT_HEADING, IN_MISSION__UNDERWAY__TASK__CONSTANT_HEADING, IN_MISSION__UNDERWAY__RECOVERY__TRANSIT, IN_MISSION__UNDERWAY__RECOVERY__STATION_KEEP, IN_MISSION__UNDERWAY__RECOVERY__STOPPED, IN_MISSION__UNDERWAY__SLEEP__PREP, IN_MISSION__PAUSE__REACQUIRE_GPS, IN_MISSION__PAUSE__MANUAL, POST_DEPLOYMENT__RECOVERED, POST_DEPLOYMENT__DATA_OFFLOAD, POST_DEPLOYMENT__IDLE, POST_DEPLOYMENT__SHUTTING_DOWN, POST_DEPLOYMENT__FAILED
metadata (response)
Metadata response. This is sent in response to a successful Request 'metadata' action.
Response Syntax [metadata (response)]
JSON [Response Syntax [metadata (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"metadata": {
"hubs": [
{
"name": "<STRING>",
"jaiabot_version": {
"major": "<STRING>",
"minor": "<STRING>",
"patch": "<STRING>",
"git_hash": "<STRING>",
"git_branch": "<STRING>",
"deb_repository": "<STRING>",
"deb_release_branch": "<STRING>"
},
"goby_version": "<STRING>",
"moos_version": "<STRING>",
"ivp_version": "<STRING>",
"xbee_node_id": "<STRING>",
"xbee_serial_number": "<STRING>",
"raspi_firmware_version": "<STRING>",
"jaiabot_image_version": "<STRING>",
"jaiabot_image_build_date": "<STRING>",
"jaiabot_image_first_boot_date": "<STRING>",
"intervehicle_api_version": 4294967295,
"is_simulation": true,
"fleet_id": 4294967295,
"hub_id": 4294967295,
"simulation_warp": 4294967295,
"simulation_reference_time": "18446744073709551615",
"raspi_eeprom_version": "9223372036854775807"
},
{
"name": "<STRING>",
"jaiabot_version": {
"major": "<STRING>",
"minor": "<STRING>",
"patch": "<STRING>",
"git_hash": "<STRING>",
"git_branch": "<STRING>",
"deb_repository": "<STRING>",
"deb_release_branch": "<STRING>"
},
"goby_version": "<STRING>",
"moos_version": "<STRING>",
"ivp_version": "<STRING>",
"xbee_node_id": "<STRING>",
"xbee_serial_number": "<STRING>",
"raspi_firmware_version": "<STRING>",
"jaiabot_image_version": "<STRING>",
"jaiabot_image_build_date": "<STRING>",
"jaiabot_image_first_boot_date": "<STRING>",
"intervehicle_api_version": 4294967295,
"is_simulation": true,
"fleet_id": 4294967295,
"hub_id": 4294967295,
"simulation_warp": 4294967295,
"simulation_reference_time": "18446744073709551615",
"raspi_eeprom_version": "9223372036854775807"
}
]
},
"request": {
"copy of original request": "..."
}
}
task_packets (response)
Task packet response. This is sent in response to a successful Request 'task_packets' action.
Response Syntax [task_packets (response)]
JSON [Response Syntax [task_packets (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"task_packets": {
"packets": [
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
}
],
"version": 4294967295
},
"request": {
"copy of original request": "..."
}
}
Enumerations [task_packets (response)]
- <ENUM TaskType>: NONE, DIVE, STATION_KEEP, SURFACE_DRIFT, CONSTANT_HEADING, STORM_AIR_DESCENT, STORM_CTD_PROFILE
- <ENUM Format>: JSON, KMZ, CSV, GEOJSON_CONTOURS
Variant: vertical_data = dive
JSON [Variant: vertical_data = dive]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"task_packets": {
"packets": [
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"dive": {
"dive_rate": 1.2345,
"unpowered_rise_rate": 1.2345,
"powered_rise_rate": 1.2345,
"depth_achieved": 1.2345,
"measurement": [
{
"mean_depth": 1.2345,
"mean_temperature": 1.2345,
"mean_salinity": 1.2345
},
{
"mean_depth": 1.2345,
"mean_temperature": 1.2345,
"mean_salinity": 1.2345
}
],
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"duration_to_acquire_gps": 1.2345,
"bottom_dive": true,
"reached_min_depth": true,
"bottom_type": "<ENUM BottomType>",
"max_acceleration": 1.2345,
"subsurface_current": {
"velocity": 1.2345,
"heading": 1.2345
}
},
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
},
{
"bot_id": 4294967295,
"start_time": "18446744073709551615",
"end_time": "18446744073709551615",
"type": "<ENUM TaskType>",
"dive": {
"dive_rate": 1.2345,
"unpowered_rise_rate": 1.2345,
"powered_rise_rate": 1.2345,
"depth_achieved": 1.2345,
"measurement": [
{
"mean_depth": 1.2345,
"mean_temperature": 1.2345,
"mean_salinity": 1.2345
},
{
"mean_depth": 1.2345,
"mean_temperature": 1.2345,
"mean_salinity": 1.2345
}
],
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"duration_to_acquire_gps": 1.2345,
"bottom_dive": true,
"reached_min_depth": true,
"bottom_type": "<ENUM BottomType>",
"max_acceleration": 1.2345,
"subsurface_current": {
"velocity": 1.2345,
"heading": 1.2345
}
},
"drift": {
"drift_duration": 2147483647,
"estimated_drift": {
"speed": 1.2345,
"heading": 1.2345
},
"start_location": {
"lat": 1.2345,
"lon": 1.2345
},
"end_location": {
"lat": 1.2345,
"lon": 1.2345
},
"significant_wave_height": 1.2345
},
"mission_command_time": "18446744073709551615"
}
],
"version": 4294967295
},
"request": {
"copy of original request": "..."
}
}
Enumerations [task_packets (response)]
- <ENUM TaskType>: NONE, DIVE, STATION_KEEP, SURFACE_DRIFT, CONSTANT_HEADING, STORM_AIR_DESCENT, STORM_CTD_PROFILE
- <ENUM BottomType>: HARD, SOFT
- <ENUM Format>: JSON, KMZ, CSV, GEOJSON_CONTOURS
missions (response)
Mission query response. This is sent in response to a successful Request 'missions' action.
Response Syntax [missions (response)]
JSON [Response Syntax [missions (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"missions": {
"mission_summaries": [
{},
{}
]
},
"request": {
"copy of original request": "..."
}
}
command_result (response)
Command result. This is sent in response to a successful Request 'command', 'command_for_hub' or 'engineering_command' action.
Response Syntax [command_result (response)]
JSON [Response Syntax [command_result (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"command_result": {
"command_sent": true
},
"request": {
"copy of original request": "..."
}
}
controlling_client_id (response)
The client ID of the operator who has taken control.
Response Syntax [controlling_client_id (response)]
JSON [Response Syntax [controlling_client_id (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"controlling_client_id": "<STRING>",
"request": {
"copy of original request": "..."
}
}
task_packet_include_response (response)
Response to a task packet include/exclude request.
Response Syntax [task_packet_include_response (response)]
JSON [Response Syntax [task_packet_include_response (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"request": {
"copy of original request": "..."
},
"task_packet_include_response": {
"success": true
}
}
record_query_response (response)
Response related to exclusion zones and mission sets.
Response Syntax [record_query_response (response)]
JSON [Response Syntax [record_query_response (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"request": {
"copy of original request": "..."
},
"record_query_response": {
"names": [
"<STRING>",
"<STRING>"
],
"content": "<STRING>"
}
}
engineering_status (response)
Most recent engineering status of each bot. This is sent in response to a successful Request 'engineering_status' action.
Response Syntax [engineering_status (response)]
JSON [Response Syntax [engineering_status (response)]]
{
"target": {
"hubs": [
1
],
"bots": [
1,
2
]
},
"request": {
"copy of original request": "..."
},
"engineering_status": {
"bots": [
{},
{}
]
}
}