Skip to content

Commit d917177

Browse files
Docs: Update style
1 parent 8e19e1b commit d917177

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Description
44

5-
This is an application example of SIMATIC AX to showcase the communication between a PLC and UA Expert using a protected OPC UA connection.
5+
This is an application example of SIMATIC AX to showcase the communication between a PLC and Uaxpert using a protected OPC UA connection. The use-case for this example is to show how a simulated water tank is controlled using a secure OPC UA connection. The PLC and UaExpert communicate to manage the tank's water level by opening and closing valves
66

77
## Used components
88

@@ -12,14 +12,14 @@ This is an application example of SIMATIC AX to showcase the communication betwe
1212

1313
## Project Installation
1414

15-
- **1st:** Open a command line interface (CLI) and switch to the target folder. E.G, if the target folder is C:/Users/user/Desktop
15+
1. Open a command line interface (CLI) and switch to the target folder. E.G, if the target folder is C:/Users/user/Desktop
1616

1717
```sh
1818
C:
1919
cd \Users\user\Desktop
2020
```
2121

22-
- **2nd:** Install the application example on your local PC.
22+
2. Install the application example on your local PC.
2323

2424
Run the following command in the CLI:
2525

@@ -34,9 +34,9 @@ This is an application example of SIMATIC AX to showcase the communication betwe
3434
axcode .
3535
```
3636

37-
- **3rd** If it does not open automatically, open a terminal: (`CTRL+ ´`)
37+
3. If it does not open automatically, open a terminal: (`CTRL+ ´`)
3838

39-
- **4th** Start a PLCSIM Advanced Instance (we are using a FW V3.1 PLC, so please use at least PLCSIm Advanced 6.0) with the same IP address that you will use in the `apax.yml`, the `.vscode/launch.json` and the `tankPlc.hwljson` of the project. To change the IP, [follow the instructions](#prepare-configuration).
39+
4. Start a PLCSIM Advanced Instance (we are using a FW V3.1 PLC, so please use at least PLCSIm Advanced 6.0) with the same IP address that you will use in the `apax.yml`, the `.vscode/launch.json` and the `tankPlc.hwljson` of the project. To change the IP, [follow the instructions](#prepare-configuration).
4040

4141
> :warning:
4242
> You need to have a PLCSIM Adv instance running. Online access must be set to **TCP/IP Single Adapter** with the same IP address and mask configured above.
@@ -47,17 +47,17 @@ We provide you the solution already prepared for being able to run the **OPC UA
4747

4848
The process to run the project with the opcua interface follows this process:
4949

50-
- **1st** Run _apax install_ to install all the project dependencies.
50+
1. Run _apax install_ to install all the project dependencies.
5151

52-
- **2nd:** Run the script _setup-hw-certificates_ that will setup the secure communication and then will import the certificate to the hardware.
52+
2. Run the script _setup-hw-certificates_ that will setup the secure communication and then will import the certificate to the hardware.
5353

54-
- **3rd:** Run the script _set-password_ to enable the password for the user configurated "MyUser".
54+
3. Run the script _set-password_ to enable the password for the user configurated "MyUser".
5555

56-
- **4th:** Run the script _create-opcua-interface_ to create the opcua
56+
4. Run the script _create-opcua-interface_ to create the opcua
5757

58-
- **5th:** Run the script _hcl_. Here the hardware configuration is compiled and downloaded to the plc instance.
58+
5. Run the script _hcl_. Here the hardware configuration is compiled and downloaded to the plc instance.
5959

60-
- **6th:** Run the script _scl_. The application is built and transferred to the instance.
60+
6. Run the script _scl_. The application is built and transferred to the instance.
6161

6262
In addition, there are commands to control the tank from AX side:
6363

@@ -84,19 +84,19 @@ Where to modify the IP Addresses in **SIMATIC AX**:
8484

8585
![AX_IP-3](docs/graphics/AX_IP-3.png)
8686

87-
## UAExpert User Documentation
87+
## UaExpert User Documentation
8888

8989
### Introduction
9090

9191
This documentation provides guidance on installing, using, and configuring UaExpert to work with this specific water tank example.
9292

93-
UAExpert is an OPC UA client designed to demonstrate the OPC UA technology. It serves as a versatile test client supporting various OPC UA features, making it an essential tool for developers and testers evaluating OPC UA technology. Further details: [UAExpert website](https://www.unified-automation.com/products/development-tools/uaexpert.html).
93+
UaExpert is an OPC UA client designed to demonstrate the OPC UA technology. It serves as a versatile test client supporting various OPC UA features, making it an essential tool for developers and testers evaluating OPC UA technology. Further details: [UaExpert website](https://www.unified-automation.com/products/development-tools/uaexpert.html).
9494

95-
## UAExpert Installation
95+
## UaExpert Installation
9696

9797
### Download
9898

99-
1. Visit the official [UAExpert website](https://www.unified-automation.com/products/development-tools/uaexpert.html).
99+
1. Visit the official [UaExpert website](https://www.unified-automation.com/products/development-tools/uaexpert.html).
100100

101101
2. Download the latest version.
102102

@@ -109,7 +109,7 @@ Run the installer and follow on-screen instructions.
109109

110110
## Usage
111111

112-
### Initial Start-Up of UA Expert
112+
### Initial Start-Up of UaExpert
113113

114114
When starting UaExpert for the first time, it is necessary to perform some final configuration steps.
115115
An application instance certificate is needed to create a secure channel, identifying the installation of UaExpert. A new dialog window will open, collecting the information which is needed to create such a certificate. Fill out the form and confirm with OK. Red crosses indicate that a required field is still empty.

0 commit comments

Comments
 (0)