/
xmc1400_breakout_bricklet.go
1126 lines (913 loc) · 36.3 KB
/
xmc1400_breakout_bricklet.go
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
/* ***********************************************************
* This file was automatically generated on 2024-02-27. *
* *
* Go Bindings Version 2.0.15 *
* *
* If you have a bugfix for this file and want to commit it, *
* please fix the bug in the generator. You can find a link *
* to the generators git repository on tinkerforge.com *
*************************************************************/
// Breakout for Infineon XMC1400 microcontroller.
//
//
// See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/XMC1400Breakout_Bricklet_Go.html.
package xmc1400_breakout_bricklet
import (
"bytes"
"encoding/binary"
"fmt"
. "github.com/Tinkerforge/go-api-bindings/internal"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
type Function = uint8
const (
FunctionSetGPIOConfig Function = 1
FunctionGetGPIOInput Function = 2
FunctionSetADCChannelConfig Function = 3
FunctionGetADCChannelConfig Function = 4
FunctionGetADCChannelValue Function = 5
FunctionGetADCValues Function = 6
FunctionSetADCValuesCallbackConfiguration Function = 7
FunctionGetADCValuesCallbackConfiguration Function = 8
FunctionGetCount Function = 10
FunctionSetCountCallbackConfiguration Function = 11
FunctionGetCountCallbackConfiguration Function = 12
FunctionGetSPITFPErrorCount Function = 234
FunctionSetBootloaderMode Function = 235
FunctionGetBootloaderMode Function = 236
FunctionSetWriteFirmwarePointer Function = 237
FunctionWriteFirmware Function = 238
FunctionSetStatusLEDConfig Function = 239
FunctionGetStatusLEDConfig Function = 240
FunctionGetChipTemperature Function = 242
FunctionReset Function = 243
FunctionWriteUID Function = 248
FunctionReadUID Function = 249
FunctionGetIdentity Function = 255
FunctionCallbackADCValues Function = 9
FunctionCallbackCount Function = 13
)
type ThresholdOption = rune
const (
ThresholdOptionOff ThresholdOption = 'x'
ThresholdOptionOutside ThresholdOption = 'o'
ThresholdOptionInside ThresholdOption = 'i'
ThresholdOptionSmaller ThresholdOption = '<'
ThresholdOptionGreater ThresholdOption = '>'
)
type GPIOMode = uint8
const (
GPIOModeInputTristate GPIOMode = 0
GPIOModeInputPullDown GPIOMode = 1
GPIOModeInputPullUp GPIOMode = 2
GPIOModeInputSampling GPIOMode = 3
GPIOModeInputInvertedTristate GPIOMode = 4
GPIOModeInputInvertedPullDown GPIOMode = 5
GPIOModeInputInvertedPullUp GPIOMode = 6
GPIOModeInputInvertedSampling GPIOMode = 7
GPIOModeOutputPushPull GPIOMode = 8
GPIOModeOutputOpenDrain GPIOMode = 9
)
type GPIOInputHysteresis = uint8
const (
GPIOInputHysteresisStandard GPIOInputHysteresis = 0
GPIOInputHysteresisLarge GPIOInputHysteresis = 4
)
type BootloaderMode = uint8
const (
BootloaderModeBootloader BootloaderMode = 0
BootloaderModeFirmware BootloaderMode = 1
BootloaderModeBootloaderWaitForReboot BootloaderMode = 2
BootloaderModeFirmwareWaitForReboot BootloaderMode = 3
BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)
type BootloaderStatus = uint8
const (
BootloaderStatusOK BootloaderStatus = 0
BootloaderStatusInvalidMode BootloaderStatus = 1
BootloaderStatusNoChange BootloaderStatus = 2
BootloaderStatusEntryFunctionNotPresent BootloaderStatus = 3
BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
BootloaderStatusCRCMismatch BootloaderStatus = 5
)
type StatusLEDConfig = uint8
const (
StatusLEDConfigOff StatusLEDConfig = 0
StatusLEDConfigOn StatusLEDConfig = 1
StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
StatusLEDConfigShowStatus StatusLEDConfig = 3
)
type XMC1400BreakoutBricklet struct {
device Device
}
const DeviceIdentifier = 279
const DeviceDisplayName = "XMC1400 Breakout Bricklet"
// Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func New(uid string, ipcon *ipconnection.IPConnection) (XMC1400BreakoutBricklet, error) {
internalIPCon := ipcon.GetInternalHandle().(IPConnection)
dev, err := NewDevice([3]uint8{2, 0, 0}, uid, &internalIPCon, 0, DeviceIdentifier, DeviceDisplayName)
if err != nil {
return XMC1400BreakoutBricklet{}, err
}
dev.ResponseExpected[FunctionSetGPIOConfig] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionGetGPIOInput] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetADCChannelConfig] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionGetADCChannelConfig] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetADCChannelValue] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetADCValues] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetADCValuesCallbackConfiguration] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetADCValuesCallbackConfiguration] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetCount] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetCountCallbackConfiguration] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetCountCallbackConfiguration] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetSPITFPErrorCount] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetBootloaderMode] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetBootloaderMode] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetWriteFirmwarePointer] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionWriteFirmware] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetStatusLEDConfig] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionGetStatusLEDConfig] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetChipTemperature] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionReset] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionWriteUID] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionReadUID] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetIdentity] = ResponseExpectedFlagAlwaysTrue
return XMC1400BreakoutBricklet{dev}, nil
}
// Returns the response expected flag for the function specified by the function ID parameter.
// It is true if the function is expected to send a response, false otherwise.
//
// For getter functions this is enabled by default and cannot be disabled, because those
// functions will always send a response. For callback configuration functions it is enabled
// by default too, but can be disabled by SetResponseExpected.
// For setter functions it is disabled by default and can be enabled.
//
// Enabling the response expected flag for a setter function allows to detect timeouts
// and other error conditions calls of this setter as well. The device will then send a response
// for this purpose. If this flag is disabled for a setter function then no response is sent
// and errors are silently ignored, because they cannot be detected.
//
// See SetResponseExpected for the list of function ID constants available for this function.
func (device *XMC1400BreakoutBricklet) GetResponseExpected(functionID Function) (bool, error) {
return device.device.GetResponseExpected(uint8(functionID))
}
// Changes the response expected flag of the function specified by the function ID parameter.
// This flag can only be changed for setter (default value: false) and callback configuration
// functions (default value: true). For getter functions it is always enabled.
//
// Enabling the response expected flag for a setter function allows to detect timeouts and
// other error conditions calls of this setter as well. The device will then send a response
// for this purpose. If this flag is disabled for a setter function then no response is sent
// and errors are silently ignored, because they cannot be detected.
func (device *XMC1400BreakoutBricklet) SetResponseExpected(functionID Function, responseExpected bool) error {
return device.device.SetResponseExpected(uint8(functionID), responseExpected)
}
// Changes the response expected flag for all setter and callback configuration functions of this device at once.
func (device *XMC1400BreakoutBricklet) SetResponseExpectedAll(responseExpected bool) {
device.device.SetResponseExpectedAll(responseExpected)
}
// Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.
func (device *XMC1400BreakoutBricklet) GetAPIVersion() [3]uint8 {
return device.device.GetAPIVersion()
}
// This callback is triggered periodically according to the configuration set by
// SetADCValuesCallbackConfiguration.
//
// The parameters are the same as GetADCValues.
func (device *XMC1400BreakoutBricklet) RegisterADCValuesCallback(fn func([8]uint16)) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 24 {
return
}
buf := bytes.NewBuffer(byteSlice[8:])
var values [8]uint16
binary.Read(buf, binary.LittleEndian, &values)
fn(values)
}
return device.device.RegisterCallback(uint8(FunctionCallbackADCValues), wrapper)
}
// Remove a registered ADC Values callback.
func (device *XMC1400BreakoutBricklet) DeregisterADCValuesCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackADCValues), registrationId)
}
// This callback is triggered periodically according to the configuration set by
// SetCountCallbackConfiguration.
//
// The parameter is the same as GetCount.
func (device *XMC1400BreakoutBricklet) RegisterCountCallback(fn func(uint32)) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 12 {
return
}
buf := bytes.NewBuffer(byteSlice[8:])
var count uint32
binary.Read(buf, binary.LittleEndian, &count)
fn(count)
}
return device.device.RegisterCallback(uint8(FunctionCallbackCount), wrapper)
}
// Remove a registered Count callback.
func (device *XMC1400BreakoutBricklet) DeregisterCountCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackCount), registrationId)
}
// Example for a setter function. The values are the values that can be given to
// the XMC_GPIO_Init function. See communication.c in the firmware.
//
// Associated constants:
//
// * GPIOModeInputTristate
// * GPIOModeInputPullDown
// * GPIOModeInputPullUp
// * GPIOModeInputSampling
// * GPIOModeInputInvertedTristate
// * GPIOModeInputInvertedPullDown
// * GPIOModeInputInvertedPullUp
// * GPIOModeInputInvertedSampling
// * GPIOModeOutputPushPull
// * GPIOModeOutputOpenDrain
// * GPIOInputHysteresisStandard
// * GPIOInputHysteresisLarge
func (device *XMC1400BreakoutBricklet) SetGPIOConfig(port uint8, pin uint8, mode GPIOMode, inputHysteresis GPIOInputHysteresis, outputLevel bool) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, port)
binary.Write(&buf, binary.LittleEndian, pin)
binary.Write(&buf, binary.LittleEndian, mode)
binary.Write(&buf, binary.LittleEndian, inputHysteresis)
binary.Write(&buf, binary.LittleEndian, outputLevel)
resultBytes, err := device.device.Set(uint8(FunctionSetGPIOConfig), buf.Bytes())
if err != nil {
return err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return DeviceError(header.ErrorCode)
}
if header.Length != 8 {
return fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 8)
}
bytes.NewBuffer(resultBytes[8:])
}
return nil
}
// Example for a getter function. Returns the result of a
// XMC_GPIO_GetInput call for the given port/pin.
func (device *XMC1400BreakoutBricklet) GetGPIOInput(port uint8, pin uint8) (value bool, err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, port)
binary.Write(&buf, binary.LittleEndian, pin)
resultBytes, err := device.device.Get(uint8(FunctionGetGPIOInput), buf.Bytes())
if err != nil {
return value, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return value, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return value, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &value)
}
return value, nil
}
// Enables a ADC channel for the ADC driver example (adc.c/adc.h).
//
// There are 8 ADC channels and they correspond to the following pins:
//
// * Channel 0: P2_6
// * Channel 1: P2_8
// * Channel 2: P2_9
// * Channel 3: P2_10
// * Channel 4: P2_11
// * Channel 5: P2_0
// * Channel 6: P2_1
// * Channel 7: P2_2
func (device *XMC1400BreakoutBricklet) SetADCChannelConfig(channel uint8, enable bool) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, channel)
binary.Write(&buf, binary.LittleEndian, enable)
resultBytes, err := device.device.Set(uint8(FunctionSetADCChannelConfig), buf.Bytes())
if err != nil {
return err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return DeviceError(header.ErrorCode)
}
if header.Length != 8 {
return fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 8)
}
bytes.NewBuffer(resultBytes[8:])
}
return nil
}
// Returns the config for the given channel as set by SetADCChannelConfig.
func (device *XMC1400BreakoutBricklet) GetADCChannelConfig(channel uint8) (enable bool, err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, channel)
resultBytes, err := device.device.Get(uint8(FunctionGetADCChannelConfig), buf.Bytes())
if err != nil {
return enable, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return enable, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return enable, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &enable)
}
return enable, nil
}
// Returns the 12-bit value of the given ADC channel of the ADC driver example.
func (device *XMC1400BreakoutBricklet) GetADCChannelValue(channel uint8) (value uint16, err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, channel)
resultBytes, err := device.device.Get(uint8(FunctionGetADCChannelValue), buf.Bytes())
if err != nil {
return value, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return value, DeviceError(header.ErrorCode)
}
if header.Length != 10 {
return value, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 10)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &value)
}
return value, nil
}
// Returns the values for all 8 ADC channels of the adc driver example.
//
// This example function also has a corresponding callback.
//
// See SetADCValuesCallbackConfiguration and RegisterADCValuesCallback callback.
func (device *XMC1400BreakoutBricklet) GetADCValues() (values [8]uint16, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetADCValues), buf.Bytes())
if err != nil {
return values, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return values, DeviceError(header.ErrorCode)
}
if header.Length != 24 {
return values, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 24)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &values)
}
return values, nil
}
// The period is the period with which the RegisterADCValuesCallback
// callback is triggered periodically. A value of 0 turns the callback off.
//
// If the `value has to change`-parameter is set to true, the callback is only
// triggered after the value has changed. If the value didn't change within the
// period, the callback is triggered immediately on change.
//
// If it is set to false, the callback is continuously triggered with the period,
// independent of the value.
func (device *XMC1400BreakoutBricklet) SetADCValuesCallbackConfiguration(period uint32, valueHasToChange bool) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, period)
binary.Write(&buf, binary.LittleEndian, valueHasToChange)
resultBytes, err := device.device.Set(uint8(FunctionSetADCValuesCallbackConfiguration), buf.Bytes())
if err != nil {
return err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return DeviceError(header.ErrorCode)
}
if header.Length != 8 {
return fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 8)
}
bytes.NewBuffer(resultBytes[8:])
}
return nil
}
// Returns the callback configuration as set by
// SetADCValuesCallbackConfiguration.
func (device *XMC1400BreakoutBricklet) GetADCValuesCallbackConfiguration() (period uint32, valueHasToChange bool, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetADCValuesCallbackConfiguration), buf.Bytes())
if err != nil {
return period, valueHasToChange, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return period, valueHasToChange, DeviceError(header.ErrorCode)
}
if header.Length != 13 {
return period, valueHasToChange, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 13)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &period)
binary.Read(resultBuf, binary.LittleEndian, &valueHasToChange)
}
return period, valueHasToChange, nil
}
// Returns the value of the example count (see example.c).
//
// This example function uses the add_callback_value_function-helper in the
// generator. The getter as well as the callback and callback configuration
// functions are auto-generated for the API as well as the firmware.
//
//
// If you want to get the value periodically, it is recommended to use the
// RegisterCountCallback callback. You can set the callback configuration
// with SetCountCallbackConfiguration.
func (device *XMC1400BreakoutBricklet) GetCount() (count uint32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetCount), buf.Bytes())
if err != nil {
return count, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return count, DeviceError(header.ErrorCode)
}
if header.Length != 12 {
return count, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 12)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &count)
}
return count, nil
}
// The period is the period with which the RegisterCountCallback callback is triggered
// periodically. A value of 0 turns the callback off.
//
// If the `value has to change`-parameter is set to true, the callback is only
// triggered after the value has changed. If the value didn't change
// within the period, the callback is triggered immediately on change.
//
// If it is set to false, the callback is continuously triggered with the period,
// independent of the value.
//
// It is furthermore possible to constrain the callback with thresholds.
//
// The `option`-parameter together with min/max sets a threshold for the RegisterCountCallback callback.
//
// The following options are possible:
//
// Option| Description
// --- | ---
// 'x'| Threshold is turned off
// 'o'| Threshold is triggered when the value is *outside* the min and max values
// 'i'| Threshold is triggered when the value is *inside* or equal to the min and max values
// '<'| Threshold is triggered when the value is smaller than the min value (max is ignored)
// '>'| Threshold is triggered when the value is greater than the min value (max is ignored)
//
// If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
//
// Associated constants:
//
// * ThresholdOptionOff
// * ThresholdOptionOutside
// * ThresholdOptionInside
// * ThresholdOptionSmaller
// * ThresholdOptionGreater
func (device *XMC1400BreakoutBricklet) SetCountCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min uint32, max uint32) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, period)
binary.Write(&buf, binary.LittleEndian, valueHasToChange)
binary.Write(&buf, binary.LittleEndian, option)
binary.Write(&buf, binary.LittleEndian, min)
binary.Write(&buf, binary.LittleEndian, max)
resultBytes, err := device.device.Set(uint8(FunctionSetCountCallbackConfiguration), buf.Bytes())
if err != nil {
return err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return DeviceError(header.ErrorCode)
}
if header.Length != 8 {
return fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 8)
}
bytes.NewBuffer(resultBytes[8:])
}
return nil
}
// Returns the callback configuration as set by SetCountCallbackConfiguration.
//
// Associated constants:
//
// * ThresholdOptionOff
// * ThresholdOptionOutside
// * ThresholdOptionInside
// * ThresholdOptionSmaller
// * ThresholdOptionGreater
func (device *XMC1400BreakoutBricklet) GetCountCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min uint32, max uint32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetCountCallbackConfiguration), buf.Bytes())
if err != nil {
return period, valueHasToChange, option, min, max, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return period, valueHasToChange, option, min, max, DeviceError(header.ErrorCode)
}
if header.Length != 22 {
return period, valueHasToChange, option, min, max, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 22)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &period)
binary.Read(resultBuf, binary.LittleEndian, &valueHasToChange)
binary.Read(resultBuf, binary.LittleEndian, &option)
binary.Read(resultBuf, binary.LittleEndian, &min)
binary.Read(resultBuf, binary.LittleEndian, &max)
}
return period, valueHasToChange, option, min, max, nil
}
// Returns the error count for the communication between Brick and Bricklet.
//
// The errors are divided into
//
// * ACK checksum errors,
// * message checksum errors,
// * framing errors and
// * overflow errors.
//
// The errors counts are for errors that occur on the Bricklet side. All
// Bricks have a similar function that returns the errors on the Brick side.
func (device *XMC1400BreakoutBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetSPITFPErrorCount), buf.Bytes())
if err != nil {
return errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow, DeviceError(header.ErrorCode)
}
if header.Length != 24 {
return errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 24)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &errorCountAckChecksum)
binary.Read(resultBuf, binary.LittleEndian, &errorCountMessageChecksum)
binary.Read(resultBuf, binary.LittleEndian, &errorCountFrame)
binary.Read(resultBuf, binary.LittleEndian, &errorCountOverflow)
}
return errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow, nil
}
// Sets the bootloader mode and returns the status after the requested
// mode change was instigated.
//
// You can change from bootloader mode to firmware mode and vice versa. A change
// from bootloader mode to firmware mode will only take place if the entry function,
// device identifier and CRC are present and correct.
//
// This function is used by Brick Viewer during flashing. It should not be
// necessary to call it in a normal user program.
//
// Associated constants:
//
// * BootloaderModeBootloader
// * BootloaderModeFirmware
// * BootloaderModeBootloaderWaitForReboot
// * BootloaderModeFirmwareWaitForReboot
// * BootloaderModeFirmwareWaitForEraseAndReboot
// * BootloaderStatusOK
// * BootloaderStatusInvalidMode
// * BootloaderStatusNoChange
// * BootloaderStatusEntryFunctionNotPresent
// * BootloaderStatusDeviceIdentifierIncorrect
// * BootloaderStatusCRCMismatch
func (device *XMC1400BreakoutBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, mode)
resultBytes, err := device.device.Get(uint8(FunctionSetBootloaderMode), buf.Bytes())
if err != nil {
return status, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return status, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return status, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &status)
}
return status, nil
}
// Returns the current bootloader mode, see SetBootloaderMode.
//
// Associated constants:
//
// * BootloaderModeBootloader
// * BootloaderModeFirmware
// * BootloaderModeBootloaderWaitForReboot
// * BootloaderModeFirmwareWaitForReboot
// * BootloaderModeFirmwareWaitForEraseAndReboot
func (device *XMC1400BreakoutBricklet) GetBootloaderMode() (mode BootloaderMode, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetBootloaderMode), buf.Bytes())
if err != nil {
return mode, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return mode, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return mode, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &mode)
}
return mode, nil
}
// Sets the firmware pointer for WriteFirmware. The pointer has
// to be increased by chunks of size 64. The data is written to flash
// every 4 chunks (which equals to one page of size 256).
//
// This function is used by Brick Viewer during flashing. It should not be
// necessary to call it in a normal user program.
func (device *XMC1400BreakoutBricklet) SetWriteFirmwarePointer(pointer uint32) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, pointer)
resultBytes, err := device.device.Set(uint8(FunctionSetWriteFirmwarePointer), buf.Bytes())
if err != nil {
return err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return DeviceError(header.ErrorCode)
}
if header.Length != 8 {
return fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 8)
}
bytes.NewBuffer(resultBytes[8:])
}
return nil
}
// Writes 64 Bytes of firmware at the position as written by
// SetWriteFirmwarePointer before. The firmware is written
// to flash every 4 chunks.
//
// You can only write firmware in bootloader mode.
//
// This function is used by Brick Viewer during flashing. It should not be
// necessary to call it in a normal user program.
func (device *XMC1400BreakoutBricklet) WriteFirmware(data [64]uint8) (status uint8, err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, data)
resultBytes, err := device.device.Get(uint8(FunctionWriteFirmware), buf.Bytes())
if err != nil {
return status, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return status, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return status, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &status)
}
return status, nil
}
// Sets the status LED configuration. By default the LED shows
// communication traffic between Brick and Bricklet, it flickers once
// for every 10 received data packets.
//
// You can also turn the LED permanently on/off or show a heartbeat.
//
// If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
//
// Associated constants:
//
// * StatusLEDConfigOff
// * StatusLEDConfigOn
// * StatusLEDConfigShowHeartbeat
// * StatusLEDConfigShowStatus
func (device *XMC1400BreakoutBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, config)
resultBytes, err := device.device.Set(uint8(FunctionSetStatusLEDConfig), buf.Bytes())
if err != nil {
return err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return DeviceError(header.ErrorCode)
}
if header.Length != 8 {
return fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 8)
}
bytes.NewBuffer(resultBytes[8:])
}
return nil
}
// Returns the configuration as set by SetStatusLEDConfig
//
// Associated constants:
//
// * StatusLEDConfigOff
// * StatusLEDConfigOn
// * StatusLEDConfigShowHeartbeat
// * StatusLEDConfigShowStatus
func (device *XMC1400BreakoutBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetStatusLEDConfig), buf.Bytes())
if err != nil {
return config, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return config, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return config, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &config)
}
return config, nil
}
// Returns the temperature as measured inside the microcontroller. The
// value returned is not the ambient temperature!
//
// The temperature is only proportional to the real temperature and it has bad
// accuracy. Practically it is only useful as an indicator for
// temperature changes.
func (device *XMC1400BreakoutBricklet) GetChipTemperature() (temperature int16, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetChipTemperature), buf.Bytes())
if err != nil {
return temperature, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return temperature, DeviceError(header.ErrorCode)
}
if header.Length != 10 {
return temperature, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 10)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &temperature)
}
return temperature, nil
}
// Calling this function will reset the Bricklet. All configurations
// will be lost.
//
// After a reset you have to create new device objects,
// calling functions on the existing ones will result in
// undefined behavior!
func (device *XMC1400BreakoutBricklet) Reset() (err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Set(uint8(FunctionReset), buf.Bytes())
if err != nil {
return err