cwanda commented on a change in pull request #213: Updated bletiny docs and
added btshell docs
URL: https://github.com/apache/mynewt-site/pull/213#discussion_r128497307
##########
File path: docs/network/ble/btshell/btshell_GAP.md
##########
@@ -65,28 +65,109 @@ Several different modes and procedures may be performed
simultaneously over an L
| rpa_rnd | Resolvable private address, random static identity. | Not
available for all commands. |
| wl | Use white list; ignore peer_addr parameter. |
Only availble for "connect" command. |
-### Connection Parameters
+### Connection Types
-The Connection parameter definitions can be found in Section 7.8.12 of the
BLUETOOTH SPECIFICATION Version 4.2 [Vol 2, Part E].
+Bluetooth Specification Version 5.0 allows for different types of connections:
-| *Name* | *Description*
| *btshell string* |
+| *Description* | *bletiny ext parameter
value* |
+|------------------------------------------------|-------------------------------|
+| Legacy connection | none
|
+| Extended connection with 1M PHY | 1M
|
+| Extended connection with coded PHY | coded
|
+| Extended connection with both 1M and coded PHY | both
|
+| Extended connection with 1M, 2M and coded PHYs | all
|
+
+### Connection Parameters
+
+Connection parameter definitions can be found in Section 7.8.12 of the
BLUETOOTH SPECIFICATION Version 5.0 [Vol 2, Part E].
+
+Connection parameters for all types of connections:
+
+| *Name* | *Description*
| *bletiny string* |
+|-------------------|-------------------------------------------------------------------------------------|------------------|
+| Connection Type | Parameter indicating the type of connection
| extended |
+| Peer_Address_Type | Whether the peer is using a public or random address
(see Address types table). | peer_addr_type |
+| Peer_Address | The 6-byte device address of the peer; ignored if white
list is used | peer_addr |
+| Own_Address_Type | The type of address to use when initiating the
connection (see Address types table) | own_addr_type |
+| Duration | Number of milliseconds before aborting the connect
attempt | duration |
+
+Connection parameters for legacy and 1M PHY extended connection:
+
+| *Name* | *Description*
| *bletiny string* |
|---------------------|---------------------------------------------------------------------------------------------------------|--------------------|
| LE_Scan_Interval | Recommendation from the Host on how long the
Controller should scan | scan_interval
|
| LE_Scan_Window | Recommendation from the Host on how frequently the
Controller should scan | scan_window |
-| Peer_Address_Type | Whether the peer is using a public or random address
(see Address types table). | peer_addr_type |
-| Peer_Address | The 6-byte device address of the peer; ignored if
white list is used | peer_addr |
-| Own_Address_Type | The type of address to use when initiating the
connection (see Address types table) | own_addr_type |
| Conn_Interval_Min | Defines minimum allowed connection interval
| interval_min |
| Conn_Interval_Max | Defines maximum allowed connection interval
| interval_max |
| Conn_Latency | Defines the maximum allowed connection latency
| latency |
| Supervision_Timeout | Link supervision timeout for the connection.
| timeout |
| Minimum_CE_Length | Informative parameter providing the Controller with
the expected minimum length of the connection event | min_conn_event_len |
| Maximum_CE_Length | Informative parameter providing the Controller with
the expected maximum length of the connection event | max_conn_event_len |
-| Duration | Number of milliseconds before aborting the connect
attempt | duration |
+
+Extended Connection parameters for coded PHY connection:
+
+| *Name* | *Description*
| *bletiny string* |
+|---------------------|---------------------------------------------------------------------------------------------------------|--------------------------|
+| LE_Scan_Interval | Recommendation from the Host on how long the
Controller should scan |
coded_scan_interval |
+| LE_Scan_Window | Recommendation from the Host on how frequently the
Controller should scan | coded_scan_window
|
+| Conn_Interval_Min | Defines minimum allowed connection interval
| coded_interval_min |
+| Conn_Interval_Max | Defines maximum allowed connection interval
| coded_interval_max |
+| Conn_Latency | Defines the maximum allowed connection latency
| coded_latency |
+| Supervision_Timeout | Link supervision timeout for the connection.
| coded_timeout |
+| Minimum_CE_Length | Informative parameter providing the Controller with
the expected minimum length of the connection event | coded_min_conn_event_len |
+| Maximum_CE_Length | Informative parameter providing the Controller with
the expected maximum length of the connection event | coded_max_conn_event_len |
+
+Extended Connection parameters for 2M PHY connection:
+
+| *Name* | *Description*
| *bletiny string* |
+|---------------------|---------------------------------------------------------------------------------------------------------|-----------------------|
+| Conn_Interval_Min | Defines minimum allowed connection interval
| 2M_interval_min |
+| Conn_Interval_Max | Defines maximum allowed connection interval
| 2M_interval_max |
+| Conn_Latency | Defines the maximum allowed connection latency
| 2M_latency |
+| Supervision_Timeout | Link supervision timeout for the connection.
| 2M_timeout |
+| Minimum_CE_Length | Informative parameter providing the Controller with
the expected minimum length of the connection event | 2M_min_conn_event_len |
+| Maximum_CE_Length | Informative parameter providing the Controller with
the expected maximum length of the connection event | 2M_max_conn_event_len |
+
+### Scan Types
+
+Bluetooth Specification Version 5.0 allows for different types of scan:
+
+| *Description* | *bletiny ext parameter value* |
Review comment:
Change "**bletiny** ext parameter value" -> btshell
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
