@@ -330,9 +330,9 @@ struct bt_gatt_service_val {
330
330
struct bt_gatt_include {
331
331
/** Service UUID. */
332
332
const struct bt_uuid * uuid ;
333
- /** Service start handle. */
333
+ /** Starting attribute handle for included service . */
334
334
uint16_t start_handle ;
335
- /** Service end handle. */
335
+ /** Ending attribute handle for included service . */
336
336
uint16_t end_handle ;
337
337
};
338
338
@@ -633,8 +633,8 @@ typedef uint8_t (*bt_gatt_attr_func_t)(const struct bt_gatt_attr *attr,
633
633
*
634
634
* Iterate attributes in the given range matching given UUID and/or data.
635
635
*
636
- * @param start_handle Start handle.
637
- * @param end_handle End handle.
636
+ * @param start_handle Starting attribute handle.
637
+ * @param end_handle Ending attribute handle.
638
638
* @param uuid UUID to match, passing NULL skips UUID matching.
639
639
* @param attr_data Attribute data to match, passing NULL skips data matching.
640
640
* @param num_matches Number matches, passing 0 makes it unlimited.
@@ -651,8 +651,8 @@ void bt_gatt_foreach_attr_type(uint16_t start_handle, uint16_t end_handle,
651
651
*
652
652
* Iterate attributes in the given range.
653
653
*
654
- * @param start_handle Start handle.
655
- * @param end_handle End handle.
654
+ * @param start_handle Starting attribute handle.
655
+ * @param end_handle Ending attribute handle.
656
656
* @param func Callback function.
657
657
* @param user_data Data to pass to the callback.
658
658
*/
@@ -1657,15 +1657,20 @@ struct bt_gatt_discover_params {
1657
1657
struct {
1658
1658
/** Include service attribute declaration handle */
1659
1659
uint16_t attr_handle ;
1660
- /** Included service start handle */
1660
+ /** Starting attribute handle for included service */
1661
1661
uint16_t start_handle ;
1662
- /** Included service end handle */
1662
+ /** Ending attribute handle for included service */
1663
1663
uint16_t end_handle ;
1664
1664
} _included ;
1665
- /** Discover start handle */
1665
+ /** Starting attribute handle to begin discovery */
1666
1666
uint16_t start_handle ;
1667
1667
};
1668
- /** Discover end handle */
1668
+ /** Ending attribute handle to stop discovery at
1669
+ *
1670
+ * @note When discovery begins this can be set to
1671
+ * @ref BT_ATT_LAST_ATTRIBUTE_HANDLE to discover all attributes
1672
+ * in the service.
1673
+ */
1669
1674
uint16_t end_handle ;
1670
1675
/** Discover type */
1671
1676
uint8_t type ;
@@ -1772,9 +1777,27 @@ struct bt_gatt_read_params {
1772
1777
bool variable ;
1773
1778
} multiple ;
1774
1779
struct {
1775
- /** First requested handle number. */
1780
+ /** @brief requested start attribute handle number.
1781
+ *
1782
+ * @details The starting handle is set to the starting point of the range
1783
+ * over which this read should be performed. For example, this could be
1784
+ * set to @ref BT_ATT_FIRST_ATTRIBUTE_HANDLE to set the starting point of
1785
+ * the range at the beginning of the GATT database, or to the starting
1786
+ * handle of a service after discovery.
1787
+ *
1788
+ * This value is also automatically incremented by the stack after
1789
+ * processing each matching handle-value pair returned by the server.
1790
+ */
1776
1791
uint16_t start_handle ;
1777
- /** Last requested handle number. */
1792
+ /** @brief requested end attribute handle number.
1793
+ *
1794
+ * @details The ending handle is set to the ending point of the range over
1795
+ * which this read should be performed. For example, this could be set to
1796
+ * @ref BT_ATT_LAST_ATTRIBUTE_HANDLE to set the ending point of the range
1797
+ * at the end of the GATT database, or to the end handle for service after
1798
+ * discovery, where the end_handle is available in the
1799
+ * @ref bt_gatt_service_val.
1800
+ */
1778
1801
uint16_t end_handle ;
1779
1802
/** 2 or 16 octet UUID. */
1780
1803
const struct bt_uuid * uuid ;
@@ -1789,7 +1812,7 @@ struct bt_gatt_read_params {
1789
1812
1790
1813
/** @brief Read Attribute Value by handle
1791
1814
*
1792
- * This procedure read the attribute value and return it to the callback.
1815
+ * This procedure reads the attribute value and returns it to the callback.
1793
1816
*
1794
1817
* When reading attributes by UUID the callback can be called multiple times
1795
1818
* depending on how many instances of given the UUID exists with the
0 commit comments