From bda978b45d14214206550f8b17cd96817fea98c2 Mon Sep 17 00:00:00 2001
From: Johann Mantel <j-mantel@gmx.net>
Date: Tue, 21 Jun 2022 17:25:21 +0200
Subject: [PATCH] add README.md to SickLaserUnit for better documentation of
 setup

---
 .../RobotAPI/drivers/SickLaserUnit/README.md  | 33 +++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 source/RobotAPI/drivers/SickLaserUnit/README.md

diff --git a/source/RobotAPI/drivers/SickLaserUnit/README.md b/source/RobotAPI/drivers/SickLaserUnit/README.md
new file mode 100644
index 000000000..decfdadc6
--- /dev/null
+++ b/source/RobotAPI/drivers/SickLaserUnit/README.md
@@ -0,0 +1,33 @@
+# SickLaserUnit
+Armarx adapter to the SICK laser scanner driver
+
+Uses the sick_scan_base driver to communicate with the SICK_TiM571 Laser Scanners installed in Armar-DE and translates their timestamps and data to ArmarX types.
+After conversion, the scan data is published to the configured topic.
+
+
+## Installation
+
+1. Download and build the sick_scan_base project from https://github.com/SICKAG/sick_scan_base
+   ```console
+   git clone https://github.com/SICKAG/sick_scan_base.git
+
+   cd sick_scan_base
+   mkdir -p ./build
+   cd ./build
+   cmake .. && make
+   ```
+
+2. The package uses the script RobotAPI/etc/cmake/Findsick_scan_base.cmake to link against the sick drivers.
+   For this to work, the CMake variable sick_scan_base_DIR must be set to the path where the driver has been downloaded to.
+
+3. Build this package and configure its parameters to match the Laser Scanner setup.
+
+## Runnig
+
+To use the package, make sure your LaserScanners are connected to the PC and the configured IP addresses match the ones set by the SOPAS tool.
+
+You can use ping to check whether the scanners are connected.
+```console
+ping 192.168.8.133
+```
+
-- 
GitLab