[Scripts] Add script for simple zaptool startup (#8292)

* Add script for starting zaptool easily * run_zaptool script: exit on setup failure * run_zaptool script: Added copyrights, formatting * Restyled by whitespace * Restyled by shellharden * Restyled by shfmt * run_zaptool script: Changes for compatibility with macOS, replacing configure.sh * Restyled by prettier-markdown * Restyled by shellharden * Restyled by shfmt * run_zaptool script: fix CWD cornercase * Restyled by shfmt * Update scripts/tools/zap/run_zaptool.sh Co-authored-by: Łukasz Duda <[email protected]> * Revert "Update scripts/tools/zap/run_zaptool.sh" This reverts commit 6eab9fd. Co-authored-by: Restyled.io <[email protected]> Co-authored-by: Łukasz Duda <[email protected]>
project-chip · Aug 17, 2021 · 2036553 · 2036553
1 parent 13023e4
commit 2036553
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 23 deletions.
diff --git a/scripts/tools/zap/configure.sh b/scripts/tools/zap/configure.sh
diff --git a/scripts/tools/zap/run_zaptool.sh b/scripts/tools/zap/run_zaptool.sh
@@ -0,0 +1,53 @@
+#!/bin/bash
+
+#
+# Copyright (c) 2021 Project CHIP Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+function _get_fullpath() {
+    cd "$(dirname "$1")" && echo "$PWD/$(basename "$1")"
+}
+
+set -e
+
+[[ "$1" == "--help" ]] && {
+    echo "Usage: $0 [ZAP-file-path]" >&2
+    exit 0
+}
+
+SCRIPT_PATH="$(_get_fullpath "$0")"
+CHIP_ROOT="${SCRIPT_PATH%/scripts/tools/zap/run_zaptool.sh}"
+[[ -n "$1" ]] && ZAP_ARGS=(-i "$(_get_fullpath "$1")") || ZAP_ARGS=()
+
+(
+
+    cd "$CHIP_ROOT" &&
+        git submodule update --init third_party/zap/repo
+
+    cd "third_party/zap/repo"
+    if ! npm list installed-check &>/dev/null; then
+        npm install installed-check
+    fi
+
+    if ! ./node_modules/.bin/installed-check -c &>/dev/null; then
+        npm install
+    fi
+
+    node src-script/zap-start.js --logToStdout \
+        --gen "$CHIP_ROOT/src/app/zap-templates/app-templates.json" \
+        --zcl "$CHIP_ROOT/src/app/zap-templates/zcl/zcl.json" \
+        "${ZAP_ARGS[@]}"
+
+)
diff --git a/src/app/zap-templates/README.md b/src/app/zap-templates/README.md
@@ -11,7 +11,13 @@ This directory contains generation templates for ZAP, ZCL Advanced Platform.
 Run ZAP with UI to configure endpoints and clusters
 
 ```
-./scripts/tools/zap/configure.sh
+./scripts/tools/zap/run_zaptool.sh
+```
+
+or
+
+```
+./scripts/tools/zap/run_zaptool.sh <path to *.zap file>
 ```
 
 ### How to generate files for all applications