-
Notifications
You must be signed in to change notification settings - Fork 0
/
N2kGroupFunction.cpp
449 lines (384 loc) · 19.9 KB
/
N2kGroupFunction.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
/*
N2kGroupFunction.cpp
Copyright (c) 2015-2020 Timo Lappalainen, Kave Oy, www.kave.fi
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include "N2kGroupFunction.h"
#include "NMEA2000.h"
#if !defined(N2K_NO_GROUP_FUNCTION_SUPPORT)
//*****************************************************************************
tN2kGroupFunctionHandler::tN2kGroupFunctionHandler(tNMEA2000 *_pNMEA2000, unsigned long _PGN) {
pNext=0;
pNMEA2000=_pNMEA2000;
PGN=_PGN;
Proprietary=tNMEA2000::IsProprietaryMessage(PGN);
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::Handle(const tN2kMsg &N2kMsg, tN2kGroupFunctionCode GroupFunctionCode, unsigned long PGNForGroupFunction, int iDev) {
if ( PGN!=PGNForGroupFunction && PGN!=0 ) return false;
bool handled=false;
uint16_t ManufacturerCode;
uint8_t IndustryGroup;
uint8_t UniqueID;
uint8_t NumberOfSelectionPairs;
uint8_t NumberOfParameterPairs;
switch (GroupFunctionCode) {
case N2kgfc_Request:
uint32_t TransmissionInterval;
uint16_t TransmissionIntervalOffset;
if (ParseRequestParams(N2kMsg,TransmissionInterval,TransmissionIntervalOffset,NumberOfParameterPairs)) {
handled=HandleRequest(N2kMsg,TransmissionInterval,TransmissionIntervalOffset,NumberOfParameterPairs,iDev);
}
break;
case N2kgfc_Command:
uint8_t PrioritySetting;
if ( tNMEA2000::IsBroadcast(N2kMsg.Destination) ) {
handled=true; // We can mark this handled, since command is not allowed to broadcast.
} else {
if (ParseCommandParams(N2kMsg,PrioritySetting,NumberOfParameterPairs)) {
handled=HandleCommand(N2kMsg,PrioritySetting,NumberOfParameterPairs,iDev);
}
}
break;
case N2kgfc_Acknowledge:
tN2kGroupFunctionPGNErrorCode PGNErrorCode;
tN2kGroupFunctionTransmissionOrPriorityErrorCode TransmissionOrPriorityErrorCode;
if (ParseAcknowledgeParams(N2kMsg,PGNErrorCode,TransmissionOrPriorityErrorCode,NumberOfParameterPairs)) {
handled=HandleAcknowledge(N2kMsg,PGNErrorCode,TransmissionOrPriorityErrorCode,NumberOfParameterPairs,iDev);
}
break;
case N2kgfc_Read:
if ( tNMEA2000::IsBroadcast(N2kMsg.Destination) ) {
handled=true; // We can mark this handled, since read is not allowed to broadcast.
} else {
if (ParseReadOrWriteParams(N2kMsg,ManufacturerCode,IndustryGroup,UniqueID,NumberOfSelectionPairs,NumberOfParameterPairs,Proprietary)) {
handled=HandleReadFields(N2kMsg,ManufacturerCode,IndustryGroup,UniqueID,NumberOfSelectionPairs,NumberOfParameterPairs,iDev);
}
}
break;
case N2kgfc_ReadReply:
handled=true;
break;
case N2kgfc_Write:
if ( tNMEA2000::IsBroadcast(N2kMsg.Destination) ) {
handled=true; // We can mark this handled, since write is not allowed to broadcast.
} else {
if (ParseReadOrWriteParams(N2kMsg,ManufacturerCode,IndustryGroup,UniqueID,NumberOfSelectionPairs,NumberOfParameterPairs,Proprietary)) {
handled=HandleWriteFields(N2kMsg,ManufacturerCode,IndustryGroup,UniqueID,NumberOfSelectionPairs,NumberOfParameterPairs,iDev);
}
}
break;
case N2kgfc_WriteReply:
handled=true;
break;
}
return handled;
}
//*****************************************************************************
tN2kGroupFunctionTransmissionOrPriorityErrorCode tN2kGroupFunctionHandler::GetRequestGroupFunctionTransmissionOrPriorityErrorCode(uint32_t TransmissionInterval) {
// In NMEA tests "C.3.13.2 Expanded Acknowledgment Message Timing" tool is Old
// and does not know interval 0xFFFFFFFE=Restore Default Interval. So to pass
// that test, that has to be commented out
return (TransmissionInterval==0xFFFFFFFF || TransmissionInterval==0xFFFFFFFE?
N2kgfTPec_Acknowledge:
N2kgfTPec_TransmitIntervalOrPriorityNotSupported);
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::HandleRequest(const tN2kMsg &N2kMsg,
uint32_t TransmissionInterval,
uint16_t /*TransmissionIntervalOffset*/,
uint8_t NumberOfParameterPairs,
int iDev) {
// As default we respond with not supported.
bool IsTxPGN=pNMEA2000->IsTxPGN(GetPGNForGroupFunction(N2kMsg),iDev);
tN2kGroupFunctionTransmissionOrPriorityErrorCode TORec=GetRequestGroupFunctionTransmissionOrPriorityErrorCode(TransmissionInterval);
tN2kGroupFunctionPGNErrorCode PGNec=(IsTxPGN?N2kgfPGNec_PGNTemporarilyNotAvailable:N2kgfPGNec_PGNNotSupported);
tN2kGroupFunctionParameterErrorCode PARec=N2kgfpec_Acknowledge;
if ( PGNec==N2kgfPGNec_PGNNotSupported ) TORec=N2kgfTPec_Acknowledge; // Always acknoledge for unknown PGN.
if ( PGNec==N2kgfPGNec_PGNTemporarilyNotAvailable ) {
if ( TORec==N2kgfTPec_TransmitIntervalOrPriorityNotSupported ) { // Acknowledge PGN for known PGN but for invalid priority
PGNec=N2kgfPGNec_Acknowledge;
} else {
TORec=N2kgfTPec_Acknowledge; //N2kgfTPec_RequestNotSupported;
}
}
if ( !tNMEA2000::IsBroadcast(N2kMsg.Destination) ) {
SendAcknowledge(pNMEA2000,N2kMsg.Source,iDev,GetPGNForGroupFunction(N2kMsg),
PGNec,
TORec,
NumberOfParameterPairs, PARec);
}
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::HandleCommand(const tN2kMsg &N2kMsg, uint8_t PrioritySetting, uint8_t NumberOfParameterPairs, int iDev) {
// As default we respond with not supported.
bool IsTxPGN=pNMEA2000->IsTxPGN(GetPGNForGroupFunction(N2kMsg),iDev);
tN2kGroupFunctionPGNErrorCode PGNec=(IsTxPGN?N2kgfPGNec_Acknowledge:N2kgfPGNec_PGNNotSupported);
tN2kGroupFunctionTransmissionOrPriorityErrorCode TORec=N2kgfTPec_Acknowledge;
tN2kGroupFunctionParameterErrorCode PARec=N2kgfpec_Acknowledge;
if (PrioritySetting != 0x08 || PrioritySetting != 0x0f || PrioritySetting != 0x09) TORec = N2kgfTPec_TransmitIntervalOrPriorityNotSupported;
SendAcknowledge(pNMEA2000,N2kMsg.Source,iDev,GetPGNForGroupFunction(N2kMsg),
PGNec,
TORec,
NumberOfParameterPairs, PARec);
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::HandleAcknowledge(const tN2kMsg &/*N2kMsg*/,
tN2kGroupFunctionPGNErrorCode /*PGNErrorCode*/,
tN2kGroupFunctionTransmissionOrPriorityErrorCode /*TransmissionOrPriorityErrorCode*/,
uint8_t /*ParameterCount*/,
int /*iDev*/) {
// As default, simply return true meaning that received acknowledge has been handled.
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::HandleReadFields(const tN2kMsg &N2kMsg,
uint16_t /*ManufacturerCode*/, // This will be set to 0xffff for non-propprietary PNGs
uint8_t /*IndustryGroup*/, // This will be set to 0xff for non-propprietary PNGs
uint8_t /*UniqueID*/,
uint8_t /*NumberOfSelectionPairs*/,
uint8_t NumberOfParameterPairs,
int iDev) {
// As default we respond with not supported.
bool IsTxPGN=pNMEA2000->IsTxPGN(GetPGNForGroupFunction(N2kMsg),iDev);
tN2kGroupFunctionPGNErrorCode PGNec=(IsTxPGN?N2kgfPGNec_ReadOrWriteNotSupported:N2kgfPGNec_PGNNotSupported);
SendAcknowledge(pNMEA2000,N2kMsg.Source,iDev,GetPGNForGroupFunction(N2kMsg),
PGNec,
N2kgfTPec_Acknowledge,
NumberOfParameterPairs, N2kgfpec_Acknowledge);
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::HandleReadFieldsReply(const tN2kMsg &/*N2kMsg*/,int /*iDev*/) {
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::HandleWriteFields(const tN2kMsg &N2kMsg,
uint16_t /*ManufacturerCode*/, // This will be set to 0xffff for non-propprietary PNGs
uint8_t /*IndustryGroup*/, // This will be set to 0xff for non-propprietary PNGs
uint8_t /*UniqueID*/,
uint8_t /*NumberOfSelectionPairs*/,
uint8_t NumberOfParameterPairs,
int iDev) {
// As default we respond with not supported.
bool IsTxPGN=pNMEA2000->IsTxPGN(GetPGNForGroupFunction(N2kMsg),iDev);
tN2kGroupFunctionPGNErrorCode PGNec=(IsTxPGN?N2kgfPGNec_ReadOrWriteNotSupported:N2kgfPGNec_PGNNotSupported);
SendAcknowledge(pNMEA2000,N2kMsg.Source,iDev,GetPGNForGroupFunction(N2kMsg),
PGNec,
N2kgfTPec_Acknowledge,
NumberOfParameterPairs, N2kgfpec_Acknowledge);
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::HandleWriteFieldsReply(const tN2kMsg &/*N2kMsg*/,int /*iDev*/) {
return true;
}
// Static functions for PGN 126208 handling
//*****************************************************************************
unsigned long tN2kGroupFunctionHandler::GetPGNForGroupFunction(const tN2kMsg &N2kMsg) {
int Index=1;
return N2kMsg.Get3ByteUInt(Index);
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::Parse(const tN2kMsg &N2kMsg,
tN2kGroupFunctionCode &GroupFunctionCode,
unsigned long &PGNForGroupFunction) {
if (N2kMsg.PGN!=126208L) return false;
GroupFunctionCode=(tN2kGroupFunctionCode)(N2kMsg.Data[0]);
PGNForGroupFunction=GetPGNForGroupFunction(N2kMsg);
return true;
}
#define N2kgf_OffsetToParams 4
#define N2kgf_OffsetToRequestPairParameters 11
#define N2kgf_OffsetToCommandPairParameters 6
//*****************************************************************************
bool tN2kGroupFunctionHandler::ParseRequestParams(const tN2kMsg &N2kMsg,
uint32_t &TransmissionInterval,
uint16_t &TransmissionIntervalOffset,
uint8_t &NumberOfParameterPairs) {
if (N2kMsg.PGN!=126208L) return false;
int Index=N2kgf_OffsetToParams;
TransmissionInterval=N2kMsg.Get4ByteUInt(Index);
TransmissionIntervalOffset=N2kMsg.Get2ByteUInt(Index);
NumberOfParameterPairs=N2kMsg.GetByte(Index);
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::StartParseRequestPairParameters(const tN2kMsg &N2kMsg, int &Index) {
if (N2kMsg.PGN!=126208L) return false;
Index=N2kgf_OffsetToRequestPairParameters;
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::ParseCommandParams(const tN2kMsg &N2kMsg,
uint8_t &PrioritySetting,
uint8_t &NumberOfParameterPairs) {
if (N2kMsg.PGN!=126208L) return false;
int Index=N2kgf_OffsetToParams;
PrioritySetting=N2kMsg.GetByte(Index);
NumberOfParameterPairs=N2kMsg.GetByte(Index);
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::StartParseCommandPairParameters(const tN2kMsg &N2kMsg, int &Index) {
if (N2kMsg.PGN!=126208L) return false;
Index=N2kgf_OffsetToCommandPairParameters;
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::ParseAcknowledgeParams(const tN2kMsg &N2kMsg,
tN2kGroupFunctionPGNErrorCode &PGNErrorCode,
tN2kGroupFunctionTransmissionOrPriorityErrorCode &TransmissionOrPriorityErrorCode,
uint8_t &NumberOfParameterPairs) {
PGNErrorCode=N2kgfPGNec_PGNNotSupported;
TransmissionOrPriorityErrorCode=N2kgfTPec_TransmitIntervalOrPriorityNotSupported;
NumberOfParameterPairs=0;
if (N2kMsg.PGN!=126208L) return false;
int Index=N2kgf_OffsetToParams;
uint8_t b=N2kMsg.GetByte(Index);
PGNErrorCode=(tN2kGroupFunctionPGNErrorCode)(b&0x0f);
TransmissionOrPriorityErrorCode=(tN2kGroupFunctionTransmissionOrPriorityErrorCode)(b>>4);
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::StartParseReadOrWriteParameters(const tN2kMsg &N2kMsg, bool Proprietary, int &Index) {
Index=N2kgf_OffsetToParams;
if ( Proprietary ) {
Index+=5;
} else {
Index+=3;
}
return true;
}
//*****************************************************************************
bool tN2kGroupFunctionHandler::ParseReadOrWriteParams(const tN2kMsg &N2kMsg,
uint16_t &ManufacturerCode,
uint8_t &IndustryGroup,
uint8_t &UniqueID,
uint8_t &NumberOfSelectionPairs,
uint8_t &NumberOfParameterPairs,
bool Proprietary) {
if (N2kMsg.PGN!=126208L) return false;
int Index=N2kgf_OffsetToParams;
ManufacturerCode=0xffff; // We need here information is PGN proprietary or not
IndustryGroup=0xff;
if ( Proprietary ) {
uint16_t ProprietaryInfo=N2kMsg.Get2ByteUInt(Index);
ManufacturerCode=ProprietaryInfo & 0x07ff;
IndustryGroup=(ProprietaryInfo>>13) &0x07;
}
UniqueID=N2kMsg.GetByte(Index);
NumberOfSelectionPairs=N2kMsg.GetByte(Index);
NumberOfParameterPairs=N2kMsg.GetByte(Index);
return true;
}
//*****************************************************************************
void SetStartReadOrWriteReply(tN2kMsg &N2kMsg, unsigned char Destination, unsigned long PGN, tN2kGroupFunctionCode cmd,
uint16_t ManufacturerCode,
uint8_t IndustryGroup,
uint8_t UniqueID,
uint8_t NumberOfSelectionPairs,
uint8_t NumberOfParameterPairs,
bool Proprietary) {
N2kMsg.SetPGN(126208L);
N2kMsg.Priority=3;
N2kMsg.Destination=Destination;
N2kMsg.AddByte(cmd);
N2kMsg.Add3ByteInt(PGN);
if ( Proprietary ) {
uint16_t ProprietaryInfo = IndustryGroup<<13 | 0x1800 | (ManufacturerCode & 0x07ff);
N2kMsg.Add2ByteUInt(ProprietaryInfo);
}
N2kMsg.AddByte(UniqueID);
N2kMsg.AddByte(NumberOfSelectionPairs);
N2kMsg.AddByte(NumberOfParameterPairs);
}
//*****************************************************************************
void tN2kGroupFunctionHandler::SetStartReadReply(tN2kMsg &N2kMsg, unsigned char Destination, unsigned long PGN,
uint16_t ManufacturerCode,
uint8_t IndustryGroup,
uint8_t UniqueID,
uint8_t NumberOfSelectionPairs,
uint8_t NumberOfParameterPairs,
bool Proprietary) {
SetStartReadOrWriteReply(N2kMsg,Destination,PGN,N2kgfc_ReadReply,
ManufacturerCode,IndustryGroup,UniqueID,NumberOfSelectionPairs,NumberOfParameterPairs,Proprietary
);
}
//*****************************************************************************
void tN2kGroupFunctionHandler::SetStartWriteReply(tN2kMsg &N2kMsg, unsigned char Destination, unsigned long PGN,
uint16_t ManufacturerCode,
uint8_t IndustryGroup,
uint8_t UniqueID,
uint8_t NumberOfSelectionPairs,
uint8_t NumberOfParameterPairs,
bool Proprietary) {
SetStartReadOrWriteReply(N2kMsg,Destination,PGN,N2kgfc_WriteReply,
ManufacturerCode,IndustryGroup,UniqueID,NumberOfSelectionPairs,NumberOfParameterPairs,Proprietary
);
}
//*****************************************************************************
void tN2kGroupFunctionHandler::SetStartAcknowledge(tN2kMsg &N2kMsg, unsigned char Destination, unsigned long PGN,
tN2kGroupFunctionPGNErrorCode PGNErrorCode,
tN2kGroupFunctionTransmissionOrPriorityErrorCode TransmissionOrPriorityErrorCode,
uint8_t NumberOfParameterPairs) {
N2kMsg.SetPGN(126208L);
N2kMsg.Priority=3;
N2kMsg.Destination=Destination;
N2kMsg.AddByte(N2kgfc_Acknowledge);
N2kMsg.Add3ByteInt(PGN);
N2kMsg.AddByte(PGNErrorCode | TransmissionOrPriorityErrorCode<<4);
N2kMsg.AddByte(NumberOfParameterPairs);
}
#define ErrorcodeIndex 4
//*****************************************************************************
void tN2kGroupFunctionHandler::ChangePNGErrorCode(tN2kMsg &N2kMsg, tN2kGroupFunctionPGNErrorCode PGNErrorCode) {
int Index=ErrorcodeIndex;
uint8_t ec=N2kMsg.GetByte(Index);
ec = (ec & 0xf0) | PGNErrorCode;
N2kMsg.Data[ErrorcodeIndex]=ec;
}
//*****************************************************************************
void tN2kGroupFunctionHandler::AddAcknowledgeParameter(tN2kMsg &N2kMsg,
uint8_t ParameterPairIndex,
tN2kGroupFunctionParameterErrorCode ErrorCode) {
if ( ((ParameterPairIndex % 2) == 0) && (N2kMsg.DataLen>0) ) {
N2kMsg.AddByte((uint8_t)(ErrorCode) | 0x0f << 4);
} else {
// Should actually add AddBits to N2kMsg
N2kMsg.Data[N2kMsg.DataLen-1]=(N2kMsg.Data[N2kMsg.DataLen-1] & 0x0f) | ((uint8_t)(ErrorCode) << 4);
}
}
//*****************************************************************************
void tN2kGroupFunctionHandler::SendAcknowledge(tNMEA2000 *pNMEA2000, unsigned char Destination, int iDev, unsigned long PGN,
tN2kGroupFunctionPGNErrorCode PGNErrorCode,
tN2kGroupFunctionTransmissionOrPriorityErrorCode TransmissionOrPriorityErrorCode,
uint8_t NumberOfParameterPairs,
tN2kGroupFunctionParameterErrorCode ParameterErrorCodeForAll) {
tN2kMsg N2kRMsg;
// As default we respond with not supported.
SetStartAcknowledge(N2kRMsg,Destination,PGN,
PGNErrorCode,
TransmissionOrPriorityErrorCode,
NumberOfParameterPairs);
for (uint8_t ParamIndex=0; ParamIndex<NumberOfParameterPairs;ParamIndex++) {
AddAcknowledgeParameter(N2kRMsg,ParamIndex,ParameterErrorCodeForAll);
}
pNMEA2000->SendMsg(N2kRMsg,iDev);
}
#endif