gsulc / wagomodbusnet Goto Github PK

.NET standard targeting maximizes the compatibility across platforms. Targeting the lowest version possible further increases the compatibility. Libraries targeting .NET Standard allow all .NET platforms to use it. The .NET Standard API is implemented by .NET Framework, .NET Core, and Xamarin (Mono).

Reading:
https://msdn.microsoft.com/en-us/magazine/mt842506.aspx
https://docs.microsoft.com/en-us/dotnet/standard/net-standard

The Microsoft provided libraries for opening connections: Socket and SerialPort both implement IDisposable. However, the ModbusMaster$ that use them do not implement that interface nor a finalizer. This causes the problem when a ModbusMaster reference is set to null: the connection is not released.

Catching exceptions as part of the normal operational case is bad practice.

Remove all error/return codes and replace them with exceptions. By the end, wmnRet and wmnErrorOffset will be removed.

Return codes clutter the caller. It is better to throw an exception when you encounter an error. (Martin, R. C. (2009). Clean Code: a handbook of agile software craftsmanship. p 104)

This is because the method is looking for a TimeoutException in the WagoModbusNet namespace. This new exception should be removed. Also, the logic should be moved out of the finally block top the catch block. Not operating on an expected Exception is the ultimate goal.

Found several errors in the first update. Unit Tests should be created to avoid these. Currently, the various ModbusMasters cannot have unit tests for their modbus operations, save connection failure. The data manipulation methods should be turned protected/internal, so that unit tests can be run on them.

IModbusMaster may seem pedantic to have as an interface given the ModbusMaster abstract class, however under my understanding, this can make using Dependency Injection containers a bit more straightforward. Need to research this more.