Statuses
This section will describe each status and its supported values. See the Query section for operations to query status values.
Status IDs
Battery Present (1)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the system’s internal battery present?
Internal Battery Bars (2)
ID | Option Name |
---|---|
0 | Zero |
1 | One |
2 | Two |
3 | Three |
4 | Charging |
Rough approximation of internal battery level in bars (or charging)
Overheating (6)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the system currently overheating?
Busy (8)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the camera busy?
Quick Capture (9)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is Quick Capture feature enabled?
Encoding (10)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the system currently encoding?
LCD Lock (11)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is LCD lock active?
Video Encoding Duration (13)
This is a integer value formatted as int32ub.
When encoding video, this is the duration (seconds) of the video so far; 0 otherwise
Wireless Connections Enabled (17)
ID | Option Name |
---|---|
0 | False |
1 | True |
Are Wireless Connections enabled?
Pairing State (19)
ID | Option Name |
---|---|
0 | Never Started |
1 | Started |
2 | Aborted |
3 | Cancelled |
4 | Completed |
Last Pairing Type (20)
ID | Option Name |
---|---|
0 | Not Pairing |
1 | Pairing App |
2 | Pairing Remote Control |
3 | Pairing Bluetooth Device |
The last type of pairing in which the camera was engaged
Last Pairing Success (21)
This is a integer value formatted as int32ub.
Time since boot (milliseconds) of last successful pairing complete action
Wifi Scan State (22)
ID | Option Name |
---|---|
0 | Never started |
1 | Started |
2 | Aborted |
3 | Canceled |
4 | Completed |
State of current scan for WiFi Access Points
Last Wifi Scan Success (23)
This is a integer value formatted as int8ub.
Time since boot (milliseconds) that the WiFi Access Point scan completed
Wifi Provisioning State (24)
ID | Option Name |
---|---|
0 | Never started |
1 | Started |
2 | Aborted |
3 | Canceled |
4 | Completed |
WiFi AP provisioning state
Remote Version (26)
This is a integer value formatted as int8ub.
Wireless remote control version
Remote Connected (27)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is a wireless remote control connected?
Pairing State (Legacy) (28)
This is a integer value formatted as unspecified.
Wireless Pairing State. Each bit contains state information (see WirelessPairingStateFlags)
AP SSID (29)
This is a string value.
SSID of the AP the camera is currently connected to when the camera is connected as a STA. When read via BLE, value is big-endian byte-encoded int32.
WiFi SSID (30)
This is a string value.
The camera’s WiFi SSID. On BLE connection, value is big-endian byte-encoded int32
Connected Devices (31)
This is a integer value formatted as int8ub.
The number of wireless devices connected to the camera
Preview Stream (32)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is Preview Stream enabled?
Primary Storage (33)
ID | Option Name |
---|---|
-1 | Unknown |
0 | OK |
1 | SD Card Full |
2 | SD Card Removed |
3 | SD Card Format Error |
4 | SD Card Busy |
8 | SD Card Swapped |
Remaining Photos (34)
This is a integer value formatted as int32ub.
How many photos can be taken with current settings before sdcard is full.
Alternatively, this is:
the remaining timelapse capability if Setting 128 is set to Timelapse Photo
the remaining nightlapse capability if Setting 128 is set to Nightlapse Photo
Remaining Video Time (35)
This is a integer value formatted as int32ub.
How many seconds of video can be captured with current settings before sdcard is full
Alternatively, this is:
the remaining timelapse capability if Setting 128 is set to Timelapse Video
the remaining nightlapse capability if Setting 128 is set to Nightlapse Video
Photos (38)
This is a integer value formatted as int32ub.
Total number of photos on sdcard
Videos (39)
This is a integer value formatted as int32ub.
Total number of videos on sdcard
OTA (41)
ID | Option Name |
---|---|
0 | Idle |
1 | Downloading |
2 | Verifying |
3 | Download Failed |
4 | Verify Failed |
5 | Ready |
6 | GoPro App Downloading |
7 | GoPro App Verifying |
8 | GoPro App Download Failed |
9 | GoPro App Verify Failed |
10 | GoPro App Ready |
The current status of Over The Air (OTA) update
Pending FW Update Cancel (42)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is there a pending request to cancel a firmware update download?
Locate (45)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is locate camera feature active?
Timelapse Interval Countdown (49)
This is a integer value formatted as int32ub.
The current timelapse interval countdown value (e.g. 5…4…3…2…1…)
SD Card Remaining (54)
This is a integer value formatted as int64ub.
Remaining space on the sdcard in Kilobytes
Preview Stream Available (55)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is preview stream supported in current recording/mode/secondary-stream?
Wifi Bars (56)
This is a integer value formatted as int8ub.
WiFi signal strength in bars
Active Hilights (58)
This is a integer value formatted as int8ub.
The number of hilights in currently-encoding video (value is set to 0 when encoding stops)
Time Since Last Hilight (59)
This is a integer value formatted as int32ub.
Time since boot (milliseconds) of most recent hilight in encoding video (set to 0 when encoding stops)
Minimum Status Poll Period (60)
This is a integer value formatted as int32ub.
The minimum time between camera status updates (milliseconds). Best practice is to not poll for status more often than this
Liveview Exposure Select Mode (65)
ID | Option Name |
---|---|
0 | Disabled |
1 | Auto |
2 | ISO Lock |
3 | Hemisphere |
Liveview Y (66)
This is a integer value formatted as int8ub.
Liveview Exposure Select: y-coordinate (percent)
Liveview X (67)
This is a integer value formatted as int8ub.
Liveview Exposure Select: y-coordinate (percent)
GPS Lock (68)
ID | Option Name |
---|---|
0 | False |
1 | True |
Does the camera currently have a GPS lock?
AP Mode (69)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is AP mode enabled?
Internal Battery Percentage (70)
This is a integer value formatted as int8ub.
Internal battery level as percentage
Microphone Accessory (74)
ID | Option Name |
---|---|
0 | Accessory not connected |
1 | Accessory connected |
2 | Accessory connected and a microphone is plugged into the accessory |
Zoom Level (75)
This is a integer value formatted as int8ub.
Digital Zoom level as percentage
Wireless Band (76)
ID | Option Name |
---|---|
0 | 2.4 GHz |
1 | 5 GHz |
Zoom Available (77)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is Digital Zoom feature available?
Mobile Friendly (78)
ID | Option Name |
---|---|
0 | False |
1 | True |
Are current video settings mobile friendly? (related to video compression and frame rate)
FTU (79)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the camera currently in First Time Use (FTU) UI flow?
5GHZ Available (81)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is 5GHz wireless band available?
Ready (82)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the system fully booted and ready to accept commands?
OTA Charged (83)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the internal battery charged sufficiently to start Over The Air (OTA) update?
Cold (85)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the camera getting too cold to continue recording?
Rotation (86)
ID | Option Name |
---|---|
0 | 0 degrees (upright) |
1 | 180 degrees (upside down) |
2 | 90 degrees (laying on right side) |
3 | 270 degrees (laying on left side) |
Rotational orientation of the camera
Zoom while Encoding (88)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is this camera model capable of zooming while encoding?
Flatmode (89)
This is a integer value formatted as unspecified.
Current Flatmode ID
Video Preset (93)
This is a integer value formatted as int32ub.
Current Video Preset (ID)
Photo Preset (94)
This is a integer value formatted as int32ub.
Current Photo Preset (ID)
Timelapse Preset (95)
This is a integer value formatted as int32ub.
Current Time Lapse Preset (ID)
Preset Group (96)
This is a integer value formatted as int32ub.
Current Preset Group (ID) (corresponds to ui_mode_groups in settings.json)
Preset (97)
This is a integer value formatted as int32ub.
Current Preset (ID)
Preset Modified (98)
This is a integer value formatted as int32ub.
Preset Modified Status, which contains an event ID and a Preset (Group) ID
Remaining Live Bursts (99)
This is a integer value formatted as int32ub.
The number of Live Bursts can be captured with current settings before sdcard is full
Live Bursts (100)
This is a integer value formatted as int32ub.
Total number of Live Bursts on sdcard
Capture Delay Active (101)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is Capture Delay currently active (i.e. counting down)?
Media Mod State (102)
ID | Option Name |
---|---|
0 | Microphone removed |
2 | Microphone only |
3 | Microphone with external microphone |
Time Warp Speed (103)
ID | Option Name |
---|---|
0 | 15x |
1 | 30x |
2 | 60x |
3 | 150x |
4 | 300x |
5 | 900x |
6 | 1800x |
7 | 2x |
8 | 5x |
9 | 10x |
10 | Auto |
11 | 1x (realtime) |
12 | 1/2x (slow-motion) |
Linux Core (104)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the system’s Linux core active?
Lens Type (105)
ID | Option Name |
---|---|
0 | Default |
1 | Max Lens |
2 | Max Lens 2.0 |
3 | Max Lens 2.5 |
4 | Macro Lens |
5 | Anamorphic Lens |
6 | Neutral Density 4 |
7 | Neutral Density 8 |
8 | Neutral Density 16 |
9 | Neutral Density 32 |
Camera lens type (reflects changes to lens settings such as 162, 189, 194, …)
Hindsight (106)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is Video Hindsight Capture Active?
Scheduled Capture Preset ID (107)
This is a integer value formatted as int32ub.
Scheduled Capture (108)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is Scheduled Capture set?
Display Mod Status (110)
ID | Option Name |
---|---|
0 | 000 = Display Mod: 0, HDMI: 0, Display Mod Connected: False |
1 | 001 = Display Mod: 0, HDMI: 0, Display Mod Connected: True |
2 | 010 = Display Mod: 0, HDMI: 1, Display Mod Connected: False |
3 | 011 = Display Mod: 0, HDMI: 1, Display Mod Connected: True |
4 | 100 = Display Mod: 1, HDMI: 0, Display Mod Connected: False |
5 | 101 = Display Mod: 1, HDMI: 0, Display Mod Connected: True |
6 | 110 = Display Mod: 1, HDMI: 1, Display Mod Connected: False |
7 | 111 = Display Mod: 1, HDMI: 1, Display Mod Connected: True |
Note that this is a bitmasked value.
SD Card Write Speed Error (111)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is there an SD Card minimum write speed error?
SD Card Errors (112)
This is a integer value formatted as int8ub.
Number of sdcard write speed errors since device booted
Turbo Transfer (113)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is Turbo Transfer active?
Camera Control ID (114)
ID | Option Name |
---|---|
0 | Camera Idle: No one is attempting to change camera settings |
1 | Camera Control: Camera is in a menu or changing settings. To intervene, app must request control |
2 | Camera External Control: An outside entity (app) has control and is in a menu or modifying settings |
Camera control status ID
USB Connected (115)
ID | Option Name |
---|---|
0 | False |
1 | True |
Is the camera connected to a PC via USB?
USB Controlled (116)
ID | Option Name |
---|---|
0 | Disabled |
1 | Enabled |
Camera control over USB state
SD Card Capacity (117)
This is a integer value formatted as int32ub.
Total SD card capacity in Kilobytes
Photo Interval Capture Count (118)
This is a integer value formatted as unspecified.