luosheng/Modbus.Net
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README update.

Browse Source
This commit is contained in:
parallelbgls
2017-06-30 11:43:19 +08:00
parent 94d678f250
commit d5bc2881c9
4 changed files with 105 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
Modbus.Net/Modbus.Net.Modbus/README.md
View File

@@ -4,77 +4,4 @@ Modbus.Net.Modbus
Modbus Implementation of Modbus.Net Modbus Implementation of Modbus.Net
Table of Content: Doc has been moved to wiki.
* [Basic Concept](#basic)
* [Address Mapping](#address)
* [Addres Coding](#coding)
* [SubAddress Rules](#subpos)
## <a name="basic"></a> Basic Concept
Modbus is a serial communications protocol originally published by Modicon (now Schneider Electric) in 1979 for use with its programmable logic controllers (PLCs). Simple and robust, it has since become a de facto standard communication protocol, and it is now a commonly available means of connecting industrial electronic devices.(From Wekipedia)
## <a name="address"></a> Address Mapping
Modbus has four types of address: Coil, Discrete Input, Input Register and Holding Register.
Modbus has two address description method: standard and extend.
The following table could show the full address discription in Modbus.
Type | Standard | Extend |
---------------- | ----------- | ------------- |
Coil | 00001-09999 | 000001-065536 |
Discrete Input | 10001-19999 | 100001-165536 |
Input Register | 30001-39999 | 300001-365536 |
Holding Register | 40001-49999 | 400001-465536 |
Standard and Extend address description are all supported in Modbus.Net.Modbus. The only difference is don't write too large number in address.
The following table shows how to write address in Modbus.Net.Modbus
Standard Modbus Address | Modbus.Net.Modbus String Address |
----------------------- | -------------------------------- |
00001 | 0X 1 |
00002 | 0X 2 |
09999 | 0X 9999 |
065536 | 0X 65536 |
10001 | 1X 1 |
30001 | 3X 1 |
40001 | 4X 1 |
## <a name="coding"></a> Address Coding
In Modbus.Net, you can write "0X"(Coil), "1X"(Discrete Input), "3X"(Input Register), "4X"(Holding Register) in Area.
Don't forget to type a space between Area and Address.
If you want to use subpos, type string address like this:
4X 1.12 (Area Address.Subpos)
## <a name="subpos"></a> SubAddress Rules
For 0X and 1X, the scalation is 1/8. This means each address is bool.
Noticing that you can only read 1X.
SubAddress System is not activated in 0X and 1X.
For 3X and 4X, the scalation is 2. This meas each address is short.
The number of SubAddress is from 0 to 15.
Caution: Modbus.Net.Modbus SubAddress has a giant difference towards standard Modbus.
Bit position from Modbus.Net is one less than standard modbus.
Standard Modbus
1 0 1 1 1 0 0 0 1 0 0 0 0 1 1 0 <br>
16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1
Modbus.Net.Modbus
1 0 1 1 1 0 0 0 1 0 0 0 0 1 1 0 <br>
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

44
Modbus.Net/Modbus.Net.OPC/README.md
View File

@@ -4,46 +4,4 @@
Modbus Implementation of Modbus.Net Modbus Implementation of Modbus.Net
Table of Content: Doc has been moved to wiki.
* [Basic Concept](#basic)
* [Address Mapping](#address)
* [Regex System](#regex)
* [Link](#link)
## <a name="basic"></a> Basic Concept
OPC Protocal implements OPC DA and OPC UA protocal.
## <a name="address"></a> Address Mapping
Modbus.Net.OPC has a simple address formatting tool. You can find it from AddressFormaterOPC.
You need to use messages in BaseMachine and AddressUnit to create an OPC tag.
Here is a Sample.
If your tag is "1/15/Value_Opening", 1 is MachineId, 15 is StationId and Value_Opening is point name.
Your tagGeter code should be.
```C#
(baseMachine, addressUnit) => return new string[]{baseMachine.Id, ((XXUnitExtend)addressUnit.unitExtend).stationId, addressUnit.Name};
```
If you want change your tag to "1.15.Value_Opening", just set the seperator to '.' .
## <a name="regex"></a> Regex System
Every tag could be a regex expression, Modbus.Net.OPC will always use regex comparison mode between each tags.
Like if you want to use a wildcard for first tag(or first directory), input your tagGeter code like this:
```C#
(baseMachine, addressUnit) => return new string[]{"(.*)", baseMachine.Id, ((XXUnitExtend)addressUnit.unitExtend).stationId, addressUnit.Name};
```
## <a name="link"></a> Link
The link of OPC DA should like "opcda://PC-Name/OPC-Software-Name".
The link of OPC UA should like "opc.tcp://PC-Name/Opc-Software-Name".

37
Modbus.Net/Modbus.Net.Siemens/README.md
View File

@@ -4,39 +4,4 @@
Modbus Implementation of Modbus.Net Modbus Implementation of Modbus.Net
Table of Content: Doc has been moved to wiki.
* [Basic Concept](#basic)
* [Address Mapping](#address)
* [Addres Coding](#coding)
* [SubAddress Rules](#subpos)
## <a name="basic"></a> Basic Concept
Siemens Protocal is derived by Profibus and Profinet.
## <a name="address"></a> Address Mapping
Modbus.Net.Siemens has two types of AddressMapping -- Modbus.Net way or Siemens way.
But Modbus.Net already decleared the type in AddressUnit, so all of the formatting ways will ignore the address type.
The following table shows the differences between them.
Standard Siemens Address | Modbus.Net Address Format | Siemens Address Format |
------------------------ | ------------------------- | ---------------------- |
I0.0 | I 0.0 | I0.0 |
IB0 | I 0 | I0 |
V10.5 | V 10.5 | V10.5 |
VB19 | V 19 | V19 |
DB1.DBD22 | DB1 22 | DB1.DB22 |
DB2.DB35.1 | DB2 35.1 | DB2.DB35.1 |
## <a name="coding"></a> Address Coding
The Coding of Modbus.Net.Siemens is the same as standard siemens protocal.
## <a name="subpos"></a> SubAddress Rules
SubAddress Rules is the same as standard siemens protocal.
Area length will always be 1.

176
Modbus.Net/Modbus.Net/README.md
View File

@@ -97,23 +97,37 @@ List<AddressUnit> addressUnits = new List<AddressUnit>
new AddressUnit() {Id = "0", Area = "V", Address = 1, CommunicationTag = "D1", DataType = typeof (ushort), Zoom = 1}, new AddressUnit() {Id = "0", Area = "V", Address = 1, CommunicationTag = "D1", DataType = typeof (ushort), Zoom = 1},
new AddressUnit() {Id = "1", Area = "V", Address = 3, CommunicationTag = "D2", DataType = typeof (float), Zoom = 1} new AddressUnit() {Id = "1", Area = "V", Address = 3, CommunicationTag = "D2", DataType = typeof (float), Zoom = 1}
}; };
TaskManager task = new TaskManager(10, 300, true); TaskManager task = new TaskManager(10, true);
task.AddMachine(new SiemensMachine(SiemensType.Tcp, "192.168.3.11", SiemensMachineModel.S7_300, addressUnits, task.AddMachine(new SiemensMachine(SiemensType.Tcp, "192.168.3.11", SiemensMachineModel.S7_300, addressUnits,
true, 2, 0)); true, 2, 0));
task.ReturnValues += (returnValues) => task.InvokeTimerAll(new TaskItemGetData(returnValues =>
{ {
value = new List<string>(); //唯一的参数包含返回值，是一个唯一标识符（machine的第二个参数），返回值（类型ReturnUnit）的键值对。
if (returnValues.ReturnValues != null) if (returnValues.ReturnValues != null)
{ {
value = from val in returnValues.ReturnValues select val.Key + " " + val.Value.PlcValue; lock (values)
siemensItems.Dispatcher.Invoke(() => siemensItems.ItemsSource = value); {
var unitValues = from val in returnValues.ReturnValues
select
new Tuple<AddressUnit, double?>(
addressUnits.FirstOrDefault(p => p.CommunicationTag == val.Key), val.Value.PlcValue);
values = from unitValue in unitValues
select
new TaskViewModel()
{
Id = unitValue.Item1.Id,
Name = unitValue.Item1.Name,
Address = unitValue.Item1.Address.ToString(),
Value = unitValue.Item2 ?? 0,
Type = unitValue.Item1.DataType.Name
};
}
} }
else else
{ {
Console.WriteLine($"ip {returnValues.MachineId} not return value"); Console.WriteLine($"ip {returnValues.MachineId} not return value");
} }
}; }, MachineGetDataType.CommunicationTag, 5000, 60000));
task.TaskStart();
``` ```
@@ -129,26 +143,19 @@ More important, you can extend and implement your own field in UnitExtend in eve
3. Add a machine to TaskManager. 3. Add a machine to TaskManager.
Add a machine like siemens machine to the task manager. Add a machine like siemens machine to the task manager.
4. Implement ReturnValues event. 4. Add a TaskItem for one machine or all Machines.
The argument return values is a key value pair. The architechture is: Modbus.Net implement TaskItemGetDatas and TaskItemSetDatas as the default.
* Key : the link address of machine (in sample is the second parameter).
* Value : Dictionary.
* Key : CommunicationTag/Address(string) in AddressUnit.
* Value : ReturnUnit.
* PlcValue : The return data, all in double type.
* UnitExtend : UnitExtend in AddressUnit. You should cast this class to your own class extends by UnitExtend.
##<a name="tutorial"></a> Tutorial ##<a name="tutorial"></a> Tutorial
This platform has three level APIs that you could use: Low level API called "BaseUtility"; Middle level API called "BaseMachine"; High level API called "TaskManager". This platform has three level APIs that you could use: Low level API called "BaseUtility"; Middle level API called "BaseMachine"; High level API called "TaskManager".
###BaseUtility ### Utility
BaseUtility is a low level api, in this level you can get or set data only by byte array or object array. Here is an example. IUtilityProperty is a low level api, in this level you can get or set data only by byte array or object array. Here is an example.
```C# ```C#
string ip = "192.168.0.10"; string ip = "192.168.0.10";
BaseUtility utility = new ModbusUtility(ModbusType.Tcp, ip, 0x02, 0x00); IUtilityProperty utility = new ModbusUtility(ModbusType.Tcp, ip, 0x02, 0x00);
object[] getNum = utility.GetDatas("4X 1", new KeyValuePair<Type, int>(typeof(ushort), 4)); object[] getNum = utility.InvokeUtilityMethod<IUtilityMethodData>?.GetDatas("4X 1", new KeyValuePair<Type, int>(typeof(ushort), 4));
``` ```
BaseUtility is an abstract class. You can check all apis in BaseUtility.cs in Modbus.Net project. BaseUtility is an abstract class. You can check all apis in BaseUtility.cs in Modbus.Net project.
@@ -157,24 +164,25 @@ To use BaseUtility, follow these steps.
1.New a BaseUtility instance, but remember BaseUtility is an abstract class, you should new class inherit from it. 1.New a BaseUtility instance, but remember BaseUtility is an abstract class, you should new class inherit from it.
```C# ```C#
BaseUtility utility = new ModbusUtility(ModbusType.Tcp, ip, 0x02, 0x00); IUtilityPropety utility = new ModbusUtility(ModbusType.Tcp, ip, 0x02, 0x00);
``` ```
2.Use GetData and SetData Api in BaseUtility, like 2.Use GetData and SetData Api in IUtilityMethodData, like
```C# ```C#
object[] getNum = utility.GetDatas("4X 1", new KeyValuePair<Type, int>(typeof(ushort), 4)); object[] getNum = utility.InvokeUtilityMethod<IUtilityMethodData>?.GetDatas("4X 1", new KeyValuePair<Type, int>(typeof(ushort), 4));
utility.SetDatas("4X 1", new object[] { (ushort)1, (ushort)2, (ushort)3 }); utility.InvokeUtilityMethod<IUtilityMethodData>?.SetDatas("4X 1", new object[] { (ushort)1, (ushort)2, (ushort)3 });
``` ```
Remember force set type of numbers because GetData and SetData Apis are type sensitive. Remember force set type of numbers because GetData and SetData Apis are type sensitive.
You can also use async functions like You can also use async functions like
```C# ```C#
object[] getNum = await utility.GetDatasAsync("4X 1", new KeyValuePair<Type, int>(typeof(ushort), 4)); object[] getNum = await utility.InvokeUtilityMethod<IUtilityMethodData>?.GetDatasAsync("4X 1", new KeyValuePair<Type, int>(typeof(ushort), 4));
``` ```
###BaseMachine ### Machine
BaseMachine is a middle level api, in this level you could get and set datas in a managable data structure for a single machine.
IMachineProperty is a middle level api, in this level you could get and set datas in a managable data structure for a single machine.
To understand this class, you have to see the AddressUnit first. To understand this class, you have to see the AddressUnit first.
```C# ```C#
public class AddressUnit public class AddressUnit
@@ -205,9 +213,9 @@ For some reasons, AddressUnit has two keys: Id and CommunicationTag, one is inte
* Unit : Unit of the Address. For example "¡æ". * Unit : Unit of the Address. For example "¡æ".
* UnitExtend : If you want to get something else when value returns, extend the class and give it to here. * UnitExtend : If you want to get something else when value returns, extend the class and give it to here.
Then using BaseMachine like this. Then using IMachineProperty like this.
```C# ```C#
BaseMachine machine = new ModbusMachine(ModbusType.Tcp, "192.168.3.12", new List<AddressUnit>() IMachineProperty machine = new ModbusMachine(ModbusType.Tcp, "192.168.3.12", new List<AddressUnit>()
{ {
machine = new ModbusMachine(ModbusType.Rtu, "COM3", new List<AddressUnit>() machine = new ModbusMachine(ModbusType.Rtu, "COM3", new List<AddressUnit>()
{ {
@@ -219,18 +227,18 @@ machine = new ModbusMachine(ModbusType.Rtu, "COM3", new List<AddressUnit>()
machine.AddressCombiner = new AddressCombinerContinus(machine.AddressTranslator); machine.AddressCombiner = new AddressCombinerContinus(machine.AddressTranslator);
machine.AddressCombinerSet = new AddressCombinerContinus(machine.AddressTranslator); machine.AddressCombinerSet = new AddressCombinerContinus(machine.AddressTranslator);
machine.AddressCombiner = new AddressCombinerPercentageJump(20.0); machine.AddressCombiner = new AddressCombinerPercentageJump(20.0);
var result = machine.GetDatas(MachineGetDataType.CommunicationTag); var result = machine.InvokeMachineMethods<IMachineMethodData>?.GetDatas(MachineGetDataType.CommunicationTag);
var add1 = result["Add1"].PlcValue; var add1 = result["Add1"].PlcValue;
var resultFormat = result.MapGetValuesToSetValues(); var resultFormat = result.MapGetValuesToSetValues();
machine.SetDatas(MachineSetDataType.CommunicationTag, resultFormat); machine.InvokeMachineMethods<IMachineMethodData>?.SetDatas(MachineSetDataType.CommunicationTag, resultFormat);
``` ```
To use BaseMachine, follow these steps. To use BaseMachine, follow these steps.
1.New a BaseMachine instance. Remeber BaseMachine is an abstract class. 1.New a IMachineProperty instance.
```C# ```C#
machine = new ModbusMachine(ModbusType.Rtu, "COM3", new List<AddressUnit>() IMachineProperty machine = new ModbusMachine(ModbusType.Rtu, "COM3", new List<AddressUnit>()
{ {
new AddressUnit() {Id = "1", Area = "4X", Address = 1, CommunicationTag = "Add1", DataType = typeof(ushort), Zoom = 1, DecimalPos = 0}, new AddressUnit() {Id = "1", Area = "4X", Address = 1, CommunicationTag = "Add1", DataType = typeof(ushort), Zoom = 1, DecimalPos = 0},
new AddressUnit() {Id = "2", Area = "4X", Address = 2, CommunicationTag = "Add2", DataType = typeof(ushort), Zoom = 1, DecimalPos = 0}, new AddressUnit() {Id = "2", Area = "4X", Address = 2, CommunicationTag = "Add2", DataType = typeof(ushort), Zoom = 1, DecimalPos = 0},
@@ -259,8 +267,8 @@ There are 4 AddressCombiners implemented in the platform.
3.Use GetDatas Api. 3.Use GetDatas Api.
```C# ```C#
var result = machine.GetDatas(MachineGetDataType.CommunicationTag); var result = machine.InvokeMachineMethods<IMachineMethodData>?.GetDatas(MachineGetDataType.CommunicationTag);
//var result = await machine.GetDatasAsync(MachineGetDataType.CommunicationTag); //var result = await machine.InvokeMachineMethods<IMachineMethodData>?.GetDatasAsync(MachineGetDataType.CommunicationTag);
``` ```
4.Retrive data from result. 4.Retrive data from result.
@@ -275,13 +283,15 @@ var resultFormat = result.MapGetValuesToSetValues();
6.SetData to machine or another machine. 6.SetData to machine or another machine.
```C# ```C#
machine.SetDatas(MachineSetDataType.CommunicationTag, resultFormat); machine.InvokeMachineMethods<IMachineMethodData>?.SetDatas(MachineSetDataType.CommunicationTag, resultFormat);
``` ```
There is also a SetDatasAsync Api. There is also a SetDatasAsync Api.
machine.SetDatas has two types. It is referenced as the first parameter. machine.SetDatas has four types. It is referenced as the first parameter.
1. MachineSetDataType.Address: the key of the dictionary of the second parameter is address. 1. MachineSetDataType.Address: the key of the dictionary of the second parameter is address.
2. MachineSetDataType.CommunicationTag: the key of the dictionary of the second parameter is communication tag. 2. MachineSetDataType.CommunicationTag: the key of the dictionary of the second parameter is communication tag.
3. MachineSetDataType.Id: the key of the dictionary of the second paramenter is ID.
4. MachineSetDataType.Name: the key of the dictionary of the second paramenter is name.
### TaskManager ### TaskManager
TaskManager is a high level api that you can manage and control many machines together. Remenber if you want to use this class, all communications must be asyncronized. TaskManager is a high level api that you can manage and control many machines together. Remenber if you want to use this class, all communications must be asyncronized.
@@ -294,20 +304,33 @@ List<AddressUnit> addressUnits = new List<AddressUnit>
new AddressUnit() {Id = 1, Area = "V", Address = 3, CommunicationTag = "D2", DataType = typeof (float), Zoom = 1} new AddressUnit() {Id = 1, Area = "V", Address = 3, CommunicationTag = "D2", DataType = typeof (float), Zoom = 1}
}; };
task.AddMachine(new SiemensMachine(SiemensType.Tcp, "192.168.3.11",SiemensMachineModel.S7_300, addressUnits, true)); task.AddMachine(new SiemensMachine(SiemensType.Tcp, "192.168.3.11",SiemensMachineModel.S7_300, addressUnits, true));
task.ReturnValues += (returnValues) => task.InvokeTimerAll(new TaskItemGetData(returnValues =>
{ {
value = new List<string>(); if (returnValues.ReturnValues != null)
if (returnValues.Value != null) {
{ lock (values)
value = from val in returnValues.Value select val.Key + " " + val.Value.PlcValue; {
siemensItems.Dispatcher.Invoke(() => siemensItems.ItemsSource = value); var unitValues = from val in returnValues.ReturnValues
} select
else new Tuple<AddressUnit, double?>(
{ addressUnits.FirstOrDefault(p => p.CommunicationTag == val.Key), val.Value.PlcValue);
Console.WriteLine($"ip {returnValues.Key} not return value"); values = from unitValue in unitValues
} select
}; new TaskViewModel()
task.TaskStart(); {
Id = unitValue.Item1.Id,
Name = unitValue.Item1.Name,
Address = unitValue.Item1.Address.ToString(),
Value = unitValue.Item2 ?? 0,
Type = unitValue.Item1.DataType.Name
};
}
}
else
{
Console.WriteLine($"ip {returnValues.MachineId} not return value");
}
}, MachineGetDataType.CommunicationTag, 5000, 60000));
``` ```
To use the TaskManager, use following steps. To use the TaskManager, use following steps.
@@ -327,28 +350,35 @@ List<AddressUnit> addressUnits = new List<AddressUnit>
task.AddMachine(new SiemensMachine(SiemensType.Tcp, "192.168.3.11", SiemensMachineModel.S7_300, addressUnits, true)); task.AddMachine(new SiemensMachine(SiemensType.Tcp, "192.168.3.11", SiemensMachineModel.S7_300, addressUnits, true));
``` ```
3.Register the ReturnValue Event. 3.Add a get value cycling task. You can handle return values with your own code (ReturnValue event before 1.3.2).
```C# ```C#
task.ReturnValues += (returnValues) => task.InvokeTimerAll(new TaskItemGetData(returnValues =>
{ {
value = new List<string>(); if (returnValues.ReturnValues != null)
if (returnValues.Value != null) {
{ lock (values)
value = from val in returnValues.Value select val.Key + " " + val.Value.PlcValue; {
siemensItems.Dispatcher.Invoke(() => siemensItems.ItemsSource = value); var unitValues = from val in returnValues.ReturnValues
} select
else new Tuple<AddressUnit, double?>(
{ addressUnits.FirstOrDefault(p => p.CommunicationTag == val.Key), val.Value.PlcValue);
Console.WriteLine($"ip {returnValues.Key} not return value"); values = from unitValue in unitValues
} select
}; new TaskViewModel()
``` {
The ReturnValues' key is the machineToken, this sample is "192.168.3.11". Id = unitValue.Item1.Id,
And the value is the same as the machine.GetDatas returns. Name = unitValue.Item1.Name,
Address = unitValue.Item1.Address.ToString(),
4.Start the TaskManager. Value = unitValue.Item2 ?? 0,
```C# Type = unitValue.Item1.DataType.Name
task.TaskStart(); };
}
}
else
{
Console.WriteLine($"ip {returnValues.MachineId} not return value");
}
}, MachineGetDataType.CommunicationTag, 5000, 60000));
``` ```
5.And don't forget that there is also a SetDatasAsync Api in the TaskManager. 5.And don't forget that there is also a SetDatasAsync Api in the TaskManager.
@@ -462,8 +492,6 @@ You need to implement three functions.
public override void SetConnectionType(int connectionType) public override void SetConnectionType(int connectionType)
protected override async Task<byte[]> GetDatasAsync(byte slaveAddress, byte masterAddress, string startAddress, int getByteCount) protected override async Task<byte[]> GetDatasAsync(byte slaveAddress, byte masterAddress, string startAddress, int getByteCount)
public override async Task<bool> SetDatasAsync(byte slaveAddress, byte masterAddress, string startAddress, object[] setContents) public override async Task<bool> SetDatasAsync(byte slaveAddress, byte masterAddress, string startAddress, object[] setContents)
public override bool GetLittleEndian
public override bool SetLittleEndian
``` ```
And don't remember set default AddressTranslator, slaveAddress, masterAddress and Protocal. And don't remember set default AddressTranslator, slaveAddress, masterAddress and Protocal.
```C# ```C#
@@ -509,8 +537,8 @@ public class AddressFormaterModbus : AddressFormater
## <a name="addition"></a> Addition ## <a name="addition"></a> Addition
### For Subpos System ### For Subaddress System
Subpos system is implemented for reading and writing of bits. Subaddress system is implemented for reading and writing of bits.
```C# ```C#
public class AddressUnit public class AddressUnit
{ {