mesh: convenience iterator for element description list from Composite data received via MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA event

src/mesh/mesh_configuration_client.c

@@ -54,21 +54,88 @@
 #include "mesh/mesh_network.h"
 #include "mesh/mesh_upper_transport.h"
 
+#define MESH_VENDOR_MODEL_SIZE 4
+#define MESH_SIG_MODEL_SIZE    2
 
-static void mesh_configuration_client_send_acknowledged(uint16_t src, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, mesh_pdu_t *pdu, uint32_t ack_opcode){
+// Mesh Composition Data Element iterator
-    uint8_t  ttl  = mesh_foundation_default_ttl_get();
+
-    mesh_upper_transport_setup_access_pdu_header(pdu, netkey_index, appkey_index, ttl, src, dest, 0);
+uint16_t mesh_subevent_configuration_composition_data_get_num_elements(const uint8_t * event, uint16_t size){
-    mesh_access_send_acknowledged_pdu(pdu, mesh_access_acknowledged_message_retransmissions(), ack_opcode);
+    uint16_t pos = 16; 
+    uint16_t num_elements = 0;
+
+    while ((pos + 4) <= size){
+        // location descriptor
+        pos += 2;
+        uint8_t num_sig_model_ids = event[pos++];
+        uint8_t num_vendor_model_ids = event[pos++];
+        pos += (num_sig_model_ids + num_vendor_model_ids) * 2;
+        num_elements++;
+    }
+    return num_elements;
 }
 
-static uint8_t mesh_access_validate_envelop_params(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index){
+void mesh_composition_data_iterator_init(mesh_composite_data_iterator_t * it, const uint8_t * elements, uint16_t size){
-    btstack_assert(mesh_model != NULL);
+    it->elements = elements;
-    // TODO: validate other params
+    it->size = size;
-    UNUSED(dest);
+    it->offset = 16;
-    UNUSED(netkey_index);
+}
-    UNUSED(appkey_index);
 
-    return ERROR_CODE_SUCCESS;
+bool mesh_composition_data_iterator_has_next_element(mesh_composite_data_iterator_t * it){
+    uint16_t sig_model_list_size    = it->elements[it->offset + 2] * MESH_SIG_MODEL_SIZE;
+    uint16_t vendor_model_list_size = it->elements[it->offset + 3] * MESH_VENDOR_MODEL_SIZE;
+    uint16_t element_len =  2 + sig_model_list_size + vendor_model_list_size;
+
+    return (it->offset + element_len) <= it->size;
+}
+
+void mesh_composition_data_iterator_next_element(mesh_composite_data_iterator_t * it){
+    uint16_t sig_model_list_size    = it->elements[it->offset + 2] * MESH_SIG_MODEL_SIZE;
+    uint16_t vendor_model_list_size = it->elements[it->offset + 3] * MESH_VENDOR_MODEL_SIZE;
+    uint16_t element_len =  2 + sig_model_list_size + vendor_model_list_size;
+
+    it->sig_model_iterator.models = &it->elements[it->offset + 4];
+    it->sig_model_iterator.size = sig_model_list_size;
+    it->sig_model_iterator.offset = 0;
+    
+    it->vendor_model_iterator.models = &it->elements[it->offset + 4 + it->sig_model_iterator.size];
+    it->vendor_model_iterator.size = vendor_model_list_size;
+    it->vendor_model_iterator.offset = 0;
+
+    it->loc = little_endian_read_16(it->elements, it->offset);
+    it->offset += element_len;
+}
+
+uint16_t mesh_composition_data_iterator_element_loc(mesh_composite_data_iterator_t * it){
+    return it->loc;
+}
+
+bool mesh_composition_data_iterator_has_next_sig_model(mesh_composite_data_iterator_t * it){
+    return (it->sig_model_iterator.offset + MESH_SIG_MODEL_SIZE) <= it->sig_model_iterator.size;
+}
+
+void mesh_composition_data_iterator_next_sig_model(mesh_composite_data_iterator_t * it){
+    it->sig_model_iterator.id = little_endian_read_16(it->sig_model_iterator.models, it->sig_model_iterator.offset);
+    it->sig_model_iterator.offset += 2;
+}
+
+uint16_t mesh_composition_data_iterator_sig_model_id(mesh_composite_data_iterator_t * it){
+    return (uint16_t)it->sig_model_iterator.id;
+}
+
+bool mesh_composition_data_iterator_has_next_vendor_model(mesh_composite_data_iterator_t * it){
+    return (it->vendor_model_iterator.offset + MESH_VENDOR_MODEL_SIZE) <= it->vendor_model_iterator.size;
+}
+
+void mesh_composition_data_iterator_next_vendor_modeld(mesh_composite_data_iterator_t * it){
+    uint16_t vendor_id = little_endian_read_16(it->vendor_model_iterator.models, it->vendor_model_iterator.offset);
+    it->vendor_model_iterator.offset += 2;
+    uint16_t model_id = little_endian_read_16(it->vendor_model_iterator.models, it->vendor_model_iterator.offset);
+    it->vendor_model_iterator.offset += 2;
+    it->vendor_model_iterator.id = mesh_model_get_model_identifier(vendor_id, model_id);
+}
+
+uint32_t mesh_composition_data_iterator_vendor_model_id(mesh_composite_data_iterator_t * it){
+    return it->vendor_model_iterator.id;
 }
 
 // Configuration client messages
@@ -121,6 +188,23 @@ static const mesh_access_message_t mesh_configuration_client_publication_virtual
 };
 #endif
 
+
+static void mesh_configuration_client_send_acknowledged(uint16_t src, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, mesh_pdu_t *pdu, uint32_t ack_opcode){
+    uint8_t  ttl  = mesh_foundation_default_ttl_get();
+    mesh_upper_transport_setup_access_pdu_header(pdu, netkey_index, appkey_index, ttl, src, dest, 0);
+    mesh_access_send_acknowledged_pdu(pdu, mesh_access_acknowledged_message_retransmissions(), ack_opcode);
+}
+
+static uint8_t mesh_access_validate_envelop_params(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index){
+    btstack_assert(mesh_model != NULL);
+    // TODO: validate other params
+    UNUSED(dest);
+    UNUSED(netkey_index);
+    UNUSED(appkey_index);
+
+    return ERROR_CODE_SUCCESS;
+}
+
 uint8_t mesh_configuration_client_send_config_beacon_get(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index){
     uint8_t status = mesh_access_validate_envelop_params(mesh_model, dest, netkey_index, appkey_index);
     if (status != ERROR_CODE_SUCCESS) return status;
@@ -254,6 +338,27 @@ static void mesh_configuration_client_composition_data_status_handler(mesh_model
     mesh_access_message_processed(pdu);
 }
 
+uint8_t mesh_subevent_configuration_composition_data_get_cid(const uint8_t * event){
+    return little_endian_read_16(event, 1);
+}
+
+uint8_t mesh_subevent_configuration_composition_data_get_pid(const uint8_t * event){
+    return little_endian_read_16(event, 3);
+}
+
+uint8_t mesh_subevent_configuration_composition_data_get_vid(const uint8_t * event){
+    return little_endian_read_16(event, 5);
+}
+
+uint8_t mesh_subevent_configuration_composition_data_get_crpl(const uint8_t * event){
+    return little_endian_read_16(event, 7);
+}
+
+uint8_t mesh_subevent_configuration_composition_data_get_features(const uint8_t * event){
+    return little_endian_read_16(event, 9);
+}
+
+
 static inline void mesh_configuration_client_handle_uint8_value(mesh_model_t *mesh_model, mesh_pdu_t * pdu, uint8_t subevent_type){
     mesh_access_parser_state_t parser;
     mesh_access_parser_init(&parser, (mesh_pdu_t*) pdu);

src/mesh/mesh_configuration_client.h

@@ -47,6 +47,96 @@ extern "C"
 {
 #endif
 
+
+typedef struct {
+    const uint8_t * models;
+    uint16_t size;
+    uint16_t offset;
+
+    uint32_t id;
+} mesh_model_id_iterator_t;
+
+typedef struct {
+    const uint8_t * elements;
+    uint16_t size;
+    uint16_t offset;
+
+    uint16_t loc;
+
+    mesh_model_id_iterator_t sig_model_iterator;
+    mesh_model_id_iterator_t vendor_model_iterator;
+} mesh_composite_data_iterator_t;
+
+
+/**
+ * @brief Initialize iterator for element descriptions list from Composition data in MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA event
+ * @param iterator
+ * @param elements
+ * @param size
+ */
+void mesh_composition_data_iterator_init(mesh_composite_data_iterator_t * iterator, const uint8_t * elements, uint16_t size);
+
+/**
+ * @brief Check if there is another element description in the list
+ * @param iterator
+ * @return has_next_element  
+ */
+bool mesh_composition_data_iterator_has_next_element(mesh_composite_data_iterator_t * iterator);
+
+/**
+ * @brief Select the next element 
+ * @param iterator
+ */
+void mesh_composition_data_iterator_next_element(mesh_composite_data_iterator_t * iterator);
+
+/**
+ * @brief Get the element location descriptor for the current element
+ * @param iterator
+ * @return loc 
+ */
+uint16_t mesh_composition_data_iterator_element_loc(mesh_composite_data_iterator_t * iterator);
+
+/**
+ * @brief Check if there is another SIG model in current element
+ * @param iterator
+ * @return has_next_sig_model  
+ */
+bool mesh_composition_data_iterator_has_next_sig_model(mesh_composite_data_iterator_t * iterator);
+
+/**
+ * @brief Select the next SIG model
+ * @param iterator
+ */
+void mesh_composition_data_iterator_get_next_sig_model(mesh_composite_data_iterator_t * iterator);
+
+/**
+ * @brief Get the SIG model ID for the current SIG model of the current element
+ * @param iterator
+ * @return loc 
+ */
+uint16_t mesh_composition_data_iterator_sig_model_id(mesh_composite_data_iterator_t * iterator);
+
+
+/**
+ * @brief Check if there is another vendor model in current element
+ * @param iterator
+ * @return has_next_vendor_model  
+ */
+bool mesh_composition_data_iterator_has_next_vendor_model(mesh_composite_data_iterator_t * iterator);
+
+/**
+ * @brief Select the next VVendor model
+ * @param iterator
+ */
+void mesh_composition_data_iterator_next_vendor_modeld(mesh_composite_data_iterator_t * iterator);
+
+/**
+ * @brief Get the Vendor model ID for the current vendor model of the current element
+ * @param iterator
+ * @return loc 
+ */
+uint32_t mesh_composition_data_iterator_vendor_model_id(mesh_composite_data_iterator_t * iterator);
+
 /**
  * @brief Register packet handler
  * @param configuration_client_model
@@ -86,6 +176,36 @@ uint8_t mesh_configuration_client_send_beacon_set(mesh_model_t * mesh_model, uin
  */
 uint8_t mesh_configuration_client_send_composition_data_get(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, uint8_t page);
 
+/**
+ * @brief Get field cid from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
+ **/
+uint8_t mesh_subevent_configuration_composition_data_get_cid(const uint8_t * event);
+
+/**
+ * @brief Get field pid from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
+ **/
+uint8_t mesh_subevent_configuration_composition_data_get_pid(const uint8_t * event);
+
+/**
+ * @brief Get field vid from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
+ **/
+uint8_t mesh_subevent_configuration_composition_data_get_vid(const uint8_t * event);
+
+/**
+ * @brief Get field crpl from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
+ **/
+uint8_t mesh_subevent_configuration_composition_data_get_crpl(const uint8_t * event);
+
+/**
+ * @brief Get field features from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
+ **/
+uint8_t mesh_subevent_configuration_composition_data_get_features(const uint8_t * event);
+
+/**
+ * @brief Get number elements from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
+ **/
+uint16_t mesh_subevent_configuration_composition_data_get_num_elements(const uint8_t * event, uint16_t size);
+
 /**
  * @brief Get the current Default TTL state of a node
  * @param mesh_model