You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-10Lines changed: 30 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,15 @@
1
1
2
-
OpenKNXproducer
3
-
===
2
+
# OpenKNXproducer
3
+
4
4
**OpenKNXproducer** is a commandline tool to create knxprod files for ETS.
5
5
6
6
It is the successor of [multiply-channels](https://github.com/mumpf/multiply-channels), which will be discontinued. multiply-channels and OpenKNXproducer are compatible, as long as you want to convert simple xml-sources using ETS 5.x. As soon as you use the include-functionality of these tools, there is no compatibility anymore.
7
7
8
8
For [OpenKNX_Projects](https://github.com/OpenKNX) or for knxprod-creation with ETS 6 you should use OpenKNXproducer.
9
9
10
-
### Features
10
+
11
+
## Features and Arguments
12
+
11
13
The current version provides the following verbs:
12
14
-**create** Check given xml file and create knxprod
13
15
-**check** Execute sanity checks on given xml file
@@ -16,10 +18,18 @@ The current version provides the following verbs:
16
18
-**help** Display more information on a specific command.
17
19
-**version** Display version information.
18
20
19
-
This tool also creates a header file with defines for all parameter and communication object definitions in the XML. **Requirements:** ETS must be installed. Supported versions are: ETS 4, ETS 5.5, ETS 5.6, ETS 5.7 and ETS 6.0. The correct ETS converter version is automatically found dependent on xmlns of provided xml document.
21
+
This tool also creates a header file with defines for all parameter and communication object definitions in the XML.
22
+
23
+
24
+
## Requirements:
25
+
26
+
ETS must be installed. Supported versions are: ETS 4, ETS 5.5, ETS 5.6, ETS 5.7, ETS 6.0 and ETS 6.3. The correct ETS converter version is automatically found dependent on xmlns of provided xml document.
20
27
This project uses **.NET 6.0**.
28
+
21
29
##
22
-
### Examples:
30
+
31
+
## Examples:
32
+
23
33
-``OpenKNXproducer new --ProductName=TempSensor --AppNumber=567 Sensor``
24
34
25
35
Creates initial Sensor.xml, do sanity checks produce Sensor.h, produce Sensor.knxprod
@@ -37,7 +47,9 @@ This project uses **.NET 6.0**.
37
47
Reads Sensor.xml, do sanity checks
38
48
39
49
##
40
-
### Tipps:
50
+
51
+
## Tipps:
52
+
41
53
If all sanity checks were OK and the knxprod file was created, there might be still problems using this file in ETS. Because the user is editing an xml file, there might be many other problems there, which are not checked by this tool yet.
42
54
43
55
**As a general hint:**
@@ -47,21 +59,28 @@ If all sanity checks were OK and the knxprod file was created, there might be st
47
59
If you find a situation, which is not yet checked but leads to errors in ETS, report a issue and I will add a new check or just create a pull request. Thank you.
48
60
49
61
##
50
-
### Installation
62
+
63
+
## Installation
51
64
This release is compatible with **Linux**, **macOS**, and **Windows 10/11** (x86, x64, Arm).
65
+
52
66
### 1. Download and Extract the ZIP file
67
+
53
68
Download the latest release and extract the entire contents of the ZIP file into a directory.
69
+
54
70
### 2. Run the installation script
55
-
### Windows
71
+
72
+
#### **Windows**
73
+
56
74
- Right-click on `Install-OpenKNX-Tools.ps1` → **Run with PowerShell**.
57
75
Confirm any security warnings by selecting **Open File**.
58
76
- The tools will be copied to the target directories automatically. Progress will be displayed in the console.
Ensure **PowerShell (pwsh)** is installed: [PowerShell GitHub Releases](https://github.com/PowerShell/powershell/releases)
81
+
#### macOS / Linux
82
+
83
+
- Ensure **PowerShell (pwsh)** is installed: [PowerShell GitHub Releases](https://github.com/PowerShell/powershell/releases)
65
84
-```pwsh ./Install-OpenKNX-Tools.ps1```
66
85
-**Installation Hints**:
67
86
-**macOS**: Security Block on First Launch* When starting OpenKNXproducer for the first time, macOS may block the app (unidentified developer). Try to start the app → macOS shows a warning.
@@ -70,6 +89,7 @@ Download the latest release and extract the entire contents of the ZIP file into
70
89
- Start the app again.
71
90
72
91
### 3. Remove / Uninstallation
92
+
73
93
- Use Remove-OpenKNX-Tools.ps1 following similar steps.
0 commit comments