Access Point

The camera supports connecting to access points in Station Mode (STA). This is necessary for features such as Live Streaming where the camera needs an Internet connection. While in this mode, HTTP command and control of the camera is not available on some cameras.

Internet Access

Before Hero 13 Black, the camera could only connect to access points that did not require internet access. From Hero 13 Black onwards, it is possible to connect to a local network by setting the bypass_eula_check flag in the Connect to a New Access Point protobuf request.

Operations

Scan for Access Points

Type:: Protobuf

../_images/plantuml_ble_scan_for_ssids.png

Request

Start scanning for Access Points

Note

Serialization of this object is zero bytes.

Response: ResponseStartScanning are sent immediately after the camera receives this command

Notifications: NotifStartScanning are sent periodically as scanning state changes. Use to detect scan complete.

UUID:: Network Management Command
Feature ID:: 0x02
Action ID:: 0x02
Message:: RequestStartScan (docs) (source)

Response

The current scanning state.

This is the initial response to a RequestStartScan

UUID:: Network Management Response
Feature ID:: 0x02
Action ID:: 0x82
Message:: ResponseStartScanning (docs) (source)

Notification

Scanning state notification

Triggered via RequestStartScan

UUID:: Network Management Response
Feature ID:: 0x02
Action ID:: 0x0B
Message:: NotifStartScanning (docs) (source)

Get AP Scan Results

Type:: Protobuf

Request

Get a list of Access Points found during a RequestStartScan

Response: ResponseGetApEntries

UUID:: Network Management Command
Feature ID:: 0x02
Action ID:: 0x03
Message:: RequestGetApEntries (docs) (source)

Response

A list of scan entries describing a scanned Access Point

This is sent in response to a RequestGetApEntries

UUID:: Network Management Response
Feature ID:: 0x02
Action ID:: 0x83
Message:: ResponseGetApEntries (docs) (source)

Connect to Provisioned Access Point

Type:: Protobuf

Warning

This operation can only be used on an Access Point that has been previously configured. Therefore it is first necessary to Scan for Access Points, then Get AP Scan Results to ensure that the relevant Scan Entry has the SCAN_FLAG_CONFIGURED bit set.

Request

Connect to (but do not authenticate with) an Access Point

This is intended to be used to connect to a previously-connected Access Point

Response: ResponseConnect

Notification: NotifProvisioningState sent periodically as provisioning state changes

UUID:: Network Management Command
Feature ID:: 0x02
Action ID:: 0x04
Message:: RequestConnect (docs) (source)

Response

The status of an attempt to connect to an Access Point

Sent as the initial response to RequestConnect

UUID:: Network Management Response
Feature ID:: 0x02
Action ID:: 0x84
Message:: ResponseConnect (docs) (source)

Notification

Provision state notification

Sent during provisioning triggered via RequestConnect or RequestConnectNew

UUID:: Network Management Response
Feature ID:: 0x02
Action ID:: 0x0C
Message:: NotifProvisioningState (docs) (source)

Connect to a New Access Point

Type:: Protobuf

Warning

This operation can only be used on an Access Point that has not been previously configured. Therefore it is first necessary to Scan for Access Points, then Get AP Scan Results to ensure that the relevant Scan Entry does not have the SCAN_FLAG_CONFIGURED bit set.

../_images/plantuml_ble_connect_new_ap.png

Request

Connect to and authenticate with an Access Point

This is only intended to be used if the AP is not previously provisioned.

Response: ResponseConnectNew sent immediately

Notification: NotifProvisioningState sent periodically as provisioning state changes

UUID:: Network Management Command
Feature ID:: 0x02
Action ID:: 0x05
Message:: RequestConnectNew (docs) (source)

Response

The status of an attempt to connect to an Access Point

Sent as the initial response to RequestConnectNew

UUID:: Network Management Response
Feature ID:: 0x02
Action ID:: 0x85
Message:: ResponseConnectNew (docs) (source)

Notification

Provision state notification

Sent during provisioning triggered via RequestConnect or RequestConnectNew

UUID:: Network Management Response
Feature ID:: 0x02
Action ID:: 0x0C
Message:: NotifProvisioningState (docs) (source)

Disconnect from Access Point

To disconnect from a connected Access Point and return the camera to AP mode, use Set AP Control to set AP Control On, which disables Station Mode.

../_images/plantuml_ble_disconnect_ap.png