Clean scripts

Author: pylessard

README.md

@@ -1,2 +1,3 @@
 # scrutiny-demos
-Some demonstration projects that uses scrutiny
+
+A collection of demonstration project to showcase the Scrutiny Debugger framework

nsec2024/CMakeLists.txt

@@ -18,7 +18,7 @@ FetchContent_Declare(
   scrutiny-embedded
 
   GIT_REPOSITORY https://github.com/scrutinydebugger/scrutiny-embedded.git
-  GIT_TAG        nsec_demo
+  GIT_TAG        nsec2024_demo
 )
 FetchContent_MakeAvailable(scrutiny-embedded)
 

nsec2024/Dockerfile

@@ -17,4 +17,4 @@ RUN apt-get update && apt-get install -y \
     && rm -rf /var/lib/apt/lists/*
 
 #RUN pip3 install scrutinydebugger
-RUN  git clone -b nsec2024_demo https://github.com/scrutinydebugger/scrutiny-python /tmp/scrutiny-python && pip3 install -e /tmp/scrutiny-python
+RUN  git clone --depth 1 -b nsec2024_demo https://github.com/scrutinydebugger/scrutiny-python /tmp/scrutiny-python && pip3 install -e /tmp/scrutiny-python

nsec2024/README.md

@@ -0,0 +1,28 @@
+# NorthSec 2024 Demo
+
+This project is a Arduino project used to demonstrate the Scrutiny framework during the 2024 edition of NorthSec
+
+
+https://nsec.io/session/2024-scrutiny-debugger-debug-test-and-configure-embedded-softwares-through-instrumentation.html
+
+
+## Building the Arduino app
+
+Calling the following script should be enough, assuming you have docker configured
+
+```bash
+export ARDUINO_PORT=/dev/ttyACM0    # Change serial port
+./scripts/build_in_docker
+./scripts/flash
+```
+
+## Running the server
+
+```bash
+# pip install scrutinydebugger # For latest release
+# scrutiny-python repo has a tag "nsec2024_demo" that points on the version used.
+git clone --depth 1 -b nsec2024_demo https://github.com/scrutinydebugger/scrutiny-python /tmp/scrutiny-python && pip3 install -e /tmp/scrutiny-python
+scrutiny launch-server --config scrutiny_server_config.json # Make sure to adjust the serial port name in that configuration
+```
+
+

nsec2024/build.sh renamed to nsec2024/scripts/build.sh

@@ -2,17 +2,18 @@
 set -euo pipefail
 
 SCRIPT_DIR=$(realpath "$(dirname ${BASH_SOURCE[0]})")
-cd "$SCRIPT_DIR" 
+ROOT_DIR=$SCRIPT_DIR/..
+cd "$ROOT_DIR" 
 
-source common.sh
+source $SCRIPT_DIR/common.sh
 
 [ -z ${ARDUINO_PATH:+x} ] && fatal "ARDUINO_PATH must be set"
 
 info "ARDUINO_PATH=$ARDUINO_PATH"
 mkdir -p build
 cmake -G Ninja \
     -DARDUINO_PATH=$ARDUINO_PATH \
-    -DCMAKE_TOOLCHAIN_FILE="$SCRIPT_DIR/cmake/toolchain/mega2526.toolchain.cmake" \
+    -DCMAKE_TOOLCHAIN_FILE="$ROOT_DIR/cmake/toolchain/mega2526.toolchain.cmake" \
     -S . -B build
 
 ninja -C build

nsec2024/build_in_docker.sh renamed to nsec2024/scripts/build_in_docker.sh

@@ -2,8 +2,9 @@
 set -euo pipefail 
 
 SCRIPT_DIR=$(realpath "$(dirname ${BASH_SOURCE[0]})")
-cd $SCRIPT_DIR
-WORKDIR=$SCRIPT_DIR     # Having Workdir = script dir makes the compile_commands.json paths match the host system. Easier for vscode integration
+ROOT_DIR=$SCRIPT_DIR/..
+cd $ROOT_DIR
+WORKDIR=$ROOT_DIR     # Having Workdir = script dir makes the compile_commands.json paths match the host system. Easier for vscode integration
 IMAGE_NAME=scrutiny_nsec2024_demo
 CACHE_OPT=
 while getopts "f" o; do
@@ -15,8 +16,8 @@ done
 
 docker build . -t $IMAGE_NAME $CACHE_OPT
 docker run \
-    --volume $SCRIPT_DIR:$WORKDIR \
+    --volume $ROOT_DIR:$WORKDIR \
     -e ARDUINO_PATH=/usr/share/arduino \
     -u $(id -u):$(id -g) \
     $IMAGE_NAME \
-    bash -c $WORKDIR/build.sh
+    bash -c $WORKDIR/scripts/build.sh

nsec2024/common.sh renamed to nsec2024/scripts/common.sh

@@ -1,8 +1,9 @@
 #/bin/bash
 SCRIPT_DIR=$(realpath "$(dirname ${BASH_SOURCE[0]})")
-cd "$SCRIPT_DIR" 
+ROOT_DIR=$SCRIPT_DIR/..
+cd "$ROOT_DIR" 
 
-source common.sh
+source $SCRIPT_DIR/common.sh
 BINNAME=scrutiny-nsec2024.hex
 BINPATH=./build/$BINNAME
 DEFAULT_PORT=/dev/ttyACM0