OSDP.Net 5.2.1
A .NET library for implementing the Open Supervised Device Protocol (OSDP)
Loading...
Searching...
No Matches
Message.cs
1using System;
2using System.Buffers.Binary;
3using System.Collections.Generic;
4using System.Linq;
5
6namespace OSDP.Net.Messages
7{
11 public abstract class Message
12 {
16 public const byte AddressMask = 0x7F;
17
21 public const byte StartOfMessage = 0x53;
22
26 public const ushort MsgTypeIndex = 5;
27
32 public const ushort MacSize = 4;
33
39 public const byte FirstPaddingByte = 0x80;
40
41 private static readonly ushort[] CrcTable =
42 [
43 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7, 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C,
44 0xD1AD, 0xE1CE, 0xF1EF, 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6, 0x9339, 0x8318,
45 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE, 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4,
46 0x5485, 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D, 0x3653, 0x2672, 0x1611, 0x0630,
47 0x76D7, 0x66F6, 0x5695, 0x46B4, 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC, 0x48C4,
48 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823, 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969,
49 0xA90A, 0xB92B, 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12, 0xDBFD, 0xCBDC, 0xFBBF,
50 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A, 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
51 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49, 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13,
52 0x2E32, 0x1E51, 0x0E70, 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78, 0x9188, 0x81A9,
53 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F, 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046,
54 0x6067, 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E, 0x02B1, 0x1290, 0x22F3, 0x32D2,
55 0x4235, 0x5214, 0x6277, 0x7256, 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D, 0x34E2,
56 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405, 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E,
57 0xC71D, 0xD73C, 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634, 0xD94C, 0xC96D, 0xF90E,
58 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB, 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
59 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A, 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1,
60 0x1AD0, 0x2AB3, 0x3A92, 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9, 0x7C26, 0x6C07,
61 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1, 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9,
62 0x9FF8, 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
63 ];
64
68 public byte Address { get; protected set; }
69
73 public MessageType MessageType { get; protected set; }
74
79 protected abstract ReadOnlySpan<byte> Data();
80
81 internal static byte[] ConvertShortToBytes(ushort value)
82 {
83 var byteArray = BitConverter.GetBytes(value);
84 if (!BitConverter.IsLittleEndian)
85 {
86 Array.Reverse(byteArray);
87 }
88
89 return byteArray;
90 }
91
92 internal static ushort ConvertBytesToUnsignedShort(ReadOnlySpan<byte> data, bool useLittleEndian = false)
93 {
94 return BitConverter.IsLittleEndian || useLittleEndian
95 ? BinaryPrimitives.ReadUInt16LittleEndian(data)
96 : BinaryPrimitives.ReadUInt16BigEndian(data);
97 }
98
99 internal static short ConvertBytesToShort(ReadOnlySpan<byte> data, bool useLittleEndian = false)
100 {
101 return BitConverter.IsLittleEndian || useLittleEndian
102 ? BinaryPrimitives.ReadInt16LittleEndian(data)
103 : BinaryPrimitives.ReadInt16BigEndian(data);
104 }
105
111 protected static ushort CalculateCrc(ReadOnlySpan<byte> packet)
112 {
113 ushort crc = 0x1D0F;
114 foreach (var t in packet)
115 {
116 crc = (ushort)((crc << 8) ^ CrcTable[((crc >> 8) ^ t) & 0xFF]);
117 }
118
119 return crc;
120 }
121
127 protected static byte CalculateChecksum(byte[] packet)
128 {
129 return (byte) (0x100 - packet.Aggregate(0, (source, element) => source + element) & 0xff);
130 }
131
137 protected static void AddPacketLength(Span<byte> packet, ushort additionalLength = 0)
138 {
139 var packetLength = ConvertShortToBytes((ushort)(packet.Length + additionalLength)).ToArray();
140 packet[2] = packetLength[0];
141 packet[3] = packetLength[1];
142 }
143
148 protected internal static void AddCrc(Span<byte> packet)
149 {
150 ushort crc = CalculateCrc(packet.Slice(0, packet.Length - 2));
151 var crcBytes = ConvertShortToBytes(crc).ToArray();
152 packet[packet.Length - 2] = crcBytes[0];
153 packet[packet.Length - 1] = crcBytes[1];
154 }
155
160 protected static void AddChecksum(IList<byte> packet)
161 {
162 packet[packet.Count - 1] = CalculateChecksum(packet.Take(packet.Count - 1).ToArray());
163 }
164
165 internal static int ConvertBytesToInt(byte[] bytes)
166 {
167 if (!BitConverter.IsLittleEndian)
168 {
169 Array.Reverse(bytes);
170 }
171
172 return BitConverter.ToInt32(bytes, 0);
173 }
174
175 internal static IEnumerable<byte> ConvertIntToBytes(int value)
176 {
177 var byteArray = BitConverter.GetBytes(value);
178 if (!BitConverter.IsLittleEndian)
179 {
180 Array.Reverse(byteArray);
181 }
182
183 return byteArray;
184 }
185
186 internal static bool BuildMultiPartMessageData(ushort wholeMessageSize, ushort offset, ushort lengthOfFragment,
187 ReadOnlySpan<byte> fragment, Span<byte> data)
188 {
189 fragment.CopyTo(data.Slice(offset, lengthOfFragment));
190
191 return wholeMessageSize == offset + lengthOfFragment;
192 }
193
202 public static ushort CalculateMaximumMessageSize(ushort dataSize, bool isEncrypted = false, ushort cryptoLength = 16)
203 {
204 const ushort clearTextDifference = 8;
205 const ushort encryptedDifference = 16;
206
207 return (ushort)(dataSize - (isEncrypted ? encryptedDifference + (dataSize % cryptoLength) : clearTextDifference));
208 }
209 }
210}
A base message class for sending or replying.
Definition Message.cs:12
const ushort MacSize
Size in bytes of MAC signature in message suffix when the secure channel has been established.
Definition Message.cs:32
static void AddChecksum(IList< byte > packet)
Adds the checksum to the packet.
Definition Message.cs:160
const ushort MsgTypeIndex
Index of command/reply code within the message header.
Definition Message.cs:26
static void AddPacketLength(Span< byte > packet, ushort additionalLength=0)
Calculates the length and adds it to the packet.
Definition Message.cs:137
const byte FirstPaddingByte
While padding bytes are generally 0x00, the first byte of padding is not.
Definition Message.cs:39
MessageType MessageType
Type of message.
Definition Message.cs:73
byte Address
Address assigned to the device.
Definition Message.cs:68
static ushort CalculateMaximumMessageSize(ushort dataSize, bool isEncrypted=false, ushort cryptoLength=16)
Calculates the largest payload that fits in a message of the given total size, accounting for the mes...
Definition Message.cs:202
static ushort CalculateCrc(ReadOnlySpan< byte > packet)
Calculates the CRC from the packet data.
Definition Message.cs:111
static byte CalculateChecksum(byte[] packet)
Calculates the checksum from the packet data.
Definition Message.cs:127
const byte AddressMask
OSDP message address mask.
Definition Message.cs:16
const byte StartOfMessage
OSDP message SOM (start of the message) byte.
Definition Message.cs:21
ReadOnlySpan< byte > Data()
The data.