Query
This section describes operations to query various GoPro state / information.
Operations​
Get Camera Capabilities​
Get camera capabilities from the camera.
Loading...Loading...Get CSI Value​
Get the value of a specific CSI (Camera State Integration) key stored on the camera.
Loading...Loading...Get Date Time​
Get the current date and time (without daylight savings times and timezone information).
Request (ID: 0x0E, UUID: Command)
Response (UUID: Command Response)
| Parameter | Type | Description |
|---|---|---|
| response_length | uint8 | length of response payload |
| year | uint16 | year |
| month | uint8 | month from 1 - 12 |
| day | uint8 | day from 1 - 31 |
| hour | uint8 | hour from 0 - 23 |
| minute | uint8 | minute from 0 - 59 |
| second | uint8 | second from 0 - 59 |
| weekday | uint8 | Sunday = 0, Saturday = 6 |
Get Hardware Info​
Get information about the camera and firmware.
Note that the model numbers are found under Supported Cameras.
Request (ID: 0x3C, UUID: Command)
Response (UUID: Command Response)
| Parameter | Type | Description |
|---|---|---|
| model_number_length | uint8 | length of model_number parameter |
| model_number | unsigned model_number_length | model number. See note above. |
| model_name_length | uint8 | length of model_name parameter |
| model_name | string of length model_name_length | i.e. "HERO12 Black" |
| deprecated_length | uint8 | length of deprecated parameter |
| deprecated | unsigned deprecated_length | deprecated |
| firmware_version_length | uint8 | length of firmware_version parameter |
| firmware_version | string of length firmware_version_length | "H23.01.01.99.56" |
| serial_number_length | uint8 | length of serial_number parameter |
| serial_number | string of length serial_number_length | i.e. "C1234567812345" |
| ap_ssid_length | uint8 | length of ap_ssid parameter |
| ap_ssid | string of length ap_ssid_length | i.e. "GP12345678" |
| ap_mac_address_length | uint8 | length of ap_mac_address parameter |
| ap_mac_address | string of length ap_mac_address_length | i.e. "2674f7f65f78" |
| reserved | 11 bytes | reserved data not part of the payload |
Get Last Captured Media​
Get the last captured media file.
Loading...Loading...Get Local Date Time​
Get the current date and time with daylight savings and timezone information.
Request (ID: 0x10, UUID: Command)
Response (UUID: Command Response)
| Parameter | Type | Description |
|---|---|---|
| response_length | uint8 | length of response payload |
| year | uint16 | year |
| month | uint8 | month from 1 - 12 |
| day | uint8 | day from 1 - 31 |
| hour | uint8 | hour from 0 - 23 |
| minute | uint8 | minute from 0 - 59 |
| second | uint8 | second from 0 - 59 |
| offset | int16 | UTC offset in minutes |
| is_dst | uint8 | Is daylight savings? 1 if yes, 0 if no |
Get Open GoPro Version​
Get the current version of the Open GoPro API.
Request (ID: 0x51, UUID: Command)
Response (UUID: Command Response)
| Parameter | Type | Description |
|---|---|---|
| major_length | uint8 | length of major parameter |
| major | unsigned major_length bytes | major part of version number |
| minor_length | uint8 | length of minor parameter |
| minor | unsigned minor_length bytes | minor part of version number |
Get OTA Status​
Get the current OTA update status and optionally register or unregister OTA status notifications.
The protobuf source marks this command as deprecated and notes that it was implemented in WSDK but never used by the app.
Get Setting Capabilities​
Get one or more setting value capabilities. The reported capabilities are only those setting options that are currently supported.
If the element ID array is empty, all settings will be queried.
Request (ID: 0x32, UUID: Query)
The element ID array is an array of uint8 Setting IDs to query.
Response (ID: 0x32, UUID: Query Response)
The fields of the results array are:
- ID: Setting ID
- value: Setting value defined via the individual Setting documentation
Get Setting Values​
Get the current value associated with one or more settings.
If the element ID array is empty, all settings will be queried.
Request (ID: 0x12, UUID: Query)
The element ID array is an array of uint8 Setting IDs to query.
Response (ID: 0x12, UUID: Query Response)
The fields of the results array are:
- ID: Setting ID
- value: Setting value defined via the individual Setting documentation
Get Status Values​
Get the current value of one or more camera statuses.
If the element ID array is empty, all statuses will be queried.
Request (ID: 0x13, UUID: Query)
The element ID array is an array of uint8 Status IDs to query.
Response (ID: 0x13, UUID: Query Response)
The fields of the results array are:
- ID: Status ID
- value: Status value defined via the individual Status documentation
Register for Setting Capability Updates​
Register to receive updates when one or more setting capabilities change. The initial response contains the current setting capabilities. Notifications will be sent whenever one of the requested settings' capabilities change.
If the element ID array is empty, all settings will be registered for.
Request (ID: 0x62, UUID: Query)
The element ID array is an array of uint8 Setting IDs to register for.
Response (ID: 0x62, UUID: Query Response)
The fields of the results array are:
- ID: Setting ID
- value: Setting value defined via the individual Setting documentation
Notification (ID: 0xA2, UUID: Query Response)
The fields of the results array are:
- ID: Setting ID
- value: Setting value defined via the individual Setting documentation
Register for Setting Value Updates​
Register to receive updates when one or more setting values change. The initial response contains the current setting values. Notifications will be sent whenever one of the requested setting's values change.
If the element ID array is empty, all settings will be registered for.
Request (ID: 0x52, UUID: Query)
The element ID array is an array of uint8 Setting IDs to register for.
Response (ID: 0x52, UUID: Query Response)
The fields of the results array are:
- ID: Setting ID
- value: Setting value defined via the individual Setting documentation
Notification (ID: 0x92, UUID: Query Response)
The fields of the results array are:
- ID: Setting ID
- value: Setting value defined via the individual Setting documentation
Register for Status Value Updates​
Register to receive updates when one or more status values change. The initial response contains the current status values. Notifications will be sent whenever one of the requested statuses' values change.
If the element ID array is empty, all statuses will be registered for.
Request (ID: 0x53, UUID: Query)
The element ID array is an array of uint8 Status IDs to register for.
Response (ID: 0x53, UUID: Query Response)
The fields of the results array are:
- ID: Status ID
- value: Status value defined via the individual Status documentation
Notification (ID: 0x93, UUID: Query Response)
The fields of the results array are:
- ID: Status ID
- value: Status value defined via the individual Status documentation
Unregister for Setting Capability Updates​
Cancel ongoing setting capability updates.
If the element ID array is empty, all settings will be unregistered for.
Request (ID: 0x82, UUID: Query)
The element ID array is an array of uint8 Setting IDs to unregister for.
Response (ID: 0x82, UUID: Query Response)
Unregister for Setting Value Updates​
Cancel ongoing setting value updates.
If the element ID array is empty, all settings will be unregistered for.
Request (ID: 0x72, UUID: Query)
The element ID array is an array of uint8 Setting IDs to unregister for.
Response (ID: 0x72, UUID: Query Response)
Unregister for Status Value Updates​
Cancel ongoing status value updates.
If the element ID array is empty, all statuses will be unregistered for.
Request (ID: 0x73, UUID: Query)
The element ID array is an array of uint8 Status IDs to unregister for.
Response (ID: 0x73, UUID: Query Response)