/
current25_bricklet.go
812 lines (663 loc) · 26.2 KB
/
current25_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
/* ***********************************************************
* 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 *
*************************************************************/
// Measures AC/DC current between -25A and +25A.
//
//
// See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/Current25_Bricklet_Go.html.
package current25_bricklet
import (
"bytes"
"encoding/binary"
"fmt"
. "github.com/Tinkerforge/go-api-bindings/internal"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
type Function = uint8
const (
FunctionGetCurrent Function = 1
FunctionCalibrate Function = 2
FunctionIsOverCurrent Function = 3
FunctionGetAnalogValue Function = 4
FunctionSetCurrentCallbackPeriod Function = 5
FunctionGetCurrentCallbackPeriod Function = 6
FunctionSetAnalogValueCallbackPeriod Function = 7
FunctionGetAnalogValueCallbackPeriod Function = 8
FunctionSetCurrentCallbackThreshold Function = 9
FunctionGetCurrentCallbackThreshold Function = 10
FunctionSetAnalogValueCallbackThreshold Function = 11
FunctionGetAnalogValueCallbackThreshold Function = 12
FunctionSetDebouncePeriod Function = 13
FunctionGetDebouncePeriod Function = 14
FunctionGetIdentity Function = 255
FunctionCallbackCurrent Function = 15
FunctionCallbackAnalogValue Function = 16
FunctionCallbackCurrentReached Function = 17
FunctionCallbackAnalogValueReached Function = 18
FunctionCallbackOverCurrent Function = 19
)
type ThresholdOption = rune
const (
ThresholdOptionOff ThresholdOption = 'x'
ThresholdOptionOutside ThresholdOption = 'o'
ThresholdOptionInside ThresholdOption = 'i'
ThresholdOptionSmaller ThresholdOption = '<'
ThresholdOptionGreater ThresholdOption = '>'
)
type Current25Bricklet struct {
device Device
}
const DeviceIdentifier = 24
const DeviceDisplayName = "Current25 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) (Current25Bricklet, error) {
internalIPCon := ipcon.GetInternalHandle().(IPConnection)
dev, err := NewDevice([3]uint8{2, 0, 0}, uid, &internalIPCon, 0, DeviceIdentifier, DeviceDisplayName)
if err != nil {
return Current25Bricklet{}, err
}
dev.ResponseExpected[FunctionGetCurrent] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionCalibrate] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionIsOverCurrent] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetAnalogValue] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetCurrentCallbackPeriod] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetCurrentCallbackPeriod] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetAnalogValueCallbackPeriod] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetAnalogValueCallbackPeriod] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetCurrentCallbackThreshold] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetCurrentCallbackThreshold] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetAnalogValueCallbackThreshold] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetAnalogValueCallbackThreshold] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetDebouncePeriod] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetDebouncePeriod] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetIdentity] = ResponseExpectedFlagAlwaysTrue
return Current25Bricklet{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 *Current25Bricklet) 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 *Current25Bricklet) 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 *Current25Bricklet) 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 *Current25Bricklet) GetAPIVersion() [3]uint8 {
return device.device.GetAPIVersion()
}
// This callback is triggered periodically with the period that is set by
// SetCurrentCallbackPeriod. The parameter is the current of the
// sensor.
//
// The RegisterCurrentCallback callback is only triggered if the current has changed since the
// last triggering.
func (device *Current25Bricklet) RegisterCurrentCallback(fn func(int16)) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 10 {
return
}
buf := bytes.NewBuffer(byteSlice[8:])
var current int16
binary.Read(buf, binary.LittleEndian, ¤t)
fn(current)
}
return device.device.RegisterCallback(uint8(FunctionCallbackCurrent), wrapper)
}
// Remove a registered Current callback.
func (device *Current25Bricklet) DeregisterCurrentCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackCurrent), registrationId)
}
// This callback is triggered periodically with the period that is set by
// SetAnalogValueCallbackPeriod. The parameter is the analog value of the
// sensor.
//
// The RegisterAnalogValueCallback callback is only triggered if the current has changed since the
// last triggering.
func (device *Current25Bricklet) RegisterAnalogValueCallback(fn func(uint16)) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 10 {
return
}
buf := bytes.NewBuffer(byteSlice[8:])
var value uint16
binary.Read(buf, binary.LittleEndian, &value)
fn(value)
}
return device.device.RegisterCallback(uint8(FunctionCallbackAnalogValue), wrapper)
}
// Remove a registered Analog Value callback.
func (device *Current25Bricklet) DeregisterAnalogValueCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackAnalogValue), registrationId)
}
// This callback is triggered when the threshold as set by
// SetCurrentCallbackThreshold is reached.
// The parameter is the current of the sensor.
//
// If the threshold keeps being reached, the callback is triggered periodically
// with the period as set by SetDebouncePeriod.
func (device *Current25Bricklet) RegisterCurrentReachedCallback(fn func(int16)) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 10 {
return
}
buf := bytes.NewBuffer(byteSlice[8:])
var current int16
binary.Read(buf, binary.LittleEndian, ¤t)
fn(current)
}
return device.device.RegisterCallback(uint8(FunctionCallbackCurrentReached), wrapper)
}
// Remove a registered Current Reached callback.
func (device *Current25Bricklet) DeregisterCurrentReachedCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackCurrentReached), registrationId)
}
// This callback is triggered when the threshold as set by
// SetAnalogValueCallbackThreshold is reached.
// The parameter is the analog value of the sensor.
//
// If the threshold keeps being reached, the callback is triggered periodically
// with the period as set by SetDebouncePeriod.
func (device *Current25Bricklet) RegisterAnalogValueReachedCallback(fn func(uint16)) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 10 {
return
}
buf := bytes.NewBuffer(byteSlice[8:])
var value uint16
binary.Read(buf, binary.LittleEndian, &value)
fn(value)
}
return device.device.RegisterCallback(uint8(FunctionCallbackAnalogValueReached), wrapper)
}
// Remove a registered Analog Value Reached callback.
func (device *Current25Bricklet) DeregisterAnalogValueReachedCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackAnalogValueReached), registrationId)
}
// This callback is triggered when an over current is measured
// (see IsOverCurrent).
func (device *Current25Bricklet) RegisterOverCurrentCallback(fn func()) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 8 {
return
}
fn()
}
return device.device.RegisterCallback(uint8(FunctionCallbackOverCurrent), wrapper)
}
// Remove a registered Over Current callback.
func (device *Current25Bricklet) DeregisterOverCurrentCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackOverCurrent), registrationId)
}
// Returns the current of the sensor.
//
// If you want to get the current periodically, it is recommended to use the
// RegisterCurrentCallback callback and set the period with
// SetCurrentCallbackPeriod.
func (device *Current25Bricklet) GetCurrent() (current int16, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetCurrent), buf.Bytes())
if err != nil {
return current, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return current, DeviceError(header.ErrorCode)
}
if header.Length != 10 {
return current, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 10)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, ¤t)
}
return current, nil
}
// Calibrates the 0 value of the sensor. You have to call this function
// when there is no current present.
//
// The zero point of the current sensor
// is depending on the exact properties of the analog-to-digital converter,
// the length of the Bricklet cable and the temperature. Thus, if you change
// the Brick or the environment in which the Bricklet is used, you might
// have to recalibrate.
//
// The resulting calibration will be saved on the EEPROM of the Current
// Bricklet.
func (device *Current25Bricklet) Calibrate() (err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Set(uint8(FunctionCalibrate), 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 *true* if more than 25A were measured.
//
// Note
// To reset this value you have to power cycle the Bricklet.
func (device *Current25Bricklet) IsOverCurrent() (over bool, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionIsOverCurrent), buf.Bytes())
if err != nil {
return over, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return over, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return over, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &over)
}
return over, nil
}
// Returns the value as read by a 12-bit analog-to-digital converter.
//
// Note
// The value returned by GetCurrent is averaged over several samples
// to yield less noise, while GetAnalogValue gives back raw
// unfiltered analog values. The only reason to use GetAnalogValue is,
// if you need the full resolution of the analog-to-digital converter.
//
// If you want the analog value periodically, it is recommended to use the
// RegisterAnalogValueCallback callback and set the period with
// SetAnalogValueCallbackPeriod.
func (device *Current25Bricklet) GetAnalogValue() (value uint16, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetAnalogValue), 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
}
// Sets the period with which the RegisterCurrentCallback callback is triggered
// periodically. A value of 0 turns the callback off.
//
// The RegisterCurrentCallback callback is only triggered if the current has changed since
// the last triggering.
func (device *Current25Bricklet) SetCurrentCallbackPeriod(period uint32) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, period)
resultBytes, err := device.device.Set(uint8(FunctionSetCurrentCallbackPeriod), 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 period as set by SetCurrentCallbackPeriod.
func (device *Current25Bricklet) GetCurrentCallbackPeriod() (period uint32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetCurrentCallbackPeriod), buf.Bytes())
if err != nil {
return period, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return period, DeviceError(header.ErrorCode)
}
if header.Length != 12 {
return period, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 12)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &period)
}
return period, nil
}
// Sets the period with which the RegisterAnalogValueCallback callback is triggered
// periodically. A value of 0 turns the callback off.
//
// The RegisterAnalogValueCallback callback is only triggered if the analog value has
// changed since the last triggering.
func (device *Current25Bricklet) SetAnalogValueCallbackPeriod(period uint32) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, period)
resultBytes, err := device.device.Set(uint8(FunctionSetAnalogValueCallbackPeriod), 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 period as set by SetAnalogValueCallbackPeriod.
func (device *Current25Bricklet) GetAnalogValueCallbackPeriod() (period uint32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetAnalogValueCallbackPeriod), buf.Bytes())
if err != nil {
return period, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return period, DeviceError(header.ErrorCode)
}
if header.Length != 12 {
return period, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 12)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &period)
}
return period, nil
}
// Sets the thresholds for the RegisterCurrentReachedCallback callback.
//
// The following options are possible:
//
// Option| Description
// --- | ---
// 'x'| Callback is turned off
// 'o'| Callback is triggered when the current is *outside* the min and max values
// 'i'| Callback is triggered when the current is *inside* the min and max values
// '<'| Callback is triggered when the current is smaller than the min value (max is ignored)
// '>'| Callback is triggered when the current is greater than the min value (max is ignored)
//
// Associated constants:
//
// * ThresholdOptionOff
// * ThresholdOptionOutside
// * ThresholdOptionInside
// * ThresholdOptionSmaller
// * ThresholdOptionGreater
func (device *Current25Bricklet) SetCurrentCallbackThreshold(option ThresholdOption, min int16, max int16) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, option)
binary.Write(&buf, binary.LittleEndian, min)
binary.Write(&buf, binary.LittleEndian, max)
resultBytes, err := device.device.Set(uint8(FunctionSetCurrentCallbackThreshold), 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 threshold as set by SetCurrentCallbackThreshold.
//
// Associated constants:
//
// * ThresholdOptionOff
// * ThresholdOptionOutside
// * ThresholdOptionInside
// * ThresholdOptionSmaller
// * ThresholdOptionGreater
func (device *Current25Bricklet) GetCurrentCallbackThreshold() (option ThresholdOption, min int16, max int16, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetCurrentCallbackThreshold), buf.Bytes())
if err != nil {
return option, min, max, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return option, min, max, DeviceError(header.ErrorCode)
}
if header.Length != 13 {
return option, min, max, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 13)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &option)
binary.Read(resultBuf, binary.LittleEndian, &min)
binary.Read(resultBuf, binary.LittleEndian, &max)
}
return option, min, max, nil
}
// Sets the thresholds for the RegisterAnalogValueReachedCallback callback.
//
// The following options are possible:
//
// Option| Description
// --- | ---
// 'x'| Callback is turned off
// 'o'| Callback is triggered when the analog value is *outside* the min and max values
// 'i'| Callback is triggered when the analog value is *inside* the min and max values
// '<'| Callback is triggered when the analog value is smaller than the min value (max is ignored)
// '>'| Callback is triggered when the analog value is greater than the min value (max is ignored)
//
// Associated constants:
//
// * ThresholdOptionOff
// * ThresholdOptionOutside
// * ThresholdOptionInside
// * ThresholdOptionSmaller
// * ThresholdOptionGreater
func (device *Current25Bricklet) SetAnalogValueCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, option)
binary.Write(&buf, binary.LittleEndian, min)
binary.Write(&buf, binary.LittleEndian, max)
resultBytes, err := device.device.Set(uint8(FunctionSetAnalogValueCallbackThreshold), 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 threshold as set by SetAnalogValueCallbackThreshold.
//
// Associated constants:
//
// * ThresholdOptionOff
// * ThresholdOptionOutside
// * ThresholdOptionInside
// * ThresholdOptionSmaller
// * ThresholdOptionGreater
func (device *Current25Bricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetAnalogValueCallbackThreshold), buf.Bytes())
if err != nil {
return option, min, max, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return option, min, max, DeviceError(header.ErrorCode)
}
if header.Length != 13 {
return option, min, max, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 13)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &option)
binary.Read(resultBuf, binary.LittleEndian, &min)
binary.Read(resultBuf, binary.LittleEndian, &max)
}
return option, min, max, nil
}
// Sets the period with which the threshold callbacks
//
// * RegisterCurrentReachedCallback,
// * RegisterAnalogValueReachedCallback
//
// are triggered, if the thresholds
//
// * SetCurrentCallbackThreshold,
// * SetAnalogValueCallbackThreshold
//
// keep being reached.
func (device *Current25Bricklet) SetDebouncePeriod(debounce uint32) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, debounce)
resultBytes, err := device.device.Set(uint8(FunctionSetDebouncePeriod), 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 debounce period as set by SetDebouncePeriod.
func (device *Current25Bricklet) GetDebouncePeriod() (debounce uint32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetDebouncePeriod), buf.Bytes())
if err != nil {
return debounce, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return debounce, DeviceError(header.ErrorCode)
}
if header.Length != 12 {
return debounce, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 12)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &debounce)
}
return debounce, nil
}
// Returns the UID, the UID where the Bricklet is connected to,
// the position, the hardware and firmware version as well as the
// device identifier.
//
// The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
// A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at
// position 'z'.
//
// The device identifier numbers can be found `here <device_identifier>`.
// |device_identifier_constant|
func (device *Current25Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetIdentity), buf.Bytes())
if err != nil {
return uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier, DeviceError(header.ErrorCode)
}
if header.Length != 33 {
return uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 33)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
uid = ByteSliceToString(resultBuf.Next(8))
connectedUid = ByteSliceToString(resultBuf.Next(8))
position = rune(resultBuf.Next(1)[0])
binary.Read(resultBuf, binary.LittleEndian, &hardwareVersion)
binary.Read(resultBuf, binary.LittleEndian, &firmwareVersion)
binary.Read(resultBuf, binary.LittleEndian, &deviceIdentifier)
}
return uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier, nil
}