Skip to content

Commit f5f3492

Browse files
alexadereykoalexadereyko
committed
<TBBAS-2538> Update README with CI/CD documentation
- Document build process and testing - Describe ci.yml and ci-framework.yml workflows - Add CI and license badges
1 parent 15ddc7b commit f5f3492

File tree

2 files changed

+343
-8
lines changed

2 files changed

+343
-8
lines changed

‎LICENSE‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
 Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 167 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,173 @@
1-
# Example device module
1+
# SimpleDeviceModule
22

3-
Simple example that builds an openDAQ module giving access to an example device. Said device contains 2 channels, each with a value and time signal. The value signal outputs a counter signal, increasing at a rate of 1 per second.
3+
[![CI](https://github.com/openDAQ/SimpleDeviceModule/actions/workflows/ci.yml/badge.svg)](https://github.com/openDAQ/SimpleDeviceModule/actions/workflows/ci.yml)
4+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
45

5-
## Testing the module
6+
**SimpleDeviceModule** is an example module demonstrating how to build and test a device module using the **openDAQ framework**.
67

7-
To test the module, enable the `OPENDAQ_DEVICE_EXAMPLE_ENABLE_SERVER_APP` cmake flag. Doing so will add an openDAQ native server module to your build targets, and add an additional "server_application" executable. Running the executable will create a device, add an openDAQ server, and enable discovery.
8+
The module provides a simple device with 2 channels, each containing value and time signals. The value signal outputs a counter that increments at 1 Hz.
89

9-
To connect to the device, the openDAQ Python GUI application can be used (Latest Python version is recommended):
10+
This repository serves as a template for building custom openDAQ modules and includes:
11+
- Example device implementation
12+
- Unit tests
13+
- CI/CD workflows for automated testing
1014

15+
---
16+
17+
## Prerequisites
18+
19+
- **CMake** (>= 3.25)
20+
- **Git**
21+
- **C++ compiler** (Visual Studio on Windows, GCC/Clang on Linux/macOS)
22+
- **openDAQ framework** (installed locally or built automatically)
23+
24+
---
25+
26+
## Building the Project
27+
28+
There are two ways to provide the openDAQ framework:
29+
30+
### 1. Using a local openDAQ installation
31+
32+
Install the openDAQ package and set the `OPENDAQ_ROOT` environment variable:
33+
34+
```bash
35+
export OPENDAQ_ROOT=/path/to/opendaq
36+
37+
cmake -S . -B build/output \
38+
-G "Ninja" \
39+
-DEXAMPLE_MODULE_ENABLE_TESTS=ON \
40+
-DCMAKE_BUILD_TYPE=Release
41+
```
42+
43+
### 2. Using a specific openDAQ version
44+
45+
CMake will automatically download and build the required openDAQ version:
46+
47+
```bash
48+
cmake -S . -B build/output \
49+
-G "Ninja" \
50+
-DEXAMPLE_MODULE_ENABLE_TESTS=ON \
51+
-DSIMPLE_DEVICE_MODULE_OPENDAQ_SDK_VER=3.20.4 \
52+
-DCMAKE_BUILD_TYPE=Release
53+
```
54+
55+
### Building
56+
57+
```bash
58+
cmake --build build/output --config Release
59+
```
60+
61+
**Note:**
62+
- `EXAMPLE_MODULE_ENABLE_TESTS=ON` enables unit test compilation
63+
- Without `OPENDAQ_ROOT` or `SIMPLE_DEVICE_MODULE_OPENDAQ_SDK_VER`, the build will fail
64+
65+
---
66+
67+
## Running Tests
68+
69+
After building:
70+
71+
```bash
72+
ctest --test-dir build/output --output-on-failure -C Release -V
73+
```
74+
75+
---
76+
77+
## Testing the Module with Server Application
78+
79+
You can build an example server application to test the module with the openDAQ GUI.
80+
81+
**Note:** This requires building openDAQ from source, so you must use `SIMPLE_DEVICE_MODULE_OPENDAQ_SDK_VER`:
82+
83+
```bash
84+
cmake -S . -B build/output \
85+
-G "Ninja" \
86+
-DSIMPLE_DEVICE_MODULE_OPENDAQ_SDK_VER=3.20.4 \
87+
-DSIMPLE_DEVICE_MODULE_ENABLE_SERVER_APP=ON \
88+
-DCMAKE_BUILD_TYPE=Release
89+
90+
cmake --build build/output --config Release
91+
./build/output/server_application/server_application
1192
```
12-
py -m pip install openDAQ
13-
py -m openDAQ
14-
```
93+
94+
Connect using the openDAQ Python GUI:
95+
96+
```bash
97+
pip install openDAQ
98+
python -m openDAQ
99+
```
100+
101+
---
102+
103+
## CI/CD Workflows
104+
105+
This repository includes two GitHub Actions workflows for automated testing:
106+
107+
### `ci.yml` - Continuous Integration
108+
109+
Automatically runs on push to `main` and pull requests:
110+
- Downloads the latest openDAQ framework release
111+
- Builds the module on Ubuntu and Windows
112+
- Runs unit tests
113+
- Configured with `fail-fast: false` to run all platform tests independently
114+
115+
### `ci-framework.yml` - Integration Testing with Custom openDAQ Builds
116+
117+
Reusable workflow (`workflow_call` and `workflow_dispatch`) for testing with specific openDAQ framework builds:
118+
119+
**Inputs:**
120+
- `runner` - GitHub runner label (e.g., `ubuntu-latest`)
121+
- `branch` - Branch to checkout (optional, defaults to current branch)
122+
- `artifact-run-id` - GitHub Actions run ID containing the artifact
123+
- `artifact-name` - Name of the openDAQ framework artifact
124+
- `file-name` - Filename of the openDAQ installer
125+
126+
**Usage from openDAQ repository:**
127+
128+
```yaml
129+
jobs:
130+
test-module:
131+
uses: openDAQ/SimpleDeviceModule/.github/workflows/ci-framework.yml@main
132+
with:
133+
runner: ubuntu-latest
134+
branch: main
135+
artifact-run-id: ${{ github.run_id }}
136+
artifact-name: opendaq-v3.31.0-ubuntu24.04-x86_64.deb
137+
file-name: opendaq-v3.31.0-ubuntu24.04-x86_64.deb
138+
```
139+
140+
### Composite Action: `module-build-test`
141+
142+
Both workflows use the `.github/actions/module-build-test` composite action that:
143+
1. Detects the appropriate CMake generator (Ninja for Linux, Visual Studio for Windows)
144+
2. Configures the module with CMake
145+
3. Builds the module
146+
4. Runs unit tests with CTest
147+
148+
---
149+
150+
## Project Structure
151+
152+
```
153+
SimpleDeviceModule/
154+
├── .github/
155+
│ ├── actions/
156+
│ │ └── module-build-test/ # Composite action for build and test
157+
│ └── workflows/
158+
│ ├── ci.yml # CI workflow with latest release
159+
│ └── ci-framework.yml # Reusable workflow for custom builds
160+
├── example_module/
161+
│ ├── src/ # Module implementation
162+
│ └── tests/ # Unit tests
163+
├── server_application/ # Example server app
164+
└── CMakeLists.txt
165+
```
166+
167+
---
168+
169+
## License
170+
171+
Copyright © 2024 openDAQ
172+
173+
Licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)