Skip to content

Commit c29eca7

Browse files
committed
Update README.md
1 parent 86c4191 commit c29eca7

1 file changed

Lines changed: 43 additions & 2 deletions

File tree

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# Cimon-PLC
2-
This library mange communication with Exclusive Service for CIMON PLC Ethernet & Serial Port
1+
# Cimon.Net
2+
A .NET Library for Cimon PLCs Connectivity
3+
4+
<!-- ABOUT THE PROJECT -->
5+
## About The Project
6+
<p>CIMON-PLC is an industrial control device based on international standards of IEC61131. There are many tools and servers to work with PLCs and send/recieve data with them, but what if we want to use our application to communicate? I Couldn't find any library to work with Cimon PLCs, and actually I used them in many projects. So I decided to publish my library.</p>
7+
8+
## Getting Started
9+
### 1. Installing Cimon.Net
10+
You can install Cimon.Net with [NuGet Package Manager Console](https://www.nuget.org/packages/Cimon.Net):
11+
12+
Install-Package Cimon.Net
13+
14+
Or via the .NET Core command-line interface:
15+
16+
dotnet add package Cimon.Net
17+
18+
Either commands, from Package Manager Console or .NET Core CLI, will download and install **Cimon.Net** and all required dependencies.
19+
20+
### 2. Defining your Connector
21+
Create a Connector based on your connection type, You can choose between `EthernetConnector` to support Ethernet TCP/UDP connection or `SerialConnector` to support RS232C/RS485 serial interfaces.
22+
23+
`EthernetConnector` usage sample for reading 10 bits from Input device memory `X` address 000001:
24+
25+
var Plc = new EthernetConnector(new TcpSocket("192.168.1.10", 10620), true);
26+
var (responseCode, data) = await Plc.ReadBitAsync(MemoryType.X, "000001", 10);
27+
28+
`SerialConnector` usage sample for write 5 bits to Output device memory `Y` address 000010:
29+
30+
var Plc = new SerialConnector(new SerialSocket("COM3", 9600), true);
31+
await Plc.WriteBitAsync(MemoryType.Y, "000010", 1, 1, 1, 0, 1);
32+
33+
## Documentation
34+
Check the Wiki and feel free to edit it: https://github.com/MojtabaKiani/Cimon-PLC/wiki
35+
36+
## Supported PLCs
37+
Complete range of Cimon PLC products including `PLC-S`, `CP`, `XP` series
38+
39+
## Compile
40+
You need at least Visual Studio 2019 (you can download the Community Edition for free).
41+
42+
## Running the tests
43+
Unit tests use no devices and only work with Faked sockets, but You can test them with PLC only with address a real socket.

0 commit comments

Comments
 (0)