/
load_cell_bricklet.go
798 lines (639 loc) · 23.8 KB
/
load_cell_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
/* ***********************************************************
* 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 weight with a load cell.
//
//
// See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/LoadCell_Bricklet_Go.html.
package load_cell_bricklet
import (
"bytes"
"encoding/binary"
"fmt"
. "github.com/Tinkerforge/go-api-bindings/internal"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
type Function = uint8
const (
FunctionGetWeight Function = 1
FunctionSetWeightCallbackPeriod Function = 2
FunctionGetWeightCallbackPeriod Function = 3
FunctionSetWeightCallbackThreshold Function = 4
FunctionGetWeightCallbackThreshold Function = 5
FunctionSetDebouncePeriod Function = 6
FunctionGetDebouncePeriod Function = 7
FunctionSetMovingAverage Function = 8
FunctionGetMovingAverage Function = 9
FunctionLEDOn Function = 10
FunctionLEDOff Function = 11
FunctionIsLEDOn Function = 12
FunctionCalibrate Function = 13
FunctionTare Function = 14
FunctionSetConfiguration Function = 15
FunctionGetConfiguration Function = 16
FunctionGetIdentity Function = 255
FunctionCallbackWeight Function = 17
FunctionCallbackWeightReached Function = 18
)
type ThresholdOption = rune
const (
ThresholdOptionOff ThresholdOption = 'x'
ThresholdOptionOutside ThresholdOption = 'o'
ThresholdOptionInside ThresholdOption = 'i'
ThresholdOptionSmaller ThresholdOption = '<'
ThresholdOptionGreater ThresholdOption = '>'
)
type Rate = uint8
const (
Rate10Hz Rate = 0
Rate80Hz Rate = 1
)
type Gain = uint8
const (
Gain128x Gain = 0
Gain64x Gain = 1
Gain32x Gain = 2
)
type LoadCellBricklet struct {
device Device
}
const DeviceIdentifier = 253
const DeviceDisplayName = "Load Cell 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) (LoadCellBricklet, error) {
internalIPCon := ipcon.GetInternalHandle().(IPConnection)
dev, err := NewDevice([3]uint8{2, 0, 0}, uid, &internalIPCon, 0, DeviceIdentifier, DeviceDisplayName)
if err != nil {
return LoadCellBricklet{}, err
}
dev.ResponseExpected[FunctionGetWeight] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetWeightCallbackPeriod] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetWeightCallbackPeriod] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetWeightCallbackThreshold] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetWeightCallbackThreshold] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetDebouncePeriod] = ResponseExpectedFlagTrue
dev.ResponseExpected[FunctionGetDebouncePeriod] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionSetMovingAverage] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionGetMovingAverage] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionLEDOn] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionLEDOff] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionIsLEDOn] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionCalibrate] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionTare] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionSetConfiguration] = ResponseExpectedFlagFalse
dev.ResponseExpected[FunctionGetConfiguration] = ResponseExpectedFlagAlwaysTrue
dev.ResponseExpected[FunctionGetIdentity] = ResponseExpectedFlagAlwaysTrue
return LoadCellBricklet{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 *LoadCellBricklet) 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 *LoadCellBricklet) 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 *LoadCellBricklet) 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 *LoadCellBricklet) GetAPIVersion() [3]uint8 {
return device.device.GetAPIVersion()
}
// This callback is triggered periodically with the period that is set by
// SetWeightCallbackPeriod. The parameter is the weight
// as measured by the load cell.
//
// The RegisterWeightCallback callback is only triggered if the weight has changed since the
// last triggering.
func (device *LoadCellBricklet) RegisterWeightCallback(fn func(int32)) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 12 {
return
}
buf := bytes.NewBuffer(byteSlice[8:])
var weight int32
binary.Read(buf, binary.LittleEndian, &weight)
fn(weight)
}
return device.device.RegisterCallback(uint8(FunctionCallbackWeight), wrapper)
}
// Remove a registered Weight callback.
func (device *LoadCellBricklet) DeregisterWeightCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackWeight), registrationId)
}
// This callback is triggered when the threshold as set by
// SetWeightCallbackThreshold is reached.
// The parameter is the weight as measured by the load cell.
//
// If the threshold keeps being reached, the callback is triggered periodically
// with the period as set by SetDebouncePeriod.
func (device *LoadCellBricklet) RegisterWeightReachedCallback(fn func(int32)) uint64 {
wrapper := func(byteSlice []byte) {
var header PacketHeader
header.FillFromBytes(byteSlice)
if header.Length != 12 {
return
}
buf := bytes.NewBuffer(byteSlice[8:])
var weight int32
binary.Read(buf, binary.LittleEndian, &weight)
fn(weight)
}
return device.device.RegisterCallback(uint8(FunctionCallbackWeightReached), wrapper)
}
// Remove a registered Weight Reached callback.
func (device *LoadCellBricklet) DeregisterWeightReachedCallback(registrationId uint64) {
device.device.DeregisterCallback(uint8(FunctionCallbackWeightReached), registrationId)
}
// Returns the currently measured weight.
//
// If you want to get the weight periodically, it is recommended
// to use the RegisterWeightCallback callback and set the period with
// SetWeightCallbackPeriod.
func (device *LoadCellBricklet) GetWeight() (weight int32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetWeight), buf.Bytes())
if err != nil {
return weight, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return weight, DeviceError(header.ErrorCode)
}
if header.Length != 12 {
return weight, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 12)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &weight)
}
return weight, nil
}
// Sets the period with which the RegisterWeightCallback callback is triggered
// periodically. A value of 0 turns the callback off.
//
// The RegisterWeightCallback callback is only triggered if the weight has changed since the
// last triggering.
func (device *LoadCellBricklet) SetWeightCallbackPeriod(period uint32) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, period)
resultBytes, err := device.device.Set(uint8(FunctionSetWeightCallbackPeriod), 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 SetWeightCallbackPeriod.
func (device *LoadCellBricklet) GetWeightCallbackPeriod() (period uint32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetWeightCallbackPeriod), 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 RegisterWeightReachedCallback callback.
//
// The following options are possible:
//
// Option| Description
// --- | ---
// 'x'| Callback is turned off
// 'o'| Callback is triggered when the weight is *outside* the min and max values
// 'i'| Callback is triggered when the weight is *inside* the min and max values
// '<'| Callback is triggered when the weight is smaller than the min value (max is ignored)
// '>'| Callback is triggered when the weight is greater than the min value (max is ignored)
//
// Associated constants:
//
// * ThresholdOptionOff
// * ThresholdOptionOutside
// * ThresholdOptionInside
// * ThresholdOptionSmaller
// * ThresholdOptionGreater
func (device *LoadCellBricklet) SetWeightCallbackThreshold(option ThresholdOption, min int32, max int32) (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(FunctionSetWeightCallbackThreshold), 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 SetWeightCallbackThreshold.
//
// Associated constants:
//
// * ThresholdOptionOff
// * ThresholdOptionOutside
// * ThresholdOptionInside
// * ThresholdOptionSmaller
// * ThresholdOptionGreater
func (device *LoadCellBricklet) GetWeightCallbackThreshold() (option ThresholdOption, min int32, max int32, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetWeightCallbackThreshold), 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 != 17 {
return option, min, max, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 17)
}
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 callback
//
// * RegisterWeightReachedCallback
//
// is triggered, if the threshold
//
// * SetWeightCallbackThreshold
//
// keeps being reached.
func (device *LoadCellBricklet) 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 *LoadCellBricklet) 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
}
// Sets the length of a https://en.wikipedia.org/wiki/Moving_average
// for the weight value.
//
// Setting the length to 1 will turn the averaging off. With less
// averaging, there is more noise on the data.
func (device *LoadCellBricklet) SetMovingAverage(average uint8) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, average)
resultBytes, err := device.device.Set(uint8(FunctionSetMovingAverage), 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 length moving average as set by SetMovingAverage.
func (device *LoadCellBricklet) GetMovingAverage() (average uint8, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetMovingAverage), buf.Bytes())
if err != nil {
return average, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return average, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return average, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &average)
}
return average, nil
}
// Turns the LED on.
func (device *LoadCellBricklet) LEDOn() (err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Set(uint8(FunctionLEDOn), 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
}
// Turns the LED off.
func (device *LoadCellBricklet) LEDOff() (err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Set(uint8(FunctionLEDOff), 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 the led is on, *false* otherwise.
func (device *LoadCellBricklet) IsLEDOn() (on bool, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionIsLEDOn), buf.Bytes())
if err != nil {
return on, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return on, DeviceError(header.ErrorCode)
}
if header.Length != 9 {
return on, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 9)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &on)
}
return on, nil
}
// To calibrate your Load Cell Bricklet you have to
//
// * empty the scale and call this function with 0 and
// * add a known weight to the scale and call this function with the weight.
//
// The calibration is saved in the EEPROM of the Bricklet and only
// needs to be done once.
//
// We recommend to use the Brick Viewer for calibration, you don't need
// to call this function in your source code.
func (device *LoadCellBricklet) Calibrate(weight uint32) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, weight)
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
}
// Sets the currently measured weight as tare weight.
func (device *LoadCellBricklet) Tare() (err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Set(uint8(FunctionTare), 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
}
// The measurement rate and gain are configurable.
//
// The rate can be either 10Hz or 80Hz. A faster rate will produce more noise.
// It is additionally possible to add a moving average
// (see SetMovingAverage) to the measurements.
//
// The gain can be 128x, 64x or 32x. It represents a measurement range of
// ±20mV, ±40mV and ±80mV respectively. The Load Cell Bricklet uses an
// excitation voltage of 5V and most load cells use an output of 2mV/V. That
// means the voltage range is ±15mV for most load cells (i.e. gain of 128x
// is best). If you don't know what all of this means you should keep it at
// 128x, it will most likely be correct.
//
// The configuration is saved in the EEPROM of the Bricklet and only
// needs to be done once.
//
// We recommend to use the Brick Viewer for configuration, you don't need
// to call this function in your source code.
//
// Associated constants:
//
// * Rate10Hz
// * Rate80Hz
// * Gain128x
// * Gain64x
// * Gain32x
func (device *LoadCellBricklet) SetConfiguration(rate Rate, gain Gain) (err error) {
var buf bytes.Buffer
binary.Write(&buf, binary.LittleEndian, rate)
binary.Write(&buf, binary.LittleEndian, gain)
resultBytes, err := device.device.Set(uint8(FunctionSetConfiguration), 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 SetConfiguration.
//
// Associated constants:
//
// * Rate10Hz
// * Rate80Hz
// * Gain128x
// * Gain64x
// * Gain32x
func (device *LoadCellBricklet) GetConfiguration() (rate Rate, gain Gain, err error) {
var buf bytes.Buffer
resultBytes, err := device.device.Get(uint8(FunctionGetConfiguration), buf.Bytes())
if err != nil {
return rate, gain, err
}
if len(resultBytes) > 0 {
var header PacketHeader
header.FillFromBytes(resultBytes)
if header.ErrorCode != 0 {
return rate, gain, DeviceError(header.ErrorCode)
}
if header.Length != 10 {
return rate, gain, fmt.Errorf("Received packet of unexpected size %d, instead of %d", header.Length, 10)
}
resultBuf := bytes.NewBuffer(resultBytes[8:])
binary.Read(resultBuf, binary.LittleEndian, &rate)
binary.Read(resultBuf, binary.LittleEndian, &gain)
}
return rate, gain, 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 *LoadCellBricklet) 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
}