Added reference to assigned numbers for units #314

Author: nkolban

cpp_utils/BLE2904.cpp

@@ -25,27 +25,47 @@ BLE2904::BLE2904() : BLEDescriptor(BLEUUID((uint16_t) 0x2904)) {
 } // BLE2902
 
 
+/**
+ * @brief Set the description.
+ */
 void BLE2904::setDescription(uint16_t description) {
 	m_data.m_description = description;
 	setValue((uint8_t*)&m_data, sizeof(m_data));
 }
 
 
+/**
+ * @brief Set the exponent.
+ */
 void BLE2904::setExponent(int8_t exponent) {
 	m_data.m_exponent = exponent;
 	setValue((uint8_t*)&m_data, sizeof(m_data));
 } // setExponent
 
+
+/**
+ * @brief Set the format.
+ */
 void BLE2904::setFormat(uint8_t format) {
 	m_data.m_format = format;
 	setValue((uint8_t*)&m_data, sizeof(m_data));
 } // setFormat
 
+
+/**
+ * @brief Set the namespace.
+ */
 void BLE2904::setNamespace(uint8_t namespace_value) {
 	m_data.m_namespace = namespace_value;
 	setValue((uint8_t*)&m_data, sizeof(m_data));
 } // setNamespace
 
+
+/**
+ * @brief Set the units for this value.  It should be one of the encoded values defined here:
+ * https://www.bluetooth.com/specifications/assigned-numbers/units
+ * @param [in] uint The type of units of this characteristic as defined by assigned numbers.
+ */
 void BLE2904::setUnit(uint16_t unit) {
 	m_data.m_unit = unit;
 	setValue((uint8_t*)&m_data, sizeof(m_data));

cpp_utils/BLE2904.h

@@ -15,7 +15,7 @@
 struct BLE2904_Data {
 	uint8_t  m_format;
 	int8_t   m_exponent;
-	uint16_t m_unit;
+	uint16_t m_unit;      // See https://www.bluetooth.com/specifications/assigned-numbers/units
 	uint8_t  m_namespace;
 	uint16_t m_description;
 

cpp_utils/BLEUtils.cpp

@@ -1611,13 +1611,15 @@ void BLEUtils::dumpGattClientEvent(
 		// - esp_gatt_status_t status
 		// - uint16_t          conn_id
 		// - uint16_t          handle
+		// - uint16_t          offset
 		//
 		case ESP_GATTC_WRITE_CHAR_EVT: {
-			ESP_LOGD(LOG_TAG, "[status: %s, conn_id: %d, handle: %d 0x%.2x]",
+			ESP_LOGD(LOG_TAG, "[status: %s, conn_id: %d, handle: %d 0x%.2x, offset: %d]",
 				BLEUtils::gattStatusToString(evtParam->write.status).c_str(),
 				evtParam->write.conn_id,
 				evtParam->write.handle,
-				evtParam->write.handle
+				evtParam->write.handle,
+				evtParam->write.offset
 			);
 			break;
 		} // ESP_GATTC_WRITE_CHAR_EVT