Merge pull request #8 from Ddoiron-cidco/master

add support for dbt and dpt and add unit test and ci

Author: glabmoris

.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  unit-tests:
+    name: Unit tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pyserial
+
+      - name: Run unit tests
+        run: bash Script/unittest.sh

.gitignore

@@ -1,4 +1,6 @@
 nbproject
 nbproject/*
 build
-build/*
+build/*
+__pycache__/
+*.pyc

Install/install.sh

@@ -1,19 +1,33 @@
-sudo apt install python3 python-is-python3 python3-pip -y
+#!/usr/bin/env bash
+set -euo pipefail
 
-sudo bash -c 'cat << EOF3 > /etc/systemd/system/nmea.service
+PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+
+sudo apt update
+sudo apt install -y python3 python3-pip python3-serial
+
+sudo tee /etc/systemd/system/nmea.service >/dev/null <<EOF
 [Unit]
 Description=Launch NMEA Simulator on boot.
+After=network-online.target
+Wants=network-online.target
 
 [Service]
 Type=simple
-ExecStart=/home/ubuntu/SonarSimulator/Script/autolaunch.sh
+WorkingDirectory=${PROJECT_ROOT}
+Environment=SONAR_SERIAL_PORT=/dev/ttyUSB0
+Environment=SONAR_BAUD_RATE=9600
+Environment=SONAR_SENTENCE_TYPE=dpt
+ExecStart=${PROJECT_ROOT}/Script/autolaunch.sh
+Restart=always
+RestartSec=2
 
 [Install]
 WantedBy=multi-user.target
-EOF3'
+EOF
 
-sudo chmod 755 /etc/systemd/system/nmea.service
+sudo chmod 644 /etc/systemd/system/nmea.service
+sudo systemctl daemon-reload
 sudo systemctl enable nmea
-sudo systemctl start nmea
-sudo systemctl status nmea
-
+sudo systemctl restart nmea
+sudo systemctl --no-pager --full status nmea

README.md

@@ -1,48 +1,82 @@
-# README for nmeaSIMULATOR.py
-## Sonar simulator NMEA-0183
+# SonarSimulator
 
+NMEA-0183 depth simulator for serial-connected systems.
 
+## Features
+- Generates `SDDPT` or `SDDBT` frames once per second by default.
+- Uses a deterministic depth pattern based on current second (`10 + second`).
+- Sends data over a serial port (`/dev/ttyUSB0` and `9600` by default).
+- Can run manually or as a `systemd` service (`nmea.service`).
 
-### foncitonnalities :
+## Repository Layout
+- `Script/sonar_simulator.py`: simulator entrypoint.
+- `Script/autolaunch.sh`: launcher used by systemd.
+- `Script/sonar_simulator_unittest.py`: unit tests.
+- `Script/unittest.sh`: test runner.
+- `Install/install.sh`: service installation script.
+- `BOM.txt`: hardware bill of materials.
 
-Generate nmea-0183 string of types  :  
-- Depth of water (SDDPT)
+## Requirements
+- Ubuntu (tested workflow targets Raspberry Pi with Ubuntu Server).
+- Python 3.
+- `pyserial` (`python3-serial` package).
 
-### HOW TO MAKE IT WORK: 
-    
-On a Raspberry pi : 
+## Manual Run
+From repository root:
 
-1. Install ubuntu server on as sdcard with the user ubuntu
+```bash
+python3 Script/sonar_simulator.py /dev/ttyUSB0 9600
+```
 
-2. Connect the usb serial adapter on the Raspberry
+Optional arguments:
 
-3. apply the power on the raspberry
+```bash
+python3 Script/sonar_simulator.py /dev/ttyUSB0 9600 --sentence-type dbt --interval 0.5 --iterations 10
+```
 
-4. validate if the serial adapter is detected by the OS
-    ls /dev/ttyU*
-	  you should see ttyUSB0
-   
-5. clone the repository in /home/ubuntu
+## Install as Service
+From repository root:
 
-6. Validate and modify the setting for the serial port and baudrate in the autolaunch.sh
-    nano /home/ubuntu/SonarSimulator/autolaunch.sh
-	  python /home/ubuntu/SonarSimulator/Script/sonar_simulator_DPT.py /dev/ttyUSB0 9600
-	  the 2 last argument are the serial port and the baudrate
-	  ex:
-	  python /home/ubuntu/SonarSimulator/Script/sonar_simulator_DPT.py /dev/ttyUSB1 9600
-	  python /home/ubuntu/SonarSimulator/Script/sonar_simulator_DPT.py /dev/ttyAMA0 115200
+```bash
+bash Install/install.sh
+```
 
-7. go in the install directory and run the installation script
-    cd /home/ubuntu/SonarSimulator/Install
-    ./install.sh
+This installs and starts `nmea.service` with default environment values:
+- `SONAR_SERIAL_PORT=/dev/ttyUSB0`
+- `SONAR_BAUD_RATE=9600`
+- `SONAR_SENTENCE_TYPE=dpt`
 
-The script is installed as a service. 
-If you do some modification in the autolaunch.sh file you have to relaunch the service. 
+Service commands:
+
+```bash
+sudo systemctl status nmea
 sudo systemctl restart nmea
+sudo systemctl stop nmea
+```
+
+## Change Serial Port, Baud Rate, or Sentence Type
+Option 1 (recommended): override service environment values in the unit file.
+
+```bash
+sudo systemctl edit --full nmea
+# Update SONAR_SERIAL_PORT, SONAR_BAUD_RATE, and SONAR_SENTENCE_TYPE (dpt or dbt)
+sudo systemctl daemon-reload
+sudo systemctl restart nmea
+```
+
+Option 2: export environment values before running manually.
 
-to show the status of the service : sudo systemctl status nmea
-to start the service : sudo systemctl start nmea
-to stop the service : sudo systemctl stop nmea
+```bash
+SONAR_SERIAL_PORT=/dev/ttyUSB1 SONAR_BAUD_RATE=115200 SONAR_SENTENCE_TYPE=dbt bash Script/autolaunch.sh
+```
 
+## Run Tests
+From repository root:
 
+```bash
+bash Script/unittest.sh
+```
 
+## Notes
+- The simulator writes one frame per cycle terminated by `\r\n`.
+- If serial opening fails, the script logs the error and exits cleanly.

Script/DPT_unittest.py

@@ -1,3 +1,12 @@
-#!/bin/bash
+#!/usr/bin/env bash
+set -euo pipefail
 
-python /home/ubuntu/SonarSimulator/Script/sonar_simulator_DPT.py /dev/ttyUSB0 9600
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+SERIAL_PORT="${SONAR_SERIAL_PORT:-/dev/ttyUSB0}"
+BAUD_RATE="${SONAR_BAUD_RATE:-9600}"
+SENTENCE_TYPE="${SONAR_SENTENCE_TYPE:-dpt}"
+
+exec python3 "${SCRIPT_DIR}/sonar_simulator.py" \
+  "${SERIAL_PORT}" \
+  "${BAUD_RATE}" \
+  --sentence-type "${SENTENCE_TYPE}"

Script/autolaunch.sh

@@ -0,0 +1,110 @@
+import argparse
+import datetime
+import time
+
+import serial
+
+
+def generate_nmea_dpt(depth):
+    return checksum(f"SDDPT,{depth:.1f},0.1,100")
+
+
+def generate_nmea_dbt(depth):
+    feet = depth * 3.28084
+    fathoms = depth * 0.546806649
+    return checksum(f"SDDBT,{feet:.1f},f,{depth:.1f},M,{fathoms:.1f},F")
+
+
+def generate_nmea_sentence(depth, sentence_type):
+    normalized_type = sentence_type.lower()
+    if normalized_type == "dpt":
+        return generate_nmea_dpt(depth)
+    if normalized_type == "dbt":
+        return generate_nmea_dbt(depth)
+    raise ValueError(f"Unsupported sentence type: {sentence_type}")
+
+
+def checksum(sentence):
+    checksum_value = 0
+    for char in sentence:
+        checksum_value ^= ord(char)
+    return f"${sentence}*{checksum_value:02X}"
+
+
+def depth_from_now(now=None):
+    if now is None:
+        now = datetime.datetime.now()
+    return 10 + now.second
+
+
+def main(
+    serial_port,
+    baud_rate,
+    sentence_type="dpt",
+    iterations=None,
+    interval=1.0,
+    now_provider=None,
+    sleep_func=time.sleep,
+):
+    if now_provider is None:
+        now_provider = datetime.datetime.now
+
+    ser = None
+    try:
+        ser = serial.Serial(serial_port, baud_rate, timeout=1)
+        print(f"Connected to serial port {serial_port} at {baud_rate} baud.")
+
+        sent_count = 0
+        while iterations is None or sent_count < iterations:
+            depth = depth_from_now(now_provider())
+            nmea_sentence = generate_nmea_sentence(depth, sentence_type)
+            ser.write((nmea_sentence + "\r\n").encode("ascii"))
+            print(nmea_sentence)
+            sent_count += 1
+
+            if iterations is None or sent_count < iterations:
+                sleep_func(interval)
+
+    except KeyboardInterrupt:
+        print("Script stopped by user.")
+    except Exception as exc:
+        print(f"An error occurred: {exc}")
+    finally:
+        if ser is not None and ser.is_open:
+            ser.close()
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(description="NMEA-0183 sonar simulator (DPT/DBT)")
+    parser.add_argument("serial_port", help="Serial device path (example: /dev/ttyUSB0)")
+    parser.add_argument("baud_rate", type=int, help="Serial baud rate (example: 9600)")
+    parser.add_argument(
+        "--sentence-type",
+        choices=["dpt", "dbt"],
+        default="dpt",
+        help="NMEA sentence type to emit (default: dpt)",
+    )
+    parser.add_argument(
+        "--interval",
+        type=float,
+        default=1.0,
+        help="Delay between sentences in seconds (default: 1.0)",
+    )
+    parser.add_argument(
+        "--iterations",
+        type=int,
+        default=None,
+        help="Number of sentences to send (default: infinite loop)",
+    )
+    return parser.parse_args()
+
+
+if __name__ == "__main__":
+    args = parse_args()
+    main(
+        serial_port=args.serial_port,
+        baud_rate=args.baud_rate,
+        sentence_type=args.sentence_type,
+        iterations=args.iterations,
+        interval=args.interval,
+    )