-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathisobus_device_descriptor_object_pool.cpp
1236 lines (1110 loc) · 48.2 KB
/
isobus_device_descriptor_object_pool.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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//================================================================================================
/// @file isobus_device_descriptor_object_pool.cpp
///
/// @brief Implements an interface for creating a Task Controller DDOP.
/// @author Adrian Del Grosso
///
/// @copyright 2023 The Open-Agriculture Developers
//================================================================================================
#include "isobus_device_descriptor_object_pool.hpp"
#include "can_constants.hpp"
#include "can_stack_logger.hpp"
#include "platform_endianness.hpp"
#include "to_string.hpp"
#include <algorithm>
#include <cassert>
#include <cstring>
#include <iomanip>
#include <sstream>
namespace isobus
{
DeviceDescriptorObjectPool::DeviceDescriptorObjectPool(std::uint8_t taskControllerServerVersion) :
taskControllerCompatibilityLevel(taskControllerServerVersion)
{
assert(taskControllerCompatibilityLevel <= MAX_TC_VERSION_SUPPORTED);
}
bool DeviceDescriptorObjectPool::add_device(std::string deviceDesignator,
std::string deviceSoftwareVersion,
std::string deviceSerialNumber,
std::string deviceStructureLabel,
std::array<std::uint8_t, task_controller_object::DeviceObject::MAX_STRUCTURE_AND_LOCALIZATION_LABEL_LENGTH> deviceLocalizationLabel,
std::vector<std::uint8_t> deviceExtendedStructureLabel,
std::uint64_t clientIsoNAME)
{
bool retVal = true;
for (auto ¤tObject : objectList)
{
if (task_controller_object::ObjectTypes::Device == currentObject->get_object_type())
{
retVal = false;
break;
}
}
if (retVal)
{
if ((taskControllerCompatibilityLevel < MAX_TC_VERSION_SUPPORTED) &&
(deviceDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_WARNING("[DDOP]: Device designator " +
deviceDesignator +
" is greater than the max byte length of 32. Value will be truncated.");
deviceDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(deviceDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LENGTH))
{
LOG_WARNING("[DDOP]: Device designator " +
deviceDesignator +
" is greater than the max byte length of 128. Value will be truncated.");
deviceDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(deviceDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_INFO("[DDOP]: Device designator " +
deviceDesignator +
" byte length is greater than the max character count of 32. " +
"This is only acceptable if you have 32 or fewer UTF-8 characters!" +
" Please verify your DDOP configuration meets this requirement.");
}
if ((taskControllerCompatibilityLevel < MAX_TC_VERSION_SUPPORTED) &&
(deviceSerialNumber.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_WARNING("[DDOP]: Device serial number " +
deviceSerialNumber +
" is greater than the max byte length of 32. Value will be truncated.");
deviceSerialNumber.resize(task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(deviceSerialNumber.size() > task_controller_object::Object::MAX_DESIGNATOR_LENGTH))
{
LOG_WARNING("[DDOP]: Device serial number " +
deviceSerialNumber +
" is greater than the max byte length of 128. Value will be truncated.");
deviceSerialNumber.resize(task_controller_object::Object::MAX_DESIGNATOR_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(deviceSerialNumber.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_INFO("[DDOP]: Device serial number " +
deviceSerialNumber +
" byte length is greater than the max character count of 32. " +
"This is only acceptable if you have 32 or fewer UTF-8 characters!" +
" Please verify your DDOP configuration meets this requirement.");
}
if (deviceStructureLabel.size() > task_controller_object::DeviceObject::MAX_STRUCTURE_AND_LOCALIZATION_LABEL_LENGTH)
{
LOG_WARNING("[DDOP]: Device structure label " +
deviceStructureLabel +
" is greater than the max length of 7. Value will be truncated.");
deviceStructureLabel.resize(task_controller_object::DeviceObject::MAX_STRUCTURE_AND_LOCALIZATION_LABEL_LENGTH);
}
if (deviceExtendedStructureLabel.size() > task_controller_object::DeviceObject::MAX_EXTENDED_STRUCTURE_LABEL_LENGTH)
{
LOG_WARNING("[DDOP]: Device extended structure label is greater than the max length of 32. Value will be truncated.");
deviceExtendedStructureLabel.resize(task_controller_object::DeviceObject::MAX_EXTENDED_STRUCTURE_LABEL_LENGTH);
}
if (deviceLocalizationLabel[6] != 0xFF)
{
LOG_WARNING("[DDOP]: Device localization label byte 7 must be the reserved value 0xFF. This value will be enforced when DDOP binary is generated.");
}
objectList.emplace_back(new task_controller_object::DeviceObject(deviceDesignator,
deviceSoftwareVersion,
deviceSerialNumber,
deviceStructureLabel,
deviceLocalizationLabel,
deviceExtendedStructureLabel,
clientIsoNAME,
(taskControllerCompatibilityLevel >= 4)));
}
else
{
LOG_ERROR("[DDOP]: Cannot add more than 1 Device object to a DDOP.");
}
return retVal;
}
bool DeviceDescriptorObjectPool::add_device_element(std::string deviceElementDesignator,
std::uint16_t deviceElementNumber,
std::uint16_t parentObjectID,
task_controller_object::DeviceElementObject::Type deviceElementType,
std::uint16_t uniqueID)
{
bool retVal = check_object_id_unique(uniqueID);
if (retVal)
{
// Object will be added
// Check for warnings
if ((taskControllerCompatibilityLevel < MAX_TC_VERSION_SUPPORTED) &&
(deviceElementDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_WARNING("[DDOP]: Device element designator " +
deviceElementDesignator +
" is greater than the max length of 32. Value will be truncated.");
deviceElementDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH);
}
if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(deviceElementDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LENGTH))
{
LOG_WARNING("[DDOP]: Device element designator " +
deviceElementDesignator +
" is greater than the max length of 128. Value will be truncated.");
deviceElementDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LENGTH);
}
objectList.emplace_back(new task_controller_object::DeviceElementObject(deviceElementDesignator,
deviceElementNumber,
parentObjectID,
deviceElementType,
uniqueID));
}
else
{
LOG_ERROR("[DDOP]: Device element ID " +
isobus::to_string(static_cast<int>(uniqueID)) +
" is not unique. Object will not be added to the DDOP.");
}
return retVal;
}
bool DeviceDescriptorObjectPool::add_device_process_data(std::string processDataDesignator,
std::uint16_t processDataDDI,
std::uint16_t deviceValuePresentationObjectID,
std::uint8_t processDataProperties,
std::uint8_t processDataTriggerMethods,
std::uint16_t uniqueID)
{
bool retVal = check_object_id_unique(uniqueID);
if (retVal)
{
// Object will be added
// Check for warnings
if ((processDataProperties & 0x02) && (processDataProperties & 0x04))
{
LOG_WARNING("[DDOP]: Process data object " +
isobus::to_string(static_cast<int>(uniqueID)) +
" has mutually exclusive options 'settable' and 'control source' set.");
}
if ((taskControllerCompatibilityLevel < MAX_TC_VERSION_SUPPORTED) &&
(processDataDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_WARNING("[DDOP]: Device process data designator " +
processDataDesignator +
" is greater than the max byte length of 32. Value will be truncated.");
processDataDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(processDataDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LENGTH))
{
LOG_WARNING("[DDOP]: Device process data designator " +
processDataDesignator +
" is greater than the max byte length of 128. Value will be truncated.");
processDataDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(processDataDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_INFO("[DDOP]: Device process data designator " +
processDataDesignator +
" byte length is greater than the max character count of 32. " +
"This is only acceptable if you have 32 or fewer UTF-8 characters!" +
" Please verify your DDOP configuration meets this requirement.");
}
objectList.emplace_back(new task_controller_object::DeviceProcessDataObject(processDataDesignator,
processDataDDI,
deviceValuePresentationObjectID,
processDataProperties,
processDataTriggerMethods,
uniqueID));
}
else
{
LOG_ERROR("[DDOP]: Device process data ID " +
isobus::to_string(static_cast<int>(uniqueID)) +
" is not unique. Object will not be added to the DDOP.");
}
return retVal;
}
bool DeviceDescriptorObjectPool::add_device_property(std::string propertyDesignator,
std::int32_t propertyValue,
std::uint16_t propertyDDI,
std::uint16_t valuePresentationObject,
std::uint16_t uniqueID)
{
bool retVal = check_object_id_unique(uniqueID);
if (retVal)
{
// Object will be added
// Check for warnings
if ((taskControllerCompatibilityLevel < MAX_TC_VERSION_SUPPORTED) &&
(propertyDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_WARNING("[DDOP]: Device property designator " +
propertyDesignator +
" is greater than the max byte length of 32. Value will be truncated.");
propertyDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(propertyDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LENGTH))
{
LOG_WARNING("[DDOP]: Device property designator " +
propertyDesignator +
" is greater than the max byte length of 128. Value will be truncated.");
propertyDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(propertyDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_INFO("[DDOP]: Device property designator " +
propertyDesignator +
" byte length is greater than the max character count of 32. " +
"This is only acceptable if you have 32 or fewer UTF-8 characters!" +
" Please verify your DDOP configuration meets this requirement.");
}
objectList.emplace_back(new task_controller_object::DevicePropertyObject(propertyDesignator,
propertyValue,
propertyDDI,
valuePresentationObject,
uniqueID));
}
else
{
LOG_ERROR("[DDOP]: Device property ID " +
isobus::to_string(static_cast<int>(uniqueID)) +
" is not unique. Object will not be added to the DDOP.");
}
return retVal;
}
bool DeviceDescriptorObjectPool::add_device_value_presentation(std::string unitDesignator,
std::int32_t offsetValue,
float scaleFactor,
std::uint8_t numberDecimals,
std::uint16_t uniqueID)
{
bool retVal = check_object_id_unique(uniqueID);
if (retVal)
{
// Object will be added
// Check for warnings
if ((taskControllerCompatibilityLevel < MAX_TC_VERSION_SUPPORTED) &&
(unitDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_WARNING("[DDOP]: Device value presentation unit designator " +
unitDesignator +
" is greater than the max byte length of 32. Value will be truncated.");
unitDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(unitDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LENGTH))
{
LOG_WARNING("[DDOP]: Device value presentation unit designator " +
unitDesignator +
" is greater than the max byte length of 128. Value will be truncated.");
unitDesignator.resize(task_controller_object::Object::MAX_DESIGNATOR_LENGTH);
}
else if ((taskControllerCompatibilityLevel == MAX_TC_VERSION_SUPPORTED) &&
(unitDesignator.size() > task_controller_object::Object::MAX_DESIGNATOR_LEGACY_LENGTH))
{
LOG_INFO("[DDOP]: Device value presentation unit designator " +
unitDesignator +
" byte length is greater than the max character count of 32. " +
"This is only acceptable if you have 32 or fewer UTF-8 characters!" +
" Please verify your DDOP configuration meets this requirement.");
}
objectList.emplace_back(new task_controller_object::DeviceValuePresentationObject(unitDesignator,
offsetValue,
scaleFactor,
numberDecimals,
uniqueID));
}
else
{
LOG_ERROR("[DDOP]: Device value presentation object ID " +
isobus::to_string(static_cast<int>(uniqueID)) +
" is not unique. Object will not be added to the DDOP.");
}
return retVal;
}
bool DeviceDescriptorObjectPool::deserialize_binary_object_pool(std::vector<std::uint8_t> &binaryPool, NAME clientNAME)
{
return deserialize_binary_object_pool(binaryPool.data(), static_cast<std::uint32_t>(binaryPool.size()), clientNAME);
}
bool DeviceDescriptorObjectPool::deserialize_binary_object_pool(const std::uint8_t *binaryPool, std::uint32_t binaryPoolSizeBytes, NAME clientNAME)
{
bool retVal = true;
if ((nullptr != binaryPool) && (0 != binaryPoolSizeBytes))
{
LOG_DEBUG("[DDOP]: Attempting to deserialize a binary object pool with size %u.", binaryPoolSizeBytes);
clear();
// Iterate over the DDOP and convert to objects.
// Using the size to track how much is left to process.
while (0 != binaryPoolSizeBytes)
{
// Verify there's enough data to read the XML namespace
if (binaryPoolSizeBytes > 3)
{
std::string xmlNameSpace;
xmlNameSpace.push_back(static_cast<char>(binaryPool[0]));
xmlNameSpace.push_back(static_cast<char>(binaryPool[1]));
xmlNameSpace.push_back(static_cast<char>(binaryPool[2]));
if ("DVC" == xmlNameSpace)
{
// Process a Device Object
std::uint8_t numberDesignatorBytes = 0; // Labelled "N" in 11783-10 table A.1
std::uint8_t numberSoftwareVersionBytes = 0; // Labelled "M" in 11783-10 table A.1
std::uint8_t numberDeviceSerialNumberBytes = 0; // Labelled "O" in 11783-10 table A.1
std::uint8_t numberExtendedStructureLabelBytes = 0; // Version 4+ only
if ((binaryPoolSizeBytes >= 6) &&
(binaryPool[5] < 128))
{
numberDesignatorBytes = binaryPool[5];
}
else
{
LOG_ERROR("[DDOP]: Binary device object designator has invalid length.");
retVal = false;
}
if ((binaryPoolSizeBytes >= static_cast<std::uint32_t>(7 + numberDesignatorBytes)) &&
(binaryPool[6 + numberDesignatorBytes] < 128))
{
numberSoftwareVersionBytes = binaryPool[6 + numberDesignatorBytes];
}
else
{
LOG_ERROR("[DDOP]: Binary device object software version has invalid length.");
retVal = false;
}
if ((binaryPoolSizeBytes >= static_cast<std::uint32_t>(16 + numberDesignatorBytes + numberSoftwareVersionBytes)) &&
(binaryPool[15 + numberDesignatorBytes + numberSoftwareVersionBytes] < 128))
{
numberDeviceSerialNumberBytes = binaryPool[15 + numberDesignatorBytes + numberSoftwareVersionBytes];
}
else
{
LOG_ERROR("[DDOP]: Binary device object serial number has invalid length.");
retVal = false;
}
if (taskControllerCompatibilityLevel >= 4)
{
if ((binaryPoolSizeBytes >= static_cast<std::uint32_t>(31 + numberDeviceSerialNumberBytes + numberDesignatorBytes + numberSoftwareVersionBytes)) &&
(binaryPool[30 + numberDeviceSerialNumberBytes + numberDesignatorBytes + numberSoftwareVersionBytes] <= 32))
{
numberExtendedStructureLabelBytes = binaryPool[30 + numberDeviceSerialNumberBytes + numberDesignatorBytes + numberSoftwareVersionBytes];
}
else
{
LOG_ERROR("[DDOP]: Binary device object with version 4 contains invalid extended structure label length.");
retVal = false;
}
}
std::uint32_t expectedSize = (31 + numberDeviceSerialNumberBytes + numberDesignatorBytes + numberSoftwareVersionBytes + numberExtendedStructureLabelBytes);
if (taskControllerCompatibilityLevel < 4)
{
expectedSize--; // One byte less due to no extended structure label length
}
if ((binaryPoolSizeBytes >= expectedSize) && retVal)
{
std::string deviceDesignator;
std::string deviceSoftwareVersion;
std::string deviceSerialNumber;
std::string deviceStructureLabel;
std::array<std::uint8_t, 7> localizationLabel;
std::vector<std::uint8_t> extendedStructureLabel;
std::uint64_t ddopClientNAME = 0;
for (std::uint16_t i = 0; i < numberDesignatorBytes; i++)
{
deviceDesignator.push_back(binaryPool[6 + i]);
}
for (std::uint16_t i = 0; i < numberSoftwareVersionBytes; i++)
{
deviceSoftwareVersion.push_back(binaryPool[7 + numberDesignatorBytes + i]);
}
for (std::uint8_t i = 0; i < 8; i++)
{
std::uint64_t currentNameByte = binaryPool[7 + numberDesignatorBytes + numberSoftwareVersionBytes + i];
ddopClientNAME |= (currentNameByte << (8 * i));
}
if ((0 != clientNAME.get_full_name()) && (ddopClientNAME != clientNAME.get_full_name()))
{
LOG_ERROR("[DDOP]: Failed adding deserialized device object. DDOP NAME doesn't match client's actual NAME.");
retVal = false;
}
else if (0 == clientNAME.get_full_name())
{
clientNAME.set_full_name(ddopClientNAME);
}
for (std::uint16_t i = 0; i < numberDeviceSerialNumberBytes; i++)
{
deviceSerialNumber.push_back(binaryPool[16 + numberDesignatorBytes + numberSoftwareVersionBytes + i]);
}
for (std::uint16_t i = 0; i < 7; i++)
{
deviceStructureLabel.push_back(binaryPool[16 + numberDeviceSerialNumberBytes + numberDesignatorBytes + numberSoftwareVersionBytes + i]);
}
for (std::uint16_t i = 0; i < 7; i++)
{
localizationLabel.at(i) = (binaryPool[23 + numberDeviceSerialNumberBytes + numberDesignatorBytes + numberSoftwareVersionBytes + i]);
}
for (std::uint16_t i = 0; i < numberExtendedStructureLabelBytes; i++)
{
extendedStructureLabel.push_back(binaryPool[31 + numberDeviceSerialNumberBytes + numberDesignatorBytes + numberSoftwareVersionBytes + i]);
}
if (add_device(deviceDesignator, deviceSoftwareVersion, deviceSerialNumber, deviceStructureLabel, localizationLabel, extendedStructureLabel, clientNAME.get_full_name()))
{
binaryPoolSizeBytes -= expectedSize;
binaryPool += expectedSize;
}
else
{
LOG_ERROR("[DDOP]: Failed adding deserialized device object. DDOP schema is not valid.");
retVal = false;
}
}
else
{
LOG_ERROR("[DDOP]: Not enough binary DDOP data left to parse device object. DDOP schema is not valid");
retVal = false;
}
}
else if ("DET" == xmlNameSpace)
{
// Process a device element object
std::uint8_t numberDesignatorBytes = 0;
std::uint8_t numberOfObjectIDs = 0;
if (binaryPoolSizeBytes >= 7)
{
numberDesignatorBytes = binaryPool[6];
}
else
{
LOG_ERROR("[DDOP]: Binary device element object has invalid length.");
retVal = false;
}
if (binaryPoolSizeBytes >= static_cast<std::uint32_t>(12 + numberDesignatorBytes))
{
numberOfObjectIDs = binaryPool[11 + numberDesignatorBytes];
}
else
{
LOG_ERROR("[DDOP]: Binary device element object has invalid length to process referenced object IDs.");
retVal = false;
}
if (binaryPool[5] > static_cast<std::uint8_t>(task_controller_object::DeviceElementObject::Type::NavigationReference))
{
LOG_ERROR("[DDOP]: Binary device element object has invalid element type.");
retVal = false;
}
std::uint32_t expectedSize = (13 + (2 * numberOfObjectIDs) + numberDesignatorBytes);
if ((binaryPoolSizeBytes >= expectedSize) && retVal)
{
std::string deviceElementDesignator;
std::uint16_t parentObject = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[9 + numberDesignatorBytes]) | (static_cast<std::uint16_t>(binaryPool[10 + numberDesignatorBytes]) << 8));
std::uint16_t uniqueID = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[3]) | (static_cast<std::uint16_t>(binaryPool[4]) << 8));
std::uint16_t elementNumber = static_cast<std::uint16_t>(binaryPool[7 + numberDesignatorBytes]) | (static_cast<std::uint16_t>(binaryPool[8 + numberDesignatorBytes]) << 8);
auto type = static_cast<task_controller_object::DeviceElementObject::Type>(binaryPool[5]);
for (std::uint16_t i = 0; i < numberDesignatorBytes; i++)
{
deviceElementDesignator.push_back(binaryPool[7 + i]);
}
if (add_device_element(deviceElementDesignator, elementNumber, parentObject, type, uniqueID))
{
auto DETObject = std::static_pointer_cast<task_controller_object::DeviceElementObject>(get_object_by_id(uniqueID));
if (nullptr != DETObject)
{
for (std::uint8_t i = 0; i < numberOfObjectIDs; i++)
{
std::uint16_t childID = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[13 + (2 * i) + numberDesignatorBytes]) | (static_cast<std::uint16_t>(binaryPool[14 + (2 * i) + numberDesignatorBytes]) << 8));
DETObject->add_reference_to_child_object(childID);
}
}
binaryPoolSizeBytes -= expectedSize;
binaryPool += expectedSize;
}
else
{
LOG_ERROR("[DDOP]: Failed adding deserialized device element object. DDOP schema is not valid.");
retVal = false;
}
}
else
{
LOG_ERROR("[DDOP]: Not enough binary DDOP data left to parse device element object. DDOP schema is not valid");
retVal = false;
}
}
else if ("DPD" == xmlNameSpace)
{
// Process a device process data object
std::uint8_t numberDesignatorBytes = 0;
if ((binaryPoolSizeBytes >= 10) &&
(binaryPool[9] < 128))
{
numberDesignatorBytes = binaryPool[9];
}
else
{
LOG_ERROR("[DDOP]: Binary device process data object has invalid length.");
retVal = false;
}
std::uint32_t expectedSize = (12 + numberDesignatorBytes);
if ((binaryPoolSizeBytes >= expectedSize) && retVal)
{
std::string processDataDesignator;
std::uint16_t DDI = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[5]) | (static_cast<std::uint16_t>(binaryPool[6]) << 8));
std::uint16_t uniqueID = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[3]) | (static_cast<std::uint16_t>(binaryPool[4]) << 8));
std::uint16_t presentationObjectID = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[10 + numberDesignatorBytes]) | (static_cast<std::uint16_t>(binaryPool[11 + numberDesignatorBytes]) << 8));
for (std::uint16_t i = 0; i < numberDesignatorBytes; i++)
{
processDataDesignator.push_back(binaryPool[10 + i]);
}
if (add_device_process_data(processDataDesignator, DDI, presentationObjectID, binaryPool[7], binaryPool[8], uniqueID))
{
binaryPoolSizeBytes -= expectedSize;
binaryPool += expectedSize;
}
else
{
LOG_ERROR("[DDOP]: Failed adding deserialized device process data object. DDOP schema is not valid.");
retVal = false;
}
}
else
{
LOG_ERROR("[DDOP]: Not enough binary DDOP data left to parse device process data object. DDOP schema is not valid");
retVal = false;
}
}
else if ("DPT" == xmlNameSpace)
{
std::uint8_t numberDesignatorBytes = 0;
if ((binaryPoolSizeBytes >= 12) &&
(binaryPool[11] < 128))
{
numberDesignatorBytes = binaryPool[11];
}
else
{
LOG_ERROR("[DDOP]: Binary device property object has invalid length.");
retVal = false;
}
std::uint32_t expectedSize = (14 + numberDesignatorBytes);
if ((binaryPoolSizeBytes >= expectedSize) && retVal)
{
std::string designator;
std::int32_t propertyValue = static_cast<std::int32_t>(binaryPool[7]) |
(static_cast<std::int32_t>(binaryPool[8]) << 8) |
(static_cast<std::int32_t>(binaryPool[9]) << 16) |
(static_cast<std::int32_t>(binaryPool[10]) << 24);
std::uint16_t DDI = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[5]) | (static_cast<std::uint16_t>(binaryPool[6]) << 8));
std::uint16_t uniqueID = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[3]) | (static_cast<std::uint16_t>(binaryPool[4]) << 8));
std::uint16_t presentationObjectID = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[12 + numberDesignatorBytes]) | (static_cast<std::uint16_t>(binaryPool[13 + numberDesignatorBytes]) << 8));
for (std::uint16_t i = 0; i < numberDesignatorBytes; i++)
{
designator.push_back(binaryPool[12 + i]);
}
if (add_device_property(designator, propertyValue, DDI, presentationObjectID, uniqueID))
{
binaryPoolSizeBytes -= expectedSize;
binaryPool += expectedSize;
}
else
{
LOG_ERROR("[DDOP]: Failed adding deserialized device property object. DDOP schema is not valid.");
retVal = false;
}
}
else
{
LOG_ERROR("[DDOP]: Not enough binary DDOP data left to parse device property object. DDOP schema is not valid");
retVal = false;
}
}
else if ("DVP" == xmlNameSpace)
{
std::uint8_t numberDesignatorBytes = 0;
if ((binaryPoolSizeBytes >= 15) &&
(binaryPool[14] < 128))
{
numberDesignatorBytes = binaryPool[14];
}
else
{
LOG_ERROR("[DDOP]: Binary device value presentation object has invalid length.");
retVal = false;
}
std::uint32_t expectedSize = (15 + numberDesignatorBytes);
if ((binaryPoolSizeBytes >= expectedSize) && retVal)
{
std::string designator;
std::int32_t offset = static_cast<std::int32_t>(binaryPool[5]) |
(static_cast<std::int32_t>(binaryPool[6]) << 8) |
(static_cast<std::int32_t>(binaryPool[7]) << 16) |
(static_cast<std::int32_t>(binaryPool[8]) << 24);
std::array<std::uint8_t, sizeof(float)> scaleBytes = {
binaryPool[9],
binaryPool[10],
binaryPool[11],
binaryPool[12],
};
float scale = 0.0f;
std::uint16_t uniqueID = static_cast<std::uint16_t>(static_cast<std::uint16_t>(binaryPool[3]) | (static_cast<std::uint16_t>(binaryPool[4]) << 8));
if (is_big_endian())
{
std::reverse(scaleBytes.begin(), scaleBytes.end());
}
memcpy(&scale, scaleBytes.data(), sizeof(float));
for (std::uint16_t i = 0; i < numberDesignatorBytes; i++)
{
designator.push_back(binaryPool[15 + i]);
}
if (add_device_value_presentation(designator, offset, scale, binaryPool[13], uniqueID))
{
binaryPoolSizeBytes -= expectedSize;
binaryPool += expectedSize;
}
else
{
LOG_ERROR("[DDOP]: Failed adding deserialized device value presentation object. DDOP schema is not valid.");
retVal = false;
}
}
else
{
LOG_ERROR("[DDOP]: Not enough binary DDOP data left to parse device value presentation object. DDOP schema is not valid");
retVal = false;
}
}
else
{
LOG_ERROR("[DDOP]: Cannot process an unknown XML namespace from binary DDOP. DDOP schema is invalid.");
retVal = false;
}
}
else
{
retVal = false;
}
if (!retVal)
{
LOG_ERROR("[DDOP]: Binary DDOP deserialization aborted.");
break;
}
}
}
else
{
retVal = false;
LOG_ERROR("[DDOP]: Cannot deserialize a DDOP with zero length.");
}
return retVal;
}
bool DeviceDescriptorObjectPool::generate_binary_object_pool(std::vector<std::uint8_t> &resultantPool)
{
bool retVal = true;
resultantPool.clear();
if (taskControllerCompatibilityLevel > MAX_TC_VERSION_SUPPORTED)
{
LOG_WARNING("[DDOP]: A DDOP is being generated for a TC version that is unsupported. This may cause issues.");
}
if (resolve_parent_ids_to_objects())
{
retVal = true;
for (auto ¤tObject : objectList)
{
auto objectBinary = currentObject->get_binary_object();
if (!objectBinary.empty())
{
resultantPool.insert(resultantPool.end(), objectBinary.begin(), objectBinary.end());
}
else
{
LOG_ERROR("[DDOP]: Failed to create all object binaries. Your DDOP is invalid.");
retVal = false;
break;
}
}
}
else
{
LOG_ERROR("[DDOP]: Failed to resolve all object IDs in DDOP. Your DDOP contains invalid object references.");
retVal = false;
}
return retVal;
}
bool DeviceDescriptorObjectPool::generate_task_data_iso_xml(std::string &resultantString)
{
bool retVal = true;
resultantString.clear();
if (taskControllerCompatibilityLevel > MAX_TC_VERSION_SUPPORTED)
{
LOG_WARNING("[DDOP]: An XML DDOP is being generated for a TC version that is unsupported. This may cause issues.");
}
if (resolve_parent_ids_to_objects())
{
std::ostringstream xmlOutput;
std::ios initialStreamFormat(NULL);
std::size_t numberOfDevices = 1;
std::size_t numberOfElements = 1;
initialStreamFormat.copyfmt(xmlOutput);
retVal = true;
xmlOutput << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" << std::endl;
xmlOutput << "<ISO11783_TaskData VersionMajor=\"3\" VersionMinor=\"0\" DataTransferOrigin=\"1\">" << std::endl;
// Find the device object, which will be the first object written
for (std::size_t i = 0; i < size(); i++)
{
auto currentObject = get_object_by_index(static_cast<std::uint16_t>(i));
if ((nullptr != currentObject) &&
(task_controller_object::ObjectTypes::Device == currentObject->get_object_type()))
{
// Found device
auto rootDevice = std::static_pointer_cast<task_controller_object::DeviceObject>(currentObject);
xmlOutput << "<DVC A=\"DVC-" << static_cast<int>(numberOfDevices);
numberOfDevices++;
xmlOutput << "\" B=\"" << rootDevice->get_designator();
xmlOutput << "\" C=\"" << rootDevice->get_software_version();
xmlOutput << "\" D=\"" << std::uppercase << std::hex << std::setfill('0') << std::setw(16) << static_cast<unsigned long long int>(rootDevice->get_iso_name());
xmlOutput.copyfmt(initialStreamFormat);
xmlOutput << "\" E=\"" << rootDevice->get_serial_number();
xmlOutput << "\" F=\"";
auto lStructureLabel = rootDevice->get_structure_label();
for (std::uint8_t j = 0; j < 7; j++)
{
std::uint8_t structureByte = static_cast<std::uint8_t>(lStructureLabel.at(6 - j));
xmlOutput << std::uppercase << std::hex << std::setfill('0') << std::setw(2) << static_cast<unsigned int>(structureByte);
}
xmlOutput << "\" G=\"";
for (std::uint_fast8_t j = 0; j < 7; j++)
{
xmlOutput << std::uppercase << std::hex << std::setfill('0') << std::setw(2) << static_cast<unsigned int>(rootDevice->get_localization_label().at(6 - j));
}
xmlOutput.copyfmt(initialStreamFormat);
xmlOutput << "\">" << std::endl;
// Next, process all elements
for (std::size_t j = 0; j < this->size(); j++)
{
auto currentSubObject = get_object_by_index(static_cast<std::uint16_t>(j));
if ((nullptr != currentSubObject) &&
(task_controller_object::ObjectTypes::DeviceElement == currentSubObject->get_object_type()))
{
auto deviceElement = std::static_pointer_cast<task_controller_object::DeviceElementObject>(currentSubObject);
xmlOutput << "\t<DET A=\"DET-" << static_cast<int>(numberOfElements);
numberOfElements++;
xmlOutput << "\" B=\"" << static_cast<int>(deviceElement->get_object_id());
xmlOutput << "\" C=\"" << static_cast<int>(deviceElement->get_type());
xmlOutput << "\" D=\"" << deviceElement->get_designator();
xmlOutput << "\" E=\"" << static_cast<int>(deviceElement->get_element_number());
xmlOutput << "\" F=\"" << static_cast<int>(deviceElement->get_parent_object());
if (deviceElement->get_number_child_objects() > 0)
{
xmlOutput << "\">" << std::endl;
// Process a list of all device object references
for (std::uint16_t k = 0; k < deviceElement->get_number_child_objects(); k++)
{
xmlOutput << "\t\t<DOR A=\"" << static_cast<int>(deviceElement->get_child_object_id(k)) << "\"/>" << std::endl;
}
xmlOutput << "\t</DET>" << std::endl;
}
else
{
xmlOutput << "\"/>" << std::endl;
}
}
}
// Next, process all DPDs
for (std::size_t j = 0; j < this->size(); j++)
{
auto currentSubObject = get_object_by_index(static_cast<std::uint16_t>(j));
if ((nullptr != currentSubObject) &&
(task_controller_object::ObjectTypes::DeviceProcessData == currentSubObject->get_object_type()))
{
auto deviceProcessData = std::static_pointer_cast<task_controller_object::DeviceProcessDataObject>(currentSubObject);
xmlOutput << "\t<DPD A=\"" << static_cast<int>(deviceProcessData->get_object_id());
xmlOutput << "\" B=\"" << std::uppercase << std::hex << std::setfill('0') << std::setw(4) << static_cast<int>(deviceProcessData->get_ddi());
xmlOutput.copyfmt(initialStreamFormat);
xmlOutput << "\" C=\"" << static_cast<int>(deviceProcessData->get_properties_bitfield());
xmlOutput << "\" D=\"" << static_cast<int>(deviceProcessData->get_trigger_methods_bitfield());
xmlOutput << "\" E=\"" << deviceProcessData->get_designator();
if (0xFFFF != deviceProcessData->get_device_value_presentation_object_id())
{
xmlOutput << "\" F=\"" << static_cast<int>(deviceProcessData->get_device_value_presentation_object_id());
}
xmlOutput << "\"/>" << std::endl;
}
}
// Next, process all child DPTs
for (std::size_t j = 0; j < this->size(); j++)
{
auto currentSubObject = get_object_by_index(static_cast<std::uint16_t>(j));
if ((nullptr != currentSubObject) &&
(task_controller_object::ObjectTypes::DeviceProperty == currentSubObject->get_object_type()))
{
auto deviceProperty = std::static_pointer_cast<task_controller_object::DevicePropertyObject>(currentSubObject);
xmlOutput << "\t<DPT A=\"" << static_cast<int>(deviceProperty->get_object_id());
xmlOutput << "\" B=\"" << std::uppercase << std::hex << std::setfill('0') << std::setw(4) << static_cast<int>(deviceProperty->get_ddi());
xmlOutput.copyfmt(initialStreamFormat);
xmlOutput << "\" C=\"" << static_cast<int>(deviceProperty->get_value());
xmlOutput << "\" D=\"" << deviceProperty->get_designator();
if (0xFFFF != deviceProperty->get_device_value_presentation_object_id())
{
xmlOutput << "\" E=\"" << static_cast<int>(deviceProperty->get_device_value_presentation_object_id());
}
xmlOutput << "\"/>" << std::endl;
}
}
// Next, process all child DVPs
for (std::size_t j = 0; j < this->size(); j++)
{
auto currentSubObject = get_object_by_index(static_cast<std::uint16_t>(j));
if ((nullptr != currentSubObject) &&
(task_controller_object::ObjectTypes::DeviceValuePresentation == currentSubObject->get_object_type()))
{
auto deviceValuePresentation = std::static_pointer_cast<task_controller_object::DeviceValuePresentationObject>(currentSubObject);
xmlOutput << "\t<DVP A=\"" << static_cast<int>(deviceValuePresentation->get_object_id());
xmlOutput << "\" B=\"" << static_cast<int>(deviceValuePresentation->get_offset());
xmlOutput << "\" C=\"" << std::fixed << std::setprecision(6) << deviceValuePresentation->get_scale();
xmlOutput.copyfmt(initialStreamFormat);
xmlOutput << "\" D=\"" << static_cast<int>(deviceValuePresentation->get_number_of_decimals());
xmlOutput << "\" E=\"" << deviceValuePresentation->get_designator();
xmlOutput << "\"/>" << std::endl;
}
}
// Close DVC object
xmlOutput << "</DVC>" << std::endl;
xmlOutput << "</ISO11783_TaskData>" << std::endl;
resultantString = xmlOutput.str();
LOG_DEBUG("[DDOP]: Generated ISO XML DDOP data OK");
break;
}
}
}
else
{
LOG_ERROR("[DDOP]: Failed to resolve all object IDs in DDOP. Your DDOP contains invalid object references.");
retVal = false;
}
return retVal;
}
std::shared_ptr<task_controller_object::Object> DeviceDescriptorObjectPool::get_object_by_id(std::uint16_t objectID)
{
std::shared_ptr<task_controller_object::Object> retVal;
for (auto ¤tObject : objectList)
{
if (currentObject->get_object_id() == objectID)
{
retVal = currentObject;
break;
}
}
return retVal;
}
std::shared_ptr<task_controller_object::Object> DeviceDescriptorObjectPool::get_object_by_index(std::uint16_t index)