Merge branch 'main' into task/thdubois/SWPROT-9430/update-get-node-nls-state

Author: rzr

.github/workflows/test.yml

@@ -35,6 +35,7 @@ jobs:
         uses: robinraju/[email protected]
         with:
           repository: 'Z-Wave-Alliance/z-wave-stack-binaries'
+          tag: 'v25.1.0-28-g7e0b50f'
           fileName: 'z-wave-stack-binaries-*-Linux.tar.gz'
           token: ${{ secrets.GH_ZWAVE_ACCESS_TOKEN }}
           latest: true

applications/zpc/components/network_monitor/src/network_monitor.cpp

@@ -716,49 +716,44 @@ static void
   network_initialized = true;
 }
 
-static void network_monitor_handle_event_network_ready(network_data *event_data)
+static void network_monitor_handle_event_network_ready(network_data const &event_data)
 {
   // Make sure that UNID / ZPC UNID are configured correctly.
-  zwave_unid_set_home_id(event_data->home_id);
-  zwave_unid_from_node_id(event_data->node_id, zpc_unid);
+  zwave_unid_set_home_id(event_data.home_id);
+  zwave_unid_from_node_id(event_data.node_id, zpc_unid);
 
   // Save our updated granted keys/KEX fail
   network_monitor_create_attribute_store_network_nodes(
-    event_data->granted_keys,
-    event_data->kex_fail_type);
+    event_data.granted_keys,
+    event_data.kex_fail_type);
 
   // Pause node resolution on any other network than ours in the Attribute Store.
   network_monitor_activate_network_resolution(true);
-
-  delete event_data;
 }
 
 static void network_monitor_handle_event_node_id_assigned(
-  node_id_assigned_event_data *event_data)
+  node_id_assigned_event_data const &event_data)
 {
   network_monitor_add_attribute_store_node(
-    event_data->node_id,
+    event_data.node_id,
     ZCL_NODE_STATE_NETWORK_STATUS_COMMISIONING_STARTED);
-  zwave_store_inclusion_protocol(event_data->node_id,
-                                 event_data->inclusion_protocol);
-
-  delete event_data;
+  zwave_store_inclusion_protocol(event_data.node_id,
+                                 event_data.inclusion_protocol);
 }
 
 static void
-  network_monitor_handle_event_node_added(node_added_event_data *event_data)
+  network_monitor_handle_event_node_added(node_added_event_data const &event_data)
 {
   // Attribute store node should already exist, but in case NODE_ID_ASSIGNED_EVENT
   // did not happen before this event, we ensure the node exists in the attribute store.
-  network_monitor_update_new_node_attribute_store(*event_data);
+  network_monitor_update_new_node_attribute_store(event_data);
 
-  zwave_store_inclusion_protocol(event_data->node_id,
-                                 event_data->inclusion_protocol);
+  zwave_store_inclusion_protocol(event_data.node_id,
+                                 event_data.inclusion_protocol);
 
   // Finally we want to update our local cache of the node list:
   zwave_network_management_get_network_node_list(current_node_list);
   // TODO: Add timeout system to detect node interview failed
-  delete event_data;
 }
 
 static void network_monitor_handle_event_node_interview_initiated(
@@ -1088,18 +1083,33 @@ PROCESS_THREAD(network_monitor_process, ev, data)
         break;
 
       case NETWORK_READY_EVENT:
-        network_monitor_handle_event_network_ready(
-          static_cast<network_data *>(data));
+        if (data) {
+          network_data const *event_data
+            = static_cast<network_data const *>(data);
+          data = NULL;
+          network_monitor_handle_event_network_ready(*event_data);
+          delete event_data;  //< Allocated by network_monitor_on_network_ready
+        };
         break;
 
       case NODE_ID_ASSIGNED_EVENT:
-        network_monitor_handle_event_node_id_assigned(
-          static_cast<node_id_assigned_event_data *>(data));
+        if (data) {
+          node_id_assigned_event_data const *event_data
+            = static_cast<node_id_assigned_event_data const *>(data);
+          data = NULL;
+          network_monitor_handle_event_node_id_assigned(*event_data);
+          delete event_data;  //< Allocated by network_monitor_on_node_id_assigned
+        };
         break;
 
       case NODE_ADDED_EVENT:
-        network_monitor_handle_event_node_added(
-          static_cast<node_added_event_data *>(data));
+        if (data) {
+          node_added_event_data const *event_data
+            = static_cast<node_added_event_data const *>(data);
+          data = NULL;
+          network_monitor_handle_event_node_added(*event_data);
+          delete event_data;  //< Allocated by network_monitor_on_node_added
+        };
         break;
 
       case NODE_INTERVIEW_INITIATED_EVENT:

applications/zpc/components/zwave_api/external/ext_transport_security.c

@@ -13,7 +13,7 @@ readme_debug.md
 ../../../applications/zpc/how_to_implement_zwave_command_classes.rst
 ../../../applications/zpc/how_to_write_uam_files_for_the_zpc.md
 ../../../applications/zpc/how_to_interact_with_clusters.rst
-../../../applications/zpc/doc/supported_command_classes.md
+../../../applications/zpc/doc/supported_command_classes.rst
 ```
 
 The [ZPC User Guide](../../../applications/zpc/readme_user.md) explains how to use and configure ZPC.
@@ -28,6 +28,6 @@ The guide [How to write UAM files for ZPC](../../../applications/zpc/how_to_writ
 
 The guide [How to interact with clusters](../../../applications/zpc/how_to_interact_with_clusters.rst) goes into detail about the implementation of Cluster in Unify.
 
-The guide [Supported Command Classes](../../../applications/zpc/doc/supported_command_classes.md) goes into detail about how the command class are implemented. This documents gives specifics about the attributes store and MQTT topics that can interact with the class.
+The guide [Supported Command Classes](../../../applications/zpc/doc/supported_command_classes.rst) goes into detail about how the command class are implemented. This documents gives specifics about the attributes store and MQTT topics that can interact with the class.
 
 The doxygen generated <a href="../../../doxygen_zpc/index.html">ZPC API</a>

applications/zpc/components/zwave_api/external/ext_transport_security.h

@@ -243,10 +243,31 @@ test: ${build_dir}
 
 check: test
 
+zwa_project?=z-wave-stack-binaries
+zwa_ver?=25.1.0-28-g7e0b50f
+zwa_rev?=v${zwa_ver}
+zwa_file?=${zwa_project}-${zwa_ver}-Linux.tar.gz
+zwa_url?=https://github.com/Z-Wave-Alliance/${zwa_project}
+zwa_dir?=${zwa_project}
+
+${CURDIR}/tmp/${zwa_file}:
+	@echo "TODO: https://github.com/Z-Wave-Alliance/z-wave-stack-binaries/issues/2"
+	mkdir -p ${@D} && cd ${@D} \
+		&& gh release download \
+			--repo "${zwa_url}" --pattern "${zwa_file}" \
+			"${zwa_rev}"
+
+${zwa_dir}: ${CURDIR}/tmp/${zwa_file}
+	mkdir -p "$@"
+	tar xfa "$<" -C "$@"
+
+zwa/setup: ${zwa_project}
+	ls ${zwa_project}
+
 mapdir?=applications/zpc/components/dotdot_mapper/rules
 datastore_file?=tmp.db
 cache_path?=tmp/cache/ota
-devel/integration/test: ./scripts/tests/z-wave-stack-binaries-test.sh
+zwa/test: ./scripts/tests/z-wave-stack-binaries-test.sh ${zwa_dir}
 	-reset
 	rm -fv ${datastore_file} *.tmp
 	mkdir -p ${cache_path}

doc/protocol/zwave/zpc_introduction.md

@@ -11,6 +11,9 @@ set -o pipefail
 
 # Default configuration can be overloaded from env
 
+# To be explicilty added to env
+sudo="${sudo:=}"
+
 duration=3 # Allocated time in mins until watchdog quit
 
 ZPC_COMMAND="${ZPC_COMMAND:=/usr/bin/zpc}"
@@ -91,7 +94,8 @@ EOF
 
 log_()
 {
-    [ "$debug" != "" ] && echo || clear ||:
+    [ "$debug" != "" ] && echo \
+        || clear >/dev/null 2>&1 || reset >/dev/null 2>&1 || :
     printf "${yellow}info: $@ ${nocol}\n"
 }
 
@@ -103,18 +107,12 @@ exit_()
     sleep 10
     [ -z $debug ] || sleep 1000
     echo $code > $code_log
-    screen -S "$name" -X "quit"
+    screen -S "$name" -X "quit" ||:
+    ls -l *.log.tmp && more *.log.tmp | cat
     exit $code
 }
 
 
-die_()
-{
-    local code=$(( 1 + 0$code))
-    exit_ $code
-}
-
-
 run_()
 {
     local task="$1" && shift
@@ -131,12 +129,13 @@ mqtt_()
         pidof mosquitto \
             && mosquitto_sub \
                    -v -t '#' --remove-retained --retained-only -W 1 \
-            && break
+                || [ 27 = $? ] && break ||: # Break on timeout
         sleep .1
-    done > /dev/null 2>&1
+    done 
+    log_ "mqtt: broker is ready, operating for ${duration} mins"
     mosquitto_sub -v -t '#' -W $((60 * ${duration}))
     log_ "mqtt: error: Should have finish before ${duration} may need to update it"
-    die_
+    exit_ 10
 }
 
 
@@ -159,7 +158,7 @@ sub_()
             | head -n1 | grep -F "$expect" 2>&1 > /dev/null \
             || { printf "${red}exp: error:: ${expect}${nocol}\n" ;
                  cat "$mqtt_sub_log"  ;
-                 die_ ; }
+                 exit_ 11; }
     fi
 }
 
@@ -179,7 +178,6 @@ pub_()
 
 pubsub_()
 {
-    # reset
     echo ""
     [ "" = "$debug" ] || log_ "pubsub_: $@"
     local pub="$1"
@@ -236,13 +234,10 @@ controller_cli_()
                       | tail -n 1 | sed -e 's|PTY: \(.*\)|\1|g' )
             ;;
         H)
-            [ -z $debug ] || log_ "TODO: print HOME_ID: from device: https://github.com/Z-Wave-Alliance/z-wave-stack/issues/732"
-            sleep 1
-            while [ ! -e "${mqtt_log}" ] ; do sleep 1; done
-            # [ "$homeid" != "" ]
-            homeid=$(sed -n -e 's|ucl/by-unid/zw-\(.*\)-\([0-9]*\)/.*|\1|gp' "$mqtt_log" | tail -n1)
+            homeid=$(grep 'HOME_ID: ' "${controller_log}" \
+                         | tail -n 1 | sed -e 's|HOME_ID: \(.*\)|\1|g' )
             echo "HOME_ID: ${homeid}"
-            [ ! -z $homeid ] || die_
+            [ ! -z $homeid ] || exit_ 19
             ;;
         n)
             contid=$(grep 'NODE_ID: ' "${controller_log}" \
@@ -319,7 +314,7 @@ zpc_()
     sleep 1
     zpc_cli_ version
     zpc_cli_ help
-    die_
+    exit_ 13
 }
 
 
@@ -346,8 +341,8 @@ zpc_cli_()
 play_uic_net_add_node_()
 {
     log_ "net: controller: Add node (set in learn mode)"
-    controller_cli_ H | grep "^HOME_ID: ........$" || die_
-    controller_cli_ n | grep "^NODE_ID: " || die_
+    controller_cli_ H | grep "^HOME_ID: ........$" || exit_ 14
+    controller_cli_ n | grep "^NODE_ID: " || exit_ 15
 
     sub="ucl/by-mqtt-client/zpc/ApplicationMonitoring/SupportedCommands"
     pub="$sub" # Can be anything
@@ -364,7 +359,7 @@ play_uic_net_add_node_()
     homeid=$(sed -n -e 's|ucl/by-unid/zw-\(.*\)-\([0-9]*\)/.*|\1|gp' "$mqtt_sub_log")
     contid=$(sed -n -e 's|ucl/by-unid/zw-\(.*\)-\([0-9]*\)/.*|\2|gp' "$mqtt_sub_log")
     contunid="zw-$homeid-$contid"
-    node_cli_ n | grep 'NODE_ID: 0' || die_
+    node_cli_ n | grep 'NODE_ID: 0' || exit_ 16
     node_cli_ l
 
     log_ "net: cont: Add node"
@@ -374,7 +369,7 @@ play_uic_net_add_node_()
     count="2" # NODEID=0001 is controller , NODEID=0002 is expected node
     expect="State/SupportedCommands"
     pubsub_ "$pub" "$message" "$sub" "$expect"
-    node_cli_ H | grep "HOME_ID: ${homeid}" || die_
+    node_cli_ H | grep "HOME_ID: ${homeid}" || exit_ 17
     node_cli_ n # Should not be 0
     pub=''
     sub=$(echo "$sub" | sed -e "s|/+/|/$nodeunid/|g")
@@ -413,7 +408,7 @@ play_uic_net_remove_node_()
     expect=$(echo "$sub (null)" | sed -e "s|/+/|/$nodeunid/|g")
     node_cli_ l
     pubsub_ "$pub" "$message" "$sub" "$expect" 3
-    node_cli_ n | grep '^NODE_ID: 0$' || die_
+    node_cli_ n | grep '^NODE_ID: 0$' || exit_ 18
 }
 
 
@@ -487,7 +482,9 @@ play_uic_()
 play_()
 {
     log_ "play: Wait for zpc mqtt ready"
-    while ! grep -- "mqtt_wrapper_mosquitto" "${zpc_log}" ; do sleep 1 ; done
+    while ! grep -- "\[mqtt_wrapper_mosquitto\]" "${zpc_log}" ; do sleep 1 ; done
+    while ! grep -- "\[mqtt_client\] Connection to MQTT broker" "${zpc_log}" ; do sleep 1 ; done
+
     controller_cli_ h
     node_cli_ h
 
@@ -501,12 +498,17 @@ setup_()
     local project="z-wave-stack-binaries"
     local url="https://github.com/Z-Wave-Alliance/${project}"
     local pattern="$project-*.tar.gz" # TODO: Bump latest release
-    pattern="$project-25.1.0-25-g3b1e09d-Linux.tar.gz"
+    local rev="25.1.0-26-g29d304"
+    pattern="$project-${rev}-Linux.tar.gz"
 
     mkdir -p "${project}" && cd "${project}"
     file -E "${pattern}" \
         || gh release download -R "$url" --pattern "$pattern"
     tar xvfz "${project}"*.tar.gz
+    # TODO: https://github.com/eclipse-mosquitto/mosquitto/issues/3267
+    mosquitto_pub --version \
+        || which mosquitto_pub \
+        || $sudo apt install mosquitto-clients
 }
 
 
@@ -515,6 +517,17 @@ default_()
     usage_
     sleep 1
 
+    log_ "Setup check, if failing please setup using:"
+    echo "sudo=sudo $0 setup_"
+
+    [ "" = "$debug" ] || set
+
+    screen --version
+
+    # TODO: https://github.com/eclipse-mosquitto/mosquitto/issues/3267
+    mosquitto_pub --version \
+        || which mosquitto_pub
+
     log_ "z-wave-stack-binaries: Check presence in ${z_wave_stack_binaries_bin_dir}"
     file -E "${z_wave_stack_binaries_bin_dir}/"*"REALTIME"*".elf"
     sleep 2
@@ -576,7 +589,7 @@ EOF
     cat "${mqtt_log}"
 
     code=$(cat ${code_log} || echo 254)
-    exit 0$code
+    exit_ 0$code
 }