adds a new enum value to handle invalid APIFrameType

Author: LordVeovis

XBeeLibrary/Connection/DataReader.cs

@@ -353,7 +353,7 @@ private void PacketReceived(XBeePacket packet)
 			// Get the API packet type.
 			XBeeAPIPacket apiPacket = (XBeeAPIPacket)packet;
 			APIFrameType apiType = apiPacket.FrameType;
-			if (apiType == null)
+			if (apiType == APIFrameType.UNKNOWN)
 				return;
 
 			try
@@ -437,7 +437,7 @@ public RemoteXBeeDevice GetRemoteXBeeDeviceFromPacket(XBeeAPIPacket packet) /*th
 
 			XBeeAPIPacket apiPacket = (XBeeAPIPacket)packet;
 			APIFrameType apiType = apiPacket.FrameType;
-			if (apiType == null)
+			if (apiType == APIFrameType.UNKNOWN)
 				return null;
 
 			RemoteXBeeDevice remoteDevice = null;

XBeeLibrary/DigiPointDevice.cs

@@ -90,7 +90,7 @@ public DigiPointDevice(IConnectionInterface connectionInterface)
 		{
 		}
 
-		public void Open()/*throws XBeeException */{
+		public override void Open()/*throws XBeeException */{
 			base.Open();
 			if (IsRemote)
 				return;

XBeeLibrary/IO/IOSample.cs

@@ -297,34 +297,6 @@ public IDictionary<IOLine, IOValue> DigitalValues
 			}
 		}
 
-		/**
-		 * Returns the digital value of the provided IO line.
-		 * 
-		 * <p>
-		 * {@code IOLine}, use the method {@code hasDigitalValue(IOLine)}.</p>
-		 * 
-		 * <pre>
-		 * {@code
-		 * if (ioSample.hasDigitalValue(IOLine.DIO0_AD0)) {
-		 *     IOValue value = ioSample.getDigitalValue(IOLine.DIO0_AD0);
-		 *     ...
-		 * } else {
-		 *     ...
-		 * }
-		 * }
-		 * </pre>
-		 * 
-		 * @param ioLine 
-		 * 
-		 * @return The {@code IOValue} of the given IO line or {@code null} if the
-		 *         IO sample does not contain a digital value for the given IO line.
-		 * 
-		 * @see #getDigitalValues()
-		 * @see #hasDigitalValues()
-		 * @see IOLine
-		 * @see IOValue
-		 */
-		int e;
 		/// <summary>
 		/// Gets the digital value of the provided IO line.
 		/// </summary>

XBeeLibrary/Models/HardwareVersion.cs

@@ -5,7 +5,7 @@ namespace Kveer.XBeeApi.Models
 	/// <summary>
 	/// This class represents the hardware version number of an XBee device.
 	/// </summary>
-	public class HardwareVersion
+	public class HardwareVersion : IEquatable<HardwareVersion>
 	{
 		// Constants.
 		private const int HASH_SEED = 23;
@@ -66,14 +66,16 @@ public static HardwareVersion Get(int value, string description)
 
 		public override bool Equals(object obj)
 		{
-			if (!(obj is HardwareVersion))
-				return false;
+			var other = obj as HardwareVersion;
 
-			HardwareVersion hwVersion = (HardwareVersion)obj;
-			if (hwVersion.Value == Value
-					&& hwVersion.Description == Description)
-				return true;
-			return false;
+			return other != null && Equals(other);
+		}
+
+		public bool Equals(HardwareVersion other)
+		{
+			return other != null
+				&& other.Value == Value
+				&& other.Description == Description;
 		}
 
 		public override int GetHashCode()

XBeeLibrary/Packet/APIFrameType.cs

@@ -1,6 +1,7 @@
 using Kveer.XBeeApi.Utils;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.Contracts;
 using System.Linq;
 
 namespace Kveer.XBeeApi.Packet
@@ -28,6 +29,7 @@ public enum APIFrameType : byte
 		IO_DATA_SAMPLE_RX_INDICATOR = 0x92,
 		REMOTE_AT_COMMAND_RESPONSE = 0x97,
 		GENERIC = 0xFF,
+		UNKNOWN = 0xfe
 	}
 
 	public static class APIFrameTypeExtensions
@@ -69,14 +71,15 @@ public static APIFrameType Get(this APIFrameType dumb, byte value)
 			if (values.Cast<byte>().Contains(value))
 				return (APIFrameType)value;
 
-			return APIFrameType.GENERIC;
+			return APIFrameType.UNKNOWN;
 		}
 
 		/// <summary>
 		/// Gets the API frame type value.
 		/// </summary>
 		/// <param name="source"></param>
 		/// <returns>The API frame type value.</returns>
+		[Pure]
 		public static byte GetValue(this APIFrameType source)
 		{
 			return (byte)source;
@@ -89,7 +92,7 @@ public static byte GetValue(this APIFrameType source)
 		/// <returns>The API frame type name.</returns>
 		public static string GetName(this APIFrameType source)
 		{
-			return lookupTable[source];
+			return lookupTable.ContainsKey(source) ? lookupTable[source] : source.ToString();
 		}
 
 		public static string ToDisplayString(this APIFrameType source)

XBeeLibrary/Packet/XBeeAPIPacket.cs

@@ -44,8 +44,7 @@ public abstract class XBeeAPIPacket : XBeePacket
 		protected XBeeAPIPacket(APIFrameType frameType)
 			: base()
 		{
-
-			Contract.Requires<ArgumentNullException>(frameType != null, "Frame type cannot be null.");
+			Contract.Requires<ArgumentNullException>(frameType != APIFrameType.UNKNOWN, "Frame type cannot be unknown.");
 
 			this.FrameType = frameType;
 			FrameTypeValue = frameType.GetValue();

XBeeLibrary/Packet/XBeePacketParser.cs

@@ -254,7 +254,7 @@ private XBeePacket ParsePayload(byte[] payload) /*throws InvalidPacketException*
 			// Get the API frame type.
 			APIFrameType apiType = APIFrameType.GENERIC.Get(payload[0]);
 
-			if (apiType == null)
+			if (apiType == APIFrameType.UNKNOWN)
 				// Create unknown packet.
 				return UnknownXBeePacket.CreatePacket(payload);
 

XBeeLibrary/Packet/raw/RX16IOPacket.cs

@@ -68,7 +68,7 @@ public static RX16IOPacket CreatePacket(byte[] payload)
 			Contract.Requires<ArgumentNullException>(payload != null, "RX16 Address IO packet payload cannot be null.");
 			// 1 (Frame type) + 2 (16-bit address) + 1 (RSSI) + 1 (receive options)
 			Contract.Requires<ArgumentException>(payload.Length >= MIN_API_PAYLOAD_LENGTH, "Incomplete RX16 Address IO packet.");
-			Contract.Requires<ArgumentException>((payload[0] & 0xFF) == APIFrameType.RX_IO_16.GetValue(), "Payload is not a RX16 Address IO packet.");
+			Contract.Requires<ArgumentException>(payload[0] == APIFrameType.RX_IO_16.GetValue(), "Payload is not a RX16 Address IO packet.");
 
 			// payload[0] is the frame type.
 			int index = 1;