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
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,14 @@
4
4
5
5
- Windows with TcXaeShell Version 15.0 or higher
6
6
7
-
## 2 Installation and Usage
7
+
## 2 Installation
8
8
9
9
To install the complete framework, you need to install three components:
10
10
11
11
1. VS Code extension: `BCS Engineering DSL`
12
12
2.`bcs-engineering-cli` - The CLI to generate the artifacts from the DSL files.
13
13
3.`TcAutomation` - The tool to create and deploy the TwinCAT project from the generated artifacts.
14
14
15
-
After the installation you can have a look at the [example](language/example) folder to see how to use the framework.
16
-
17
15
### 2.1 Install bcs-engineering-cli and VS Code Extension
18
16
19
17
To install the `bcs-engineering-cli` and `BCS Engineering DSL` VS Code extension, follow the installation and usage instructions in the [README](language/README.md) file.
@@ -23,28 +21,29 @@ To install the `bcs-engineering-cli` and `BCS Engineering DSL` VS Code extension
23
21
_TcAutomation_ is responsible for the creation and deployment of the corresponding TwinCAT project given the generated artifacts. To install it, you need to run the `TcAutomationInstaller.exe`.
24
22
To create the installer, follow the steps described in the [TcAutomation](TcAutomation/README.md) README file.
25
23
26
-
###2.3 Check TcAutomation Installation
24
+
####Check TcAutomation Installation
27
25
28
26
To check if _TcAutomation_ is installed correctly, you can run the following command in a command:
29
27
30
28
```bash
31
29
TcAutomation --help
32
30
```
33
31
34
-
### 2.5 BCS Engineering CLI
32
+
## 3 Usage
33
+
34
+
After installation, explore the [example](language/example) folder to get started with the framework. The examples demonstrate how to define control logic and hardware configurations using the BCS Engineering DSL. You can either generate some of the artifacts (ST and TwinCAT config files) without deployment or generate and deploy them to a Beckhoff device.
35
35
36
-
#### 2.5.1 Generate
36
+
#### 3.1 Generate
37
37
38
-
To generate the artifacts, you can run the following command in the `language/example`folder:
38
+
To generate the artifacts, you can run the following command in the `language/example`directory:
0 commit comments