Skip to content

Commit 501be31

Browse files
committed
fixes
1 parent 698d940 commit 501be31

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ jobs:
4949
run: genhtml coverage.filtered.info --output-directory coverage-report
5050

5151
- name: Upload coverage-report
52-
uses: actions/upload-artifact@v3
52+
uses: actions/upload-artifact@v4
5353
with:
5454
name: coverage-report
5555
path: coverage-report

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is a simple c++ library created to read data from supported proximity senso
44

55
It was specifically developed to read data from the capa NCDT 6200 control units, but it should work with other capa NCDT control units if they adhere to the same messaging protocol.
66

7-
To ensure your control unit is supported, please refer to the [Micro Epsilon manuals](https://www.micro-epsilon.com/distance-sensors/capacitive-sensors/capancdt-6200/) for more information on the messaging protocol and compare it to the one that NCDT 6200 uses.
7+
To ensure your control unit is supported, please refer to the [Micro Epsilon manuals](https://www.micro-epsilon.com/distance-sensors/capacitive-sensors/capancdt-6200/) and compare the messaging protocol with the one that NCDT 6200 uses.
88

99
## Features
1010

@@ -30,11 +30,7 @@ To ensure your control unit is supported, please refer to the [Micro Epsilon man
3030
3. Build the project:
3131

3232
```bash
33-
cmake -S . -B build \
34-
-DENABLE_COVERAGE=OFF \
35-
-DBUILD_TESTING=OFF \
36-
-DCMAKE_BUILD_TYPE=Debug
37-
33+
cmake -S . -B build
3834
cd build
3935
make
4036
```
@@ -65,13 +61,13 @@ target_link_libraries(my_app
6561
)
6662
```
6763

68-
Using the library is straightforward. This example demonstrates how to read data from a proximity sensor connected to a capa NCDT control unit.
64+
Using the library is straightforward. The below example demonstrates how to read data from a proximity sensor connected to a capa NCDT control unit.
6965

7066
Ensure you provide the correct measuring range of the sensor you are using according to it's specifications. For instance the CS02 sensor has a measuring range of 0-2mm, hence the measuring range is 2000 in micrometers.
7167

7268
The channel number is the number of the channel your sensor is connected to on the control unit, starting from 1. The capaNCDT 6200 control unit for instance supports up to 4 channels, all of which can be used simultaneously.
7369

74-
For more information on the library interface, please refer to the [header files](include/capancdt/proximity_sensor.h).
70+
For more information on the library interface, please refer to the [header files](include/capancdt/).
7571

7672
```cpp
7773
#include <iostream>
@@ -170,7 +166,7 @@ ProximitySensor* proximity_sensor = new ProximitySensor(conn, rate, 2.0);
170166

171167
## Provided verification binary
172168

173-
The library provides a standalone binary that can be used to read data from the capa NCDT control unit and output the measurements to the console. After installing the library, the binary can be found in the `bin` directory. The binary is called `capancdt_read_sensor` amd can be used as follows:
169+
The library provides a standalone binary that can be used to read data from the capa NCDT control unit and output the measurements to the console. After installing the library, the binary can be found in the `bin` directory (f.x `/usr/local/bin/`). The binary is called `capancdt_read_sensor` and can be used as follows:
174170

175171
```bash
176172
./capancdt_read_sensor <ip> <port> <rate> <channel> <range>
@@ -196,13 +192,13 @@ Build the project:
196192

197193
```bash
198194
cmake -S . -B build \
199-
-DENABLE_COVERAGE=OFF \
200-
-DBUILD_TESTING=OFF \
195+
-DENABLE_COVERAGE=ON \
196+
-DBUILD_TESTING=ON \
201197
-DCMAKE_BUILD_TYPE=Debug
202198

203199
cmake --build build --parallel
204200
```
205201

206202
Testing:
207203

208-
> make test
204+
> cd build && make test

0 commit comments

Comments
 (0)