-
Notifications
You must be signed in to change notification settings - Fork 34
Expand file tree
/
Copy pathmethods.h
More file actions
2024 lines (1929 loc) · 215 KB
/
methods.h
File metadata and controls
2024 lines (1929 loc) · 215 KB
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
#ifndef _METHODS_H_
#define _METHODS_H_
#include <Python.h>
#include "object_spy_message.h"
#include "setup_module_auto_defines.h"
#ifdef _cplusplus
extern "C"
{
#endif
PyObject* meth_find_devices(PyObject* self, PyObject* args, PyObject* keywords);
PyObject* meth_open_device(PyObject* self, PyObject* args, PyObject* keywords);
PyObject* meth_close_device(PyObject* self, PyObject* args);
PyObject* meth_get_rtc(PyObject* self, PyObject* args);
PyObject* meth_set_rtc(PyObject* self, PyObject* args);
PyObject* meth_coremini_load(PyObject* self, PyObject* args);
PyObject* meth_coremini_start(PyObject* self, PyObject* args);
PyObject* meth_coremini_stop(PyObject* self, PyObject* args);
PyObject* meth_coremini_clear(PyObject* self, PyObject* args);
PyObject* meth_coremini_get_status(PyObject* self, PyObject* args);
PyObject* meth_transmit_messages(PyObject* self, PyObject* args);
PyObject* meth_get_messages(PyObject* self, PyObject* args);
PyObject* meth_get_script_status(PyObject* self, PyObject* args);
PyObject* meth_get_error_messages(PyObject* self, PyObject* args);
#ifdef _USE_INTERNAL_HEADER_
PyObject* meth_flash_devices(PyObject* self, PyObject* args);
#endif // _USE_INTERNAL_HEADER_
PyObject* meth_set_reflash_callback(PyObject* self, PyObject* args);
PyObject* meth_get_device_settings(PyObject* self, PyObject* args);
PyObject* meth_set_device_settings(PyObject* self, PyObject* args);
PyObject* meth_load_default_settings(PyObject* self, PyObject* args); // icsneoLoadDefaultSettings
// PyObject* meth_spy_message_to_j1850(PyObject* self, PyObject* args);
PyObject* meth_read_sdcard(PyObject* self, PyObject* args);
PyObject* meth_write_sdcard(PyObject* self, PyObject* args);
PyObject* meth_create_neovi_radio_message(PyObject* self, PyObject* args, PyObject* keywords);
PyObject* meth_coremini_start_fblock(PyObject* self, PyObject* args); // ScriptStartFBlock
PyObject* meth_coremini_stop_fblock(PyObject* self, PyObject* args); // ScriptStopFBlock
PyObject* meth_coremini_get_fblock_status(PyObject* self, PyObject* args); // ScriptGetFBlockStatus
PyObject* meth_coremini_read_app_signal(PyObject* self, PyObject* args); // ScriptReadAppSignal
PyObject* meth_coremini_write_app_signal(PyObject* self, PyObject* args); // ScriptWriteAppSignal
PyObject* meth_coremini_read_tx_message(PyObject* self, PyObject* args); // ScriptReadTxMessage
PyObject* meth_coremini_read_rx_message(PyObject* self, PyObject* args); // ScriptReadRxMessage
PyObject* meth_coremini_write_tx_message(PyObject* self, PyObject* args); // ScriptWriteTxMessage
PyObject* meth_coremini_write_rx_message(PyObject* self, PyObject* args); // ScriptWriteRxMessage
PyObject* meth_get_performance_parameters(PyObject* self, PyObject* args);
PyObject* meth_validate_hobject(PyObject* self, PyObject* args);
PyObject* meth_get_last_api_error(PyObject* self, PyObject* args);
PyObject* meth_get_dll_version(PyObject* self, PyObject* args);
PyObject* meth_get_hw_firmware_info(PyObject* self, PyObject* args);
PyObject* meth_base36enc(PyObject* self, PyObject* args);
PyObject* meth_get_serial_number(PyObject* self, PyObject* args);
PyObject* meth_request_enter_sleep_mode(PyObject* self, PyObject* args);
PyObject* meth_set_context(PyObject* self, PyObject* args);
PyObject* meth_force_firmware_update(PyObject* self, PyObject* args);
PyObject* meth_firmware_update_required(PyObject* self, PyObject* args);
PyObject* meth_get_dll_firmware_info(PyObject* self, PyObject* args);
PyObject* meth_get_backup_power_enabled(PyObject* self, PyObject* args);
PyObject* meth_set_backup_power_enabled(PyObject* self, PyObject* args);
PyObject* meth_get_backup_power_ready(PyObject* self, PyObject* args);
PyObject* meth_load_readbin(PyObject* self, PyObject* args);
PyObject* meth_iso15765_transmit_message(PyObject* self, PyObject* args); // icsneoISO15765_TransmitMessage
PyObject* meth_iso15765_receive_message(PyObject* self, PyObject* args); // icsneoISO15765_ReceiveMessageMessage
PyObject* meth_iso15765_enable_networks(PyObject* self, PyObject* args); // icsneoISO15765_EnableNetworks
PyObject* meth_iso15765_disable_networks(PyObject* self, PyObject* args); // icsneoISO15765_DisableNetworks
PyObject* meth_get_active_vnet_channel(PyObject* self, PyObject* args);
PyObject* meth_set_active_vnet_channel(PyObject* self, PyObject* args);
PyObject* meth_override_library_name(PyObject* self, PyObject* args);
PyObject* meth_get_library_path(PyObject* self);
PyObject* meth_set_bit_rate(PyObject* self, PyObject* args);
PyObject* meth_set_fd_bit_rate(PyObject* self, PyObject* args);
PyObject* meth_set_bit_rate_ex(PyObject* self, PyObject* args);
PyObject* meth_get_timestamp_for_msg(PyObject* self, PyObject* args);
PyObject* meth_get_device_status(PyObject* self, PyObject* args);
PyObject* meth_enable_network_com(PyObject* self, PyObject* args); // icsneoEnableNetworkCom
PyObject* meth_enable_bus_voltage_monitor(PyObject* self, PyObject* args);
PyObject* meth_get_bus_voltage(PyObject* self, PyObject* args);
PyObject* meth_read_jupiter_firmware(PyObject* self, PyObject* args);
PyObject* meth_write_jupiter_firmware(PyObject* self, PyObject* args);
PyObject* meth_get_disk_details(PyObject* self, PyObject* args);
PyObject* meth_disk_format(PyObject* self, PyObject* args);
PyObject* meth_disk_format_cancel(PyObject* self, PyObject* args);
PyObject* meth_get_disk_format_progress(PyObject* self, PyObject* args);
PyObject* meth_enable_doip_line(PyObject* self, PyObject* args); // icsneoEnableDOIPLine
PyObject* meth_is_device_feature_supported(PyObject* self, PyObject* args); // icsneoIsDeviceFeatureSupported
PyObject* meth_get_pcb_serial_number(PyObject* self, PyObject* args);
PyObject* meth_set_led_property(PyObject* self, PyObject* args);
PyObject* meth_start_dhcp_server(PyObject* self, PyObject* args);
PyObject* meth_stop_dhcp_server(PyObject* self, PyObject* args);
PyObject* meth_wbms_manager_write_lock(PyObject* self, PyObject* args);
PyObject* meth_wbms_manager_reset(PyObject* self, PyObject* args);
PyObject* meth_uart_write(PyObject* self, PyObject* args);
PyObject* meth_uart_read(PyObject* self, PyObject* args);
PyObject* meth_uart_set_baudrate(PyObject* self, PyObject* args);
PyObject* meth_uart_get_baudrate(PyObject* self, PyObject* args);
PyObject* meth_generic_api_send_command(PyObject* self, PyObject* args);
PyObject* meth_generic_api_read_data(PyObject* self, PyObject* args);
PyObject* meth_generic_api_get_status(PyObject* self, PyObject* args);
PyObject* meth_get_gptp_status(PyObject* self, PyObject* args); // icsneoGetGPTPStatus
PyObject* meth_get_all_chip_versions(PyObject* self, PyObject* args); // icsneoGetAllChipVersions
PyObject* meth_flash_accessory_firmware(PyObject* self, PyObject* args);
PyObject* meth_get_accessory_firmware_version(PyObject* self, PyObject* args);
PyObject* meth_set_safe_boot_mode(PyObject* self, PyObject* args);
PyObject* meth_get_device_name(PyObject* self, PyObject* args); // icsneoGetDeviceName
PyObject* meth_get_imei(PyObject* self, PyObject* args); // icsneoGetIMEI
PyObject* meth_get_component_versions(PyObject* self, PyObject* args); // icsneoGetComponentVersions
PyObject* meth_request_set_neovi_miscio(PyObject* self, PyObject* args); // icsneoRequestSetNeoVIMiscIO
PyObject* meth_get_firmware_variant(PyObject* self, PyObject* args); // icsneoGetFirmwareVariant
#ifdef _cplusplus
}
#endif
#define _EZ_ICS_STRUCT_METHOD(name, icsname, icsname_no_icsneo, meth, flags, doc) \
{ name, (PyCFunction)meth, flags, doc }, \
{ icsname, \
(PyCFunction)meth, \
flags, \
"\n.. note:: Compatibility Function: Identical to PEP8 compliant :func:`" MODULE_NAME "." name \
"` method.\n\n" }, \
{ \
icsname_no_icsneo, (PyCFunction)meth, flags, \
"\n.. note:: Compatibility Function: Identical to PEP8 compliant :func:`" MODULE_NAME "." name \
"` method.\n\n" \
}
#define _DOC_FIND_DEVICES \
MODULE_NAME ".find_devices(device_type=" MODULE_NAME ".NEODEVICE_ALL)\n" \
"\n" \
"Finds all connected devices and returns a tuple of :class:` PyNeoDeviceEx" \
"` for use in :func:`" MODULE_NAME ".open_device`\n" \
"\n" \
"Args:\n" \
"\tdevice_type (int): Accepts " MODULE_NAME ".NEODEVICE_* Macros\n\n" \
"\t*New in 3.0 (803):*\n\n" \
"\tdevice_types (List/Tuple): Accepts a Container of " MODULE_NAME ".NEODEVICE_* Macros\n\n" \
"\tnetwork_id (int): OptionsFindNeoEx.CANOptions.iNetworkID. Usually ics.NETID_CAN, if needed\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tTuple of :class:` PyNeoDeviceEx" \
"` for use in :func:`" MODULE_NAME ".open_device`\n" \
"\n" \
"\t>>> for device in ics.find_devices():\n" \
"\t... print(device.Name, device.SerialNumber)\n" \
"\t...\n" \
"\tneoVI FIRE 59886\n" \
"\n*New in 3.0 (803):*\n" \
"\t>>> for device in ics.find_devices([ics.NEODEVICE_FIRE, ics.NEODEVICE_VCAN3]):\n" \
"\t... print(device.Name, device.SerialNumber)\n" \
"\t...\n" \
"\tneoVI FIRE 59886\n"
#define _DOC_OPEN_DEVICES \
MODULE_NAME \
".open_device(device)\n" \
"\n" \
"Opens the device. `device` can be omitted to return a :class:` PyNeoDeviceEx" \
"` of the\n" \
"first free availible device, a :class:` PyNeoDeviceEx" \
"`, or a serial number of the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:` PyNeoDeviceEx" \
"`\n\n" \
"\tdevice (int): Serial Number of the device\n\n" \
"\tnetwork_ids (List/Tuple): This is an array of number IDs which specify the NetworkID parameter of each " \
"network. This allows you to assign a custom network ID to each network. Normally, you will assign consecutive " \
"IDs to each of the networks. See NetworkIDList for a list of current network ID's. You may also set this " \
"parameter to NULL (zero) and the default network ID's will be used.\n\n" \
"\tconfig_read (int): Specifies whether the DLL should read the neoVI's device configuration before enabling the " \
"device. It is recommended that this value be set to 1.\n\n" \
"\toptions (int): DEVICE_OPTION_* defines\n\n" \
"\tnetwork_id (int): OptionsFindNeoEx.CANOptions.iNetworkID. Usually ics.NETID_CAN, if needed\n\n" \
"\tuse_server (int): Defaults to False, Setting to True allows opening the same device more than once.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tIf :class:` PyNeoDeviceEx" \
"` is passed as a parameter, None. \n" \
"\tIf serial number is passed as a parameter, a :class:` PyNeoDeviceEx" \
"` will be returned. \n" \
"\tIf `device` parameter is omitted, a :class:` PyNeoDeviceEx" \
"` will be returned with the first availible free device. \n" \
"\n" \
"\t>>> for device in ics.find_devices():\n" \
"\t... ics.open_device(device)\n" \
"\t...\n" \
"\n" \
".. note::\n\t:class:` PyNeoDeviceEx" \
"` will automatically close the device when it goes out of scope.\n\n"
#define _DOC_CLOSE_DEVICES \
MODULE_NAME ".close_device(device)\n" \
"\n" \
"Closes the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tError Count (int)\n" \
"\n" \
"\t>>> for device in ics.find_devices():\n" \
"\t... ics.open_device(device)\n" \
"\t... # Do something with the device...\n" \
"\t... ics.close_device(device)\n" \
"\t...\n" \
"\n" \
".. note::\n\t:class:` PyNeoDeviceEx" \
"` will automatically close the device when it goes out of scope.\n\n"
#define _DOC_GET_RTC \
MODULE_NAME ".get_rtc(device)\n" \
"\n" \
"Gets the Real-Time Clock of the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tTuple: (datetime.datetime object, offset in seconds)\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.get_rtc(device)\n" \
"\t(datetime.datetime(2014, 9, 10, 17, 45, 45), 3)\n"
#define _DOC_SET_RTC \
MODULE_NAME ".set_rtc(device[, time])\n" \
"\n" \
"Sets the Real-Time Clock of the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\ttime (:class:`datetime.datetime`): Optional. Sets to current time, if omitted.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.set_rtc(device)\n"
#define _DOC_COREMINI_LOAD \
MODULE_NAME ".coremini_load(device, coremini, location)\n" \
"\n" \
"Loads the CoreMini into the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tcoremini (str/tuple): Use string to load from file, Use Tuple if file data.\n\n" \
"\tlocation (int): Accepts :class:`" MODULE_NAME ".SCRIPT_LOCATION_FLASH_MEM`, :class:`" MODULE_NAME \
".SCRIPT_LOCATION_SDCARD`, or :class:`" MODULE_NAME ".SCRIPT_LOCATION_VCAN3_MEM`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_load(device, 'cmvspy.vs3cmb', ics.SCRIPT_LOCATION_SDCARD)\n"
#define _DOC_COREMINI_START \
MODULE_NAME ".coremini_start(device, location)\n" \
"\n" \
"Starts the CoreMini into the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tlocation (int): Accepts :class:`" MODULE_NAME ".SCRIPT_LOCATION_FLASH_MEM`, :class:`" MODULE_NAME \
".SCRIPT_LOCATION_SDCARD`, or :class:`" MODULE_NAME ".SCRIPT_LOCATION_VCAN3_MEM`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_start(device, ics.SCRIPT_LOCATION_SDCARD)\n"
#define _DOC_COREMINI_STOP \
MODULE_NAME ".coremini_stop(device)\n" \
"\n" \
"Stops the CoreMini into the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_stop(device)\n"
#define _DOC_COREMINI_CLEAR \
MODULE_NAME ".coremini_clear(device, location)\n" \
"\n" \
"Clears the CoreMini into the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tlocation (int): Accepts :class:`" MODULE_NAME ".SCRIPT_LOCATION_FLASH_MEM`, :class:`" MODULE_NAME \
".SCRIPT_LOCATION_SDCARD`, or :class:`" MODULE_NAME ".SCRIPT_LOCATION_VCAN3_MEM`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_clear(device, ics.SCRIPT_LOCATION_SDCARD)\n"
#define _DOC_COREMINI_GET_STATUS \
MODULE_NAME ".coremini_get_status(device)\n" \
"\n" \
"Gets the status of the CoreMini in the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tTrue if running, otherwise False.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_get_status(device)\n" \
"\t>>>\n"
#define _DOC_TRANSMIT_MESSAGES \
MODULE_NAME ".transmit_messages(device, messages)\n" \
"\n" \
"Transmits message(s) on the device. `messages` can be a tuple of :class:`" MODULE_NAME \
"." SPY_MESSAGE_OBJECT_NAME "`\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tmessages (:class:`" MODULE_NAME "." SPY_MESSAGE_OBJECT_NAME "`): :class:`" MODULE_NAME \
"." SPY_MESSAGE_OBJECT_NAME "`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> msg = ics.SpyMessage()\n" \
"\t>>> msg.ArbIDOrHeader = 0xFF\n" \
"\t>>> msg.NetworkID = ics.NETID_HSCAN\n" \
"\t>>> msg.Data = (0,1,2,3,4,5,6,7)\n" \
"\t>>> ics.transmit_messages(device, msg)\n" \
"\t>>>\n"
#define _DOC_GET_MESSAGES \
MODULE_NAME ".get_messages(device[, j1850, timeout])\n" \
"\n" \
"Gets the message(s) on the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tj1850 (:class:`bool`): Return :class:`" MODULE_NAME "." SPY_MESSAGE_J1850_OBJECT_NAME \
"` instead.\n\n" \
"\ttimeout (:class:`float`): Optional timeout to wait for messages in seconds (0.1 = 100ms).\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\t:class:`tuple` of two items. First item is a :class:`tuple` of :class:`" MODULE_NAME \
"." SPY_MESSAGE_OBJECT_NAME "` and second is the error count.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> messages, errors = ics.get_messages(device)\n" \
"\t>>> len(messages)\n" \
"\t14\n" \
"\t>>> hex(messages[0].ArbIDOrHeader)\n" \
"\t'0x160'\n" \
"\t>>> messages[0].Data\n" \
"\t(36, 11, 11, 177, 37, 3, 11, 199)\n" \
"\t>>> errors\n" \
"\t0\n"
//"Accepts a PyNeoDeviceEx" ", exception on error. Returns a list of (error #, string)"
#define _DOC_GET_ERROR_MESSAGES \
MODULE_NAME ".get_error_messages(device[, j1850, timeout])\n" \
"\n" \
"Gets the error message(s) on the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\t:class:`list` of :class:`tuple`s. :class:`tuple` contents: (error_number, description_short, " \
"description_long, severity, restart_needed)\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> errors = ics.get_error_messages(device)\n"
//_DOC_SET_REFLASH_DISPLAY_CALLBACKS), "icsneoSetReflashCallback(), pass a python function func(msg, progress)"
#define _DOC_SET_REFLASH_CALLBACK \
MODULE_NAME \
".set_reflash_callback(callback)\n" \
"\n" \
"Sets the reflash display callback.\n" \
"\n" \
"Args:\n" \
"\tcallback (:class:`function`): Must be a callable Python function (`def callback(msg, progress)`)\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> def callback(msg, progress):\n" \
"\t... print(msg, progress)\n" \
"\t...\n" \
"\t>>> ics.set_reflash_callback(callback)\n" \
"\t>>> \n"
#define _DOC_GET_DEVICE_SETTINGS \
MODULE_NAME \
".get_device_settings(device, device_type, vnet_slot)\n" \
"\n" \
"Gets the settings in the device. vnet_slot defaults to " MODULE_NAME ".PlasmaIonVnetChannelMain\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:` PyNeoDeviceEx" \
"`\n\n" \
"\tdevice_type (EDeviceSettingsType): Optional: Overrides default device setings type. Defaults to '-1'\n\n" \
"\tvnet_slot (PlasmaIonVnetChannelMain): Optional: Defaults to PlasmaIonVnetChannelMain, Used only for " \
"PLASMA/ION Devices.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\t:class:`" MODULE_NAME "." \
"device_settings" \
"`\n" \
"\n" \
"\t>>> d = ics.open_device()\n" \
"\t>>> d.Name\n" \
"\t'neoVI ION'\n" \
"\t>>> d.SerialNumber\n" \
"\t404444\n" \
"\t>>> s = ics.get_device_settings(d)\n" \
"\t>>> s.DeviceSettingType\n" \
"\t2\n" \
"\t>>> s.cyan\n" \
"\t<ics.CyanSettings object at 0x01E61B40>\n" \
"\t>>> s.cyan.canfd1.FDMode\n" \
"\t4\n" \
"\t>>> s2.cyan\n" \
"\t<ics.CyanSettings object at 0x02B113C8>\n" \
"\t>>> s2 = ics.get_device_settings(d, -1, ics.PlasmaIonVnetChannelA)\n" \
"\t>>> s2.DeviceSettingType\n" \
"\t2\n" \
"\t>>> s2.cyan.canfd1.FDMode\n" \
"\t4\n"
#define _DOC_SET_DEVICE_SETTINGS \
MODULE_NAME ".set_device_settings(device, settings, save_to_eeprom, vnet_slot)\n" \
"\n" \
"Sets the settings in the device. vnet_slot defaults to " MODULE_NAME ".PlasmaIonVnetChannelMain\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tsettings (:class:`" MODULE_NAME "." \
"device_settings" \
"`): :class:`" MODULE_NAME "." \
"device_settings" \
"`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> d = ics.open_device()\n" \
"\t>>> d.Name\n" \
"\t'neoVI ION'\n" \
"\t>>> d.SerialNumber\n" \
"\t404444\n" \
"\t>>> s = ics.get_device_settings(d, ics.PlasmaIonVnetChannelA) # Get Slave settings, channel " \
"selection not needed if not a Plasma/Ion\n" \
"\t>>> s.DeviceSettingType\n" \
"\t2\n" \
"\t>>> s.cyan.can_switch_mode\n" \
"\t1\n" \
"\t>>> s.cyan.can_switch_mode = 2\n" \
"\t>>> ics.set_device_settings(d, s, True, ics.PlasmaIonVnetChannelA)\n" \
"\t>>> \n"
//"Accepts a PyNeoDeviceEx" ", exception on error."
#define _DOC_LOAD_DEFAULT_SETTINGS \
MODULE_NAME ".load_default_settings(device)\n" \
"\n" \
"Load the default settings in the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.load_default_settings(device)\n" \
"\t>>> \n"
#define _DOC_CREATE_NEOVI_RADIO_MESSAGE \
MODULE_NAME \
".create_neovi_radio_message(Relay1, Relay2, Relay3, Relay4, Relay5, LED6, LED5, MSB_report_rate, " \
"LSB_report_rate, analog_change_report_rate, relay_timeout)\n\n" \
"Python API only. Generates data bytes for use with neoVI RADI/O CAN Messages\n\n" \
"Kwargs:\n" \
"\tRelay1 (boolean): Enable/Disable Relay1\n\n" \
"\tRelay2 (boolean): Enable/Disable Relay2\n\n" \
"\tRelay3 (boolean): Enable/Disable Relay3\n\n" \
"\tRelay4 (boolean): Enable/Disable Relay4\n\n" \
"\tRelay5 (boolean): Enable/Disable Relay5\n\n" \
"\tLED5 (boolean): Enable/Disable LED5\n\n" \
"\tLED6 (boolean): Enable/Disable LED6\n\n" \
"\tMSB_report_rate (int): MSB Report Rate in ms (0-255)\n\n" \
"\tLSB_report_rate (int): LSB Report Rate in ms (0-255)\n\n" \
"\tanalog_change_report_rate (int): Analog change report rate\n\n" \
"\trelay_timeout (int): Relay Timeout (0-255)*255ms\n\n" \
"\n" \
"Returns:\n" \
"\n" \
"\tTuple of data bytes for use with :class:`" MODULE_NAME "." SPY_MESSAGE_OBJECT_NAME "`\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"\t>>> msg = ics.SpyMessage()\n" \
"\t>>> msg.Data = ics.create_neovi_radio_message(Relay1=True, Relay4=False, LED6=True, MSB_report_rate=10)\n" \
"\t>>> msg.Data\n" \
"\t(65, 10, 0, 0, 0)\n"
#define _DOC_COREMINI_START_FBLOCK \
MODULE_NAME ".coremini_start_fblock(device, index)\n" \
"\n" \
"Starts a Coremini Function Block at `index` on `device`.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tindex (int): Index of the function block.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone on Success.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_start_fblock(device, 1)\n"
#define _DOC_COREMINI_STOP_FBLOCK \
MODULE_NAME ".coremini_stop_fblock(device, index)\n" \
"\n" \
"Stops a Coremini Function Block at `index` on `device`.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tindex (int): Index of the function block.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone on Success.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_stop_fblock(device, 1)\n"
#define _DOC_COREMINI_GET_FBLOCK_STATUS \
MODULE_NAME ".coremini_get_fblock_status(device, index)\n" \
"\n" \
"Gets the status of a Coremini Function Block at `index` on `device`.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tindex (int): Index of the function block.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone on Success.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_get_fblock_status(device, 1)\n" \
"\tTrue\n"
#define _DOC_COREMINI_READ_APP_SIGNAL \
MODULE_NAME ".coremini_read_app_signal(device, index)\n" \
"\n" \
"Gets the value of a Coremini application signal at `index` on `device`.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tindex (int): Index of the application signal.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tfloat on Success.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_read_app_signal(device, 1)\n" \
"\t52\n"
#define _DOC_COREMINI_WRITE_APP_SIGNAL \
MODULE_NAME ".coremini_write_app_signal(device, index, value)\n" \
"\n" \
"Sets the value of a Coremini application signal at `index` on `device`.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tindex (int): Index of the application signal.\n\n" \
"\tvalue (float): New value of the application signal.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tNone on Success.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.coremini_write_app_signal(device, 1, 52)\n" \
"\t>>>\n"
#define _DOC_COREMINI_READ_TX_MESSAGE \
MODULE_NAME ".coremini_read_tx_message(device, index, j1850=False)\n" \
"\n" \
"Gets the value of a Coremini Message at `index` on `device`.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tindex (int): Index of the application signal.\n\n" \
"\tj1850 (bool): Use :class:`" MODULE_NAME "." SPY_MESSAGE_J1850_OBJECT_NAME "` instead.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\t:class:`" MODULE_NAME "." SPY_MESSAGE_OBJECT_NAME "` Success.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> msg = ics.coremini_read_tx_message(device, 0)\n"
#define _DOC_COREMINI_READ_RX_MESSAGE \
MODULE_NAME ".coremini_read_rx_message(device, index, j1850=False)\n" \
"\n" \
"Gets the value of a Coremini Message at `index` on `device`.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tindex (int): Index of the application signal.\n\n" \
"\tj1850 (bool): Use :class:`" MODULE_NAME "." SPY_MESSAGE_J1850_OBJECT_NAME "` instead.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\t:class:`" MODULE_NAME "." SPY_MESSAGE_OBJECT_NAME "` Success.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> msg = ics.coremini_read_tx_message(device, 0)\n"
#define _DOC_COREMINI_WRITE_TX_MESSAGE \
MODULE_NAME ".coremini_write_tx_message(device, index, msg)\n" \
"TODO"
#define _DOC_COREMINI_WRITE_RX_MESSAGE \
MODULE_NAME ".coremini_write_rx_message(device, index, TODO)\n" \
"TODO"
#define _DOC_GET_PERFORMANCE_PARAMETERS \
MODULE_NAME ".get_performance_parameters(device)\n" \
"\n" \
"Gets the Performance Parameters on `device`.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tTuple on Success: (buffer count, buffer max, overflow count, reserved, reserved, reserved, " \
"reserved, reserved)\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.get_performance_parameters(device)\n" \
"\t(0, 24576, 0, 0, 0, 0, 0, 0)\n"
#define _DOC_VALIDATE_HOBJECT \
MODULE_NAME ".validate_hobject(device)\n" \
"\n" \
"Validates the handle is valid for a `device`. Handles are only valid when the device is open.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\tor:\n\n" \
"\tdevice (int): c style integer handle to the device.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tBoolean: True if valid, false otherwise.\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> ics.validate_hobject(device)\n" \
"\t1\n" \
"\t>>> ics.validate_hobject(device._Handle)\n" \
"\t1\n"
#define _DOC_GET_LAST_API_ERROR \
MODULE_NAME ".get_last_api_error(device)\n" \
"\n" \
"Gets the error message from the last API call.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tTuple: (error, description short, description long, severity, restart needed)\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> try:\n" \
"\t... msg = ics.coremini_read_tx_message(device, 0)\n" \
"\t... except ics.RuntimeError as ex:\n" \
"\t... print(ex)\n" \
"\t... print(ics.get_last_api_error(device))\n" \
"\t...\n" \
"\tError: coremini_read_tx_message(): icsneoScriptReadTxMessage() Failed\n" \
"\t(224, 'Invalid Message Index for script.', 'Invalid Message Index for script.', 16, 0)\n"
#define _DOC_GET_DLL_VERSION \
MODULE_NAME ".get_dll_version(device)\n" \
"\n" \
"Gets the DLL version.\n" \
"\n" \
"Args:\n" \
"\tNone\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tInt: DLL Version\n" \
"\n" \
"\t>>> ics.get_dll_version()\n" \
"\t700\n"
#define _DOC_BASE36ENC \
MODULE_NAME ".base36enc(serial)\n" \
"\n" \
"Converts a decimal serial number to base36.\n" \
"\n" \
"Args:\n" \
"\tserial (int): serial number.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tStr: Serial Number\n" \
"\n" \
"\t>>> ics.base36enc(device.SerialNumber)\n" \
"\tCY0024\n"
#define _DOC_GET_SERIAL_NUMBER \
MODULE_NAME ".get_serial_number(device)\n" \
"\n" \
"Gets the serial number out of the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tInt: Serial Number Version\n" \
"\n" \
"\t>>> ics.get_serial_number(device)\n" \
"\t53123\n"
#define _DOC_REQUEST_ENTER_SLEEP_MODE \
MODULE_NAME ".request_enter_sleep_mode(device, timeout_ms, mode, reserved_zero)\n" \
"\n" \
"Signal neoVI to immediete go to sleep. Currently only supported by FIREVNET/PLASMA.\n" \
"If using over USB this will likely return true but never cause PLASMA to sleep\n" \
"since USB insertion keeps it alive.\n" \
"This API allows Android/Linux applications to invoke power management.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"\ttimeout_ms (int): 16bit word for how long to wait on idle bus before going to sleep. " \
"If caller does not want to change it pass in 65535 (0xFFFF) and it " \
"will stay whatever it was set to in explorer/coremini.\n\n" \
"\n" \
"\tmode (int): 16bit word for power mode to enter. " \
"If caller does not want to change it pass in 65535 (0xFFFF) and it " \
"will stay whatever it was set to in explorer/coremini. " \
"If it is zero then neoVI will do 'normal sleep'. " \
"0 - power mode off but calling this function will do 'normal sleep'. " \
"1 - normal sleep. " \
"2 - instant sleep. " \
"3 - comatose sleep.\n\n" \
"\n" \
"\treserved_zero (int): Reserved, Keep as zero.\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tBoolean: True on success, False on failure.\n" \
"\n" \
"\t>>> ics.request_enter_sleep_mode(device, 1, 0)\n" \
"\tTrue\n"
#define _DOC_SET_CONTEXT \
MODULE_NAME ".set_context(device)\n" \
"\n" \
"Sets the \"context\" of how icsneoFindNeoDevices(Ex) and icsneoOpenNeoDevice(Ex)\n" \
"function. If the context is 0 (null) than icsneoFindNeoDevices(Ex) will be system\n" \
"wide, searching USB and other supported computer interfaces. icsneoFindNeoDevices can\n" \
"then be used to connect to devices found in this manner. If the context is a handle\n" \
"to connected CAN tool than icsneoFindNeoDevices(Ex) will search a specific CAN bus\n" \
"for supported IntrepidCS CAN Nodes. Again icsneoOpenNeoDevice(Ex) would be used\n" \
"create logical connections to found CAN Nodes.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tBoolean: True on success, False on failure.\n" \
"\n" \
"\t>>> ics.set_context(device)\n" \
"\tTrue\n"
#define _DOC_FORCE_FIRMWARE_UPDATE \
MODULE_NAME ".force_firmware_update(device)\n" \
"\n" \
"Forces the device to flash firmware.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tBoolean: True on success, False on failure.\n" \
"\n" \
"\t>>> ics.force_firmware_update(device)\n" \
"\tTrue\n"
#define _DOC_FIRMWARE_UPDATE_REQUIRED \
MODULE_NAME ".firmware_update_required(device)\n" \
"\n" \
"Determines if the device firmware needs flashing.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\tBoolean: True on success, False on failure.\n" \
"\n" \
"\t>>> ics.force_firmware_update(device)\n" \
"\tTrue\n"
#define _DOC_GET_DLL_FIRMWARE_INFO \
MODULE_NAME ".get_dll_firmware_info(device)\n" \
"\n" \
"Returns the DLL firmware info for the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\t(:class:`" MODULE_NAME "." \
"st_api_firmware_info" \
"`)\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> info = ics.get_dll_firmware_info(device)\n" \
"\t>>> info.iAppMajor\n" \
"\t7\n" \
"\t>>> info.iAppMinor\n" \
"\t55\n" \
"\t>>>\n"
#define _DOC_GET_HW_FIRMWARE_INFO \
MODULE_NAME ".get_hw_firmware_info(device)\n" \
"\n" \
"Returns the device firmware info for the device.\n" \
"\n" \
"Args:\n" \
"\tdevice (:class:` PyNeoDeviceEx" \
"`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n" \
"\n" \
"Raises:\n" \
"\t:class:`" MODULE_NAME ".RuntimeError`\n" \
"\n" \
"Returns:\n" \
"\t(:class:`" MODULE_NAME "." \
"st_api_firmware_info" \
"`)\n" \
"\n" \
"\t>>> device = ics.open_device()\n" \
"\t>>> info = ics.get_hw_firmware_info(device)\n" \
"\t>>> info.iAppMajor\n" \
"\t7\n" \
"\t>>> info.iAppMinor\n" \
"\t55\n" \
"\t>>>\n"
#define _DOC_GET_BACKUP_POWER_ENABLED \
MODULE_NAME ".get_backup_power_enabled(device)\n" \
"\n" \
"Returns the device backup power enabled for the device.\n" \
"\n" \