added extensions project

mesta1 · Mar 28, 2009 · 88ba70b · 88ba70b
1 parent 646a866
commit 88ba70b
Show file tree

Hide file tree

Showing 7 changed files with 227 additions and 3 deletions.
diff --git a/NModbus/NModbus.build b/NModbus/NModbus.build
@@ -137,6 +137,7 @@
 			<in>
 				<items basedir="${path.dist}\scratch\bin">
 					<include name="Modbus.dll" />
+          <include name="Modbus.Extensions.dll" />
 					<include name="FtdAdapter.dll" />
 				</items>
 			</in>

diff --git a/NModbus/src/Modbus.Extensions/EnronModbus.cs b/NModbus/src/Modbus.Extensions/EnronModbus.cs
@@ -0,0 +1,108 @@
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.Linq;
+using Modbus.Device;
+using Modbus.Utility;
+
+namespace Modbus.Extensions.Enron
+{
+	/// <summary>
+	/// Utility extensions for the Enron Modbus dialect.
+	/// </summary>
+	public static class EnronModbus
+	{
+		/// <summary>
+		/// Read contiguous block of 32 bit holding registers.
+		/// </summary>
+		/// <param name="master">The Modbus master.</param>
+		/// <param name="slaveAddress">Address of device to read values from.</param>
+		/// <param name="startAddress">Address to begin reading.</param>
+		/// <param name="numberOfPoints">Number of holding registers to read.</param>
+		/// <returns>Holding registers status</returns>
+		public static uint[] ReadHoldingRegisters32(this ModbusMaster master, byte slaveAddress, ushort startAddress, ushort numberOfPoints)
+		{
+			ValidateNumberOfPoints(numberOfPoints, 62);
+
+			// read 16 bit chunks and perform conversion
+			var rawRegisters = master.ReadHoldingRegisters(slaveAddress, startAddress, (ushort) (numberOfPoints * 2));			
+
+			return Convert(rawRegisters).ToArray();
+		}
+
+		/// <summary>
+		/// Read contiguous block of 32 bit input registers.
+		/// </summary>
+		/// <param name="master">The Modbus master.</param>
+		/// <param name="slaveAddress">Address of device to read values from.</param>
+		/// <param name="startAddress">Address to begin reading.</param>
+		/// <param name="numberOfPoints">Number of holding registers to read.</param>
+		/// <returns>Input registers status</returns>
+		public static uint[] ReadInputRegisters32(this ModbusMaster master, byte slaveAddress, ushort startAddress, ushort numberOfPoints)
+		{
+			ValidateNumberOfPoints(numberOfPoints, 62);
+
+			var rawRegisters = master.ReadInputRegisters(slaveAddress, startAddress, (ushort) (numberOfPoints * 2));
+
+			return Convert(rawRegisters).ToArray();
+		}
+
+		/// <summary>
+		/// Write a block of contiguous 32 bit holding registers.
+		/// </summary>
+		/// <param name="master">The Modbus master.</param>
+		/// <param name="slaveAddress">Address of the device to write to.</param>
+		/// <param name="startAddress">Address to begin writing values.</param>
+		/// <param name="data">Values to write.</param>
+		public static void WriteMultipleRegisters32(this ModbusMaster master, byte slaveAddress, ushort startAddress, uint[] data)
+		{
+			if (data == null)
+				throw new ArgumentNullException("data");
+
+			if (data.Length == 0 || data.Length > 61)
+			{
+				throw new ArgumentException(String.Format(CultureInfo.InvariantCulture, 
+					"The length of argument data must be between 1 and 61 inclusive."));
+			}
+
+			master.WriteMultipleRegisters(slaveAddress, startAddress, Convert(data).ToArray());
+		}
+
+		/// <summary>
+		/// Convert the 32 bit registers to two 16 bit values.
+		/// </summary>
+		internal static IEnumerable<ushort> Convert(uint[] registers)
+		{
+			foreach (var register in registers)
+			{
+				// low order value
+				yield return BitConverter.ToUInt16(BitConverter.GetBytes(register), 0);
+
+				// high order value
+				yield return BitConverter.ToUInt16(BitConverter.GetBytes(register), 2);
+			}
+		}
+
+		/// <summary>
+		/// Convert the 16 bit registers to 32 bit registers.
+		/// </summary>
+		internal static IEnumerable<uint> Convert(ushort[] registers)
+		{
+			for (int i = 0; i < registers.Length; i++)
+			{
+				yield return ModbusUtility.GetUInt32(registers[i], registers[i + 1]);
+				i++;
+			}
+		}
+
+		internal static void ValidateNumberOfPoints(ushort numberOfPoints, ushort maxNumberOfPoints)
+		{
+			if (numberOfPoints < 1 || numberOfPoints > maxNumberOfPoints)
+			{
+				throw new ArgumentException(String.Format(CultureInfo.InvariantCulture,
+					"Argument numberOfPoints must be between 1 and {0} inclusive.",
+					maxNumberOfPoints));
+			}
+		}
+	}
+}
diff --git a/NModbus/src/Modbus.Extensions/Modbus.Extensions.csproj b/NModbus/src/Modbus.Extensions/Modbus.Extensions.csproj
@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="3.5" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <ProductVersion>9.0.30729</ProductVersion>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>{667F4D2C-C9DF-4CC4-A1A6-768F6E879CE5}</ProjectGuid>
+    <OutputType>Library</OutputType>
+    <AppDesignerFolder>Properties</AppDesignerFolder>
+    <RootNamespace>Modbus.Extensions</RootNamespace>
+    <AssemblyName>Modbus.Extensions</AssemblyName>
+    <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
+    <FileAlignment>512</FileAlignment>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>full</DebugType>
+    <Optimize>false</Optimize>
+    <OutputPath>bin\Debug\</OutputPath>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\Modbus.Extensions.XML</DocumentationFile>
+    <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+    <DebugType>pdbonly</DebugType>
+    <Optimize>true</Optimize>
+    <OutputPath>bin\Release\</OutputPath>
+    <DefineConstants>TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\Modbus.Extensions.XML</DocumentationFile>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'SignedRelease|AnyCPU' ">
+    <OutputPath>bin\SignedRelease\</OutputPath>
+    <DefineConstants>TRACE;SIGNED</DefineConstants>
+    <DocumentationFile>bin\Release\Modbus.Extensions.XML</DocumentationFile>
+    <Optimize>true</Optimize>
+    <DebugType>pdbonly</DebugType>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <CodeAnalysisUseTypeNameInSuppression>true</CodeAnalysisUseTypeNameInSuppression>
+    <CodeAnalysisModuleSuppressionsFile>GlobalSuppressions.cs</CodeAnalysisModuleSuppressionsFile>
+    <ErrorReport>prompt</ErrorReport>
+    <SignAssembly>true</SignAssembly>
+    <AssemblyOriginatorKeyFile>..\..\NModbusPublic.snk</AssemblyOriginatorKeyFile>
+    <DelaySign>true</DelaySign>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="System" />
+    <Reference Include="System.Core">
+      <RequiredTargetFramework>3.5</RequiredTargetFramework>
+    </Reference>
+    <Reference Include="System.Xml.Linq">
+      <RequiredTargetFramework>3.5</RequiredTargetFramework>
+    </Reference>
+    <Reference Include="System.Data.DataSetExtensions">
+      <RequiredTargetFramework>3.5</RequiredTargetFramework>
+    </Reference>
+    <Reference Include="System.Data" />
+    <Reference Include="System.Xml" />
+    <Reference Include="Unme.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=da57c01ae4598fdd, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\lib\Unme\Unme.Common.dll</HintPath>
+    </Reference>
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="EnronModbus.cs" />
+    <Compile Include="Properties\AssemblyInfo.cs" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\Modbus\Modbus.csproj">
+      <Project>{FF96B252-2B24-44A1-A09C-6401B5D7ED23}</Project>
+      <Name>Modbus</Name>
+    </ProjectReference>
+  </ItemGroup>
+  <ItemGroup>
+    <None Include="..\..\NModbusPublic.snk">
+      <Link>NModbusPublic.snk</Link>
+    </None>
+  </ItemGroup>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
+       Other similar extension points exist, see Microsoft.Common.targets.
+  <Target Name="BeforeBuild">
+  </Target>
+  <Target Name="AfterBuild">
+  </Target>
+  -->
+</Project>
diff --git a/NModbus/src/Modbus.Extensions/Properties/AssemblyInfo.cs b/NModbus/src/Modbus.Extensions/Properties/AssemblyInfo.cs
@@ -0,0 +1,13 @@
+using System;
+using System.Reflection;
+using System.Runtime.InteropServices;
+
+[assembly: AssemblyTitle("Modbus.Extensions")]
+[assembly: AssemblyProduct("NModbus")]
+[assembly: AssemblyCopyright("Licensed under MIT License.")]
+[assembly: AssemblyDescription("Provides utiltiy extensions for the NModbus library.")]
+[assembly: ComVisible(false)]
+[assembly: CLSCompliant(false)]
+[assembly: Guid("A0218720-E559-434d-AB0D-CC03E6D69F46")]
+[assembly: AssemblyVersion("1.9.0.0")]
+[assembly: AssemblyFileVersion("1.9.0.0")]
diff --git a/NModbus/src/Modbus/Device/ModbusMaster.cs b/NModbus/src/Modbus/Device/ModbusMaster.cs
@@ -47,7 +47,7 @@ public bool[] ReadInputs(byte slaveAddress, ushort startAddress, ushort numberOf
 		}		
 
 		/// <summary>
-		/// Read contiguous block of holding registers.
+		/// Read contiguous block of 16 bit holding registers.
 		/// </summary>
 		/// <param name="slaveAddress">Address of device to read values from.</param>
 		/// <param name="startAddress">Address to begin reading.</param>
@@ -61,7 +61,7 @@ public ushort[] ReadHoldingRegisters(byte slaveAddress, ushort startAddress, ush
 		}
 
 		/// <summary>
-		/// Read contiguous block of input registers.
+		/// Read contiguous block of 16 bit input registers.
 		/// </summary>
 		/// <param name="slaveAddress">Address of device to read values from.</param>
 		/// <param name="startAddress">Address to begin reading.</param>
@@ -99,7 +99,7 @@ public void WriteSingleRegister(byte slaveAddress, ushort registerAddress, ushor
 		}
 
 		/// <summary>
-		/// Write a block of 1 to 123 contiguous registers.
+		/// Write a block of 1 to 123 contiguous 16 bit holding registers.
 		/// </summary>
 		/// <param name="slaveAddress">Address of the device to write to.</param>
 		/// <param name="startAddress">Address to begin writing values.</param>

diff --git a/NModbus/src/Modbus/Modbus.csproj b/NModbus/src/Modbus/Modbus.csproj
@@ -22,6 +22,7 @@
     <UseVSHostingProcess>true</UseVSHostingProcess>
     <DocumentationFile>bin\Debug\Modbus.XML</DocumentationFile>
     <AllowUnsafeBlocks>false</AllowUnsafeBlocks>
+    <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -46,6 +47,7 @@
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\..\NModbusPublic.snk</AssemblyOriginatorKeyFile>
     <DelaySign>true</DelaySign>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="log4net, Version=1.2.10.0, Culture=neutral, PublicKeyToken=1b44e1d426115821, processorArchitecture=MSIL">

diff --git a/NModbus/src/NModbus.sln b/NModbus/src/NModbus.sln
@@ -21,6 +21,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MySample", "MySample\MySamp
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FtdAdapter", "FtdAdapter\FtdAdapter.csproj", "{16FFB4F2-5556-439E-8729-92FB3425EF1F}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Modbus.Extensions", "Modbus.Extensions\Modbus.Extensions.csproj", "{667F4D2C-C9DF-4CC4-A1A6-768F6E879CE5}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -56,6 +58,12 @@ Global
 		{16FFB4F2-5556-439E-8729-92FB3425EF1F}.Release|Any CPU.Build.0 = Release|Any CPU
 		{16FFB4F2-5556-439E-8729-92FB3425EF1F}.SignedRelease|Any CPU.ActiveCfg = SignedRelease|Any CPU
 		{16FFB4F2-5556-439E-8729-92FB3425EF1F}.SignedRelease|Any CPU.Build.0 = SignedRelease|Any CPU
+		{667F4D2C-C9DF-4CC4-A1A6-768F6E879CE5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{667F4D2C-C9DF-4CC4-A1A6-768F6E879CE5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{667F4D2C-C9DF-4CC4-A1A6-768F6E879CE5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{667F4D2C-C9DF-4CC4-A1A6-768F6E879CE5}.Release|Any CPU.Build.0 = Release|Any CPU
+		{667F4D2C-C9DF-4CC4-A1A6-768F6E879CE5}.SignedRelease|Any CPU.ActiveCfg = Release|Any CPU
+		{667F4D2C-C9DF-4CC4-A1A6-768F6E879CE5}.SignedRelease|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE