SWPROT-8953: Release 1.7.0

NEWS.md

@@ -5,12 +5,24 @@ All notable changes to this project will be documented in this file.
 **Full Changelog**:
 https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commits
 
+## ver_1.7.0
+
+**Full Changelog**:
+https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commits/ver_1.7.0
+
+Refer to documentation for release highlights:
+
+- [applications/zpc/release_notes.md](applications/zpc/release_notes.md)
+
+
 ## ver_1.6.1-RC0
 
 Integrate internal changes progressively:
 
+```
 applications/zpc: uic#ver_1.7.0-unstable-84-gcb000bc912
 applications/zpc/components/zwave/zwave_transports/s2/libs/zw-libs2: zw-libs2#zwave-sdk-7.21.0-ga-65-g3b7dcd7
+```
 
 ## ver_1.6.0-RC4
 

README.md

@@ -8,7 +8,7 @@ It has grown as part of Unify SDK project and is now maintained as an external p
 ## News
 
 - [NEWS.md](NEWS.md) lists important information regarding zpc "split release".
-- [doc/release_nodes.md](doc/release_nodes.md) release notes
+- [applications/zpc/release_notes.md](applications/zpc/release_notes.md)
 
 ## Documentation
 

applications/zpc/release_notes.md

@@ -1,5 +1,34 @@
 # ZPC Release Notes
 
+## [1.7.0] - Feb 2025
+
+**BREAKING**: ZPC has been relocated outside of UnifySDK and is now dependent on it.
+
+### Added (1.7.0)
+
+* [Z-Wave S2v2 alpha support along Silicon Labs Z-Wave firmware (7.23.x)](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/pull/11)
+* [Notification CC updated to support Alarm CC v1 and v2](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/647aac3b)
+* [Notification CC support Push/Pull Mode Discovery](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/e4aab0dd)
+  and [probe](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/e4aab0dd)
+* [Notification CC support unknown type](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/96fc24de)
+* [Time Parameters CC support](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/af84a42)
+* [CRC16 Encapsulation](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/cb377ace)
+
+### Changes (1.7.0)
+
+* Standlone project, helper script to setup native reference system (used for docker, github CI etc)
+
+### Fixed (1.7.0)
+
+* [Improvement to prevent faulty devices to block the TX queue](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/722028a7)
+* [Notification CC fixes to pass CTT](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/ef497b17)
+* [OnOff: Disable unsupported UCL commands (effects)](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/73ece3a7)
+
+### Known issues (1.7.0)
+
+* [User credentials still Experimental](https://github.com/SiliconLabsSoftware/z-wave-protocol-controller/commit/8cdbbc36)
+* ZPC's UnifySDK related documentation may be inconsistent.
+
 ## [1.6.0] - Aug 2024
 
 **BREAKING** : ZPC database version bumped from 2 to 3.

cmake/modules/FindUnifySDK.cmake

@@ -21,17 +21,15 @@ endif()
 if(NOT DEFINED UNIFYSDK_GIT_TAG)
   if(DEFINED ENV{UNIFYSDK_GIT_TAG})
     set(UNIFYSDK_GIT_TAG $ENV{UNIFYSDK_GIT_TAG})
+  else()
+    set(UNIFYSDK_GIT_TAG "ver_1.7.0")
   endif()
 endif()
 if("${UNIFYSDK_GIT_TAG}" STREQUAL "")
   set(UNIFYSDK_GIT_TAG "main") # Override CMake default ("master")
 endif()
 
-if(${GIT_EXECUTABLE})
-else()
-  set(GIT_EXECUTABLE git)
-endif()
-
+find_package(Git)
 FetchContent_Declare(
   UnifySDK
   GIT_REPOSITORY ${UNIFYSDK_GIT_REPOSITORY}

helper.mk

@@ -10,6 +10,8 @@ default: help all/default
 SELF?=${CURDIR}/helper.mk
 
 project?=z-wave-protocol-controller
+url?=https://github.com/SiliconLabsSoftware/z-wave-protocol-controller
+
 # Temporary workaround for:
 # https://gitlab.kitware.com/cmake/cmake/-/issues/22813#note_1620373
 project_test_dir?=applications
@@ -86,17 +88,31 @@ export CMAKE_TARGET_TRIPLE
 endif
 
 
-help: README.md
-	@cat $<
+help: ./helper.mk
+	@echo "# ${project}: ${url}"
+	@echo "#"
+	@echo "# Usage:"
+	@echo "#  ${<D}/${<F} setup # To setup developer system (once)"
+	@echo "#  ${<D}/${<F} VERBOSE=1 # Default build tasks verbosely (depends on setup)"
+	@echo "#  ${<D}/${<F} # For more info"
+	@echo "#"
+
+help/all: README.md NEWS.md
+	@echo "# ${project}: ${url}"
 	@echo ""
-	@echo "# Available rules at your own risk:"
+	@head $^
+	@echo ""
+	@echo "# Available helper.mk rules at your own risk:"
 	@grep -o '^[^ ]*:' ${SELF} \
 		| grep -v '\$$' | grep -v '^#' | grep -v '^\.' \
 		| grep -v '=' | grep -v '%'
-	@echo ""
+	@echo "#"
 	@echo "# Environment:"
-	@echo "# PATH=${PATH}"
+	@echo "#  PATH=${PATH}"
+	@echo "#  version=${version}"
 	@echo ""
+	@echo ""
+
 
 setup/debian: ${CURDIR}/docker/target_dependencies.apt ${CURDIR}/docker/host_dependencies.apt
 	cat /etc/debian_version
@@ -163,7 +179,7 @@ ${PLANTUML_JAR_PATH}:
 	${sudo} install -d ${plantuml_dir}
 	${sudo} install ${plantuml_filename} ${plantuml_dir}/
 	rm -v ${plantuml_filename}
-	@echo "# %@: Please adapt env to:"
+	@echo "# $@: Please adapt env to use:"
 	@echo "# export PLANTUML_JAR_PATH=${plantuml_dir}/${plantuml_filename}"
 
 setup/plantuml: ${PLANTUML_JAR_PATH}
@@ -285,13 +301,18 @@ prepare/docker: Dockerfile prepare
 	@echo "# ${project}: log: $@: done: $^"
 
 docker_workdir?=/usr/local/opt/${project}
+docker_branch?=main
+docker_url?=${url}.git\#${docker_branch}
 
 docker/%: Dockerfile
 	time docker run "${project}:latest" -C "${docker_workdir}" "${@F}"
 
 test/docker: distclean prepare/docker docker/help docker/test
 	@echo "# ${project}: log: $@: done: $^"
 
+test/docker/build:
+	time docker build -t "${project}:${docker_branch}" ${docker_url}
+
 docs: ./scripts/build/build_documentation.py doc ${PLANTUML_JAR_PATH} configure
 	@echo "# export PLANTUML_JAR_PATH=${plantuml_dir}/${plantuml_filename}"
 	@echo "$@: PLANTUML_JAR_PATH=${PLANTUML_JAR_PATH}"

scripts/build/build_documentation.py

@@ -37,7 +37,7 @@
 documentation_root = os.path.realpath(args.source)
 output_dir = os.path.realpath(args.output_dir)
 
-sphinx_opt_version = subprocess.check_output(["git", "describe"], cwd=default_project_root, text=True).strip()
+sphinx_opt_version = subprocess.check_output(["git", "describe", "--tags"], cwd=default_project_root, text=True).strip()
 
 print(f"Git Version string: {sphinx_opt_version}")
 
@@ -56,11 +56,7 @@ def setup_doxygen_project(project_name, outdir):
         print("could not find " + doxygen)
 
 # run sphinx builder
-setup_doxygen_project("doxygen_uic",        output_dir)
-setup_doxygen_project("doxygen_zigpc",      output_dir)
 setup_doxygen_project("doxygen_zpc",        output_dir)
-setup_doxygen_project("doxygen_aox",        output_dir)
-setup_doxygen_project("reference_ucl_mqtt", output_dir)
 
 sphinx_build_cmd=f"sphinx-build -b {args.builder} -c {doc_dir} -D root_doc={root_doc} -D version={sphinx_opt_version} -D release={sphinx_opt_version} -d {doctree_dir} {documentation_root} {output_dir}"