https://github.com/fako1024/btscale
Data access and management of bluetooth-based scales
https://github.com/fako1024/btscale
barista bluetooth bluetooth-low-energy coffee coffee-scale scales
Last synced: 3 months ago
JSON representation
Data access and management of bluetooth-based scales
- Host: GitHub
- URL: https://github.com/fako1024/btscale
- Owner: fako1024
- License: apache-2.0
- Created: 2020-09-12T12:10:25.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T08:38:31.000Z (about 1 year ago)
- Last Synced: 2024-07-29T11:48:45.787Z (about 1 year ago)
- Topics: barista, bluetooth, bluetooth-low-energy, coffee, coffee-scale, scales
- Language: Go
- Homepage:
- Size: 58.6 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go package to facilitate data access and management of Bluetooth-based scales
[](https://github.com/fako1024/btscale/releases)
[](https://godoc.org/github.com/fako1024/btscale/)
[](https://goreportcard.com/report/github.com/fako1024/btscale)
[](https://github.com/fako1024/btscale/actions?query=workflow%3AGo)
This package allows to extract structured data from bluetooth-based remote scales and provides a management interface to control said devices. Usage is fairly trivial (see examples directory for a simple console logger implementation and a tool for controlling basic functions).
## Features
- Control of basic settings (via multiple interfaces)
- Status
- Battery level
- Weight unit
- Measurement precision
- Buzzer
- Extraction of scale data (both channel and handler concept supported)
- Timestamp
- Weight / Unit
- Timer functionality
- REST API wrapper (optional) to support remote interaction with scale functions
## Installation
```bash
go get -u github.com/fako1024/btscale
```
## API summary
The following API interfaces / methods are exposed:
```
// Basic denotes a basic coffee scale
type Basic interface {
// ConnectionStatus returns the current connection status of the scale device
ConnectionStatus() ConnectionStatus
// BatteryLevel returns the current battery level
BatteryLevel() float64
// BatteryLevelRaw returns the current battery level in its raw form
BatteryLevelRaw() int
// Unit returns the current weight unit
Unit() Unit
// SetUnit sets the weight unit
SetUnit(unit Unit) error
// Tare tares the scale
Tare() error
// TogglePrecision toggles the weight precision between 0.1 and 0.01
TogglePrecision() error
// SetStateChangeHandler defines a handler function that is called upon state change
SetStateChangeHandler(fn func(status ConnectionStatus))
// SetStateChangeChannel defines a handler function that is called upon state change
SetStateChangeChannel(ch chan ConnectionStatus)
// SetDataHandler defines a handler function that is called upon retrieval of data
SetDataHandler(fn func(data DataPoint))
// SetDataChannel defines a handler function that is called upon retrieval of data
SetDataChannel(ch chan DataPoint)
// Close terminates the connection to the device
Close() error
}
// Buzzer denotes audible signaling functionality
type Buzzer interface {
// IsBuzzingOnTouch returs if the buzzer (on user interaction) is on / off
IsBuzzingOnTouch() bool
// ToggleBuzzingOnTouch turns the buzzer (on user interaction) on / off
ToggleBuzzingOnTouch() error
// Buzz requests the scale to beep / buzz n times
Buzz(n int) error
}
// Timer denotes timer / stopwatch functionality
type Timer interface {
// StartTimer starts the timer / stopwatch
StartTimer() error
// StopTimer stops the timer / stopwatch
StopTimer() error
// ResetTimer resets the timer / stopwatch
ResetTimer() error
// ElapsedTime returns the current timer value
ElapsedTime() time.Duration
}
// WithTimer denotes a scale with timer functionality
type WithTimer interface {
Basic
Timer
}
// WithBuzzer denotes a scale with buzzer functionality
type WithBuzzer interface {
Basic
Buzzer
}
// Scale denotes the "default" scale containing all functionality
type Scale interface {
Basic
Buzzer
Timer
}
```
## Example
```go
// Initialize a simple logger for convenience
log := logrus.StandardLogger()
// Initialize a new Felicita bluetooth scale
s, err := felicita.New()
if err != nil {
log.Fatalf("Error opening Felicita scale: %s", err)
}
// Start up the REST API on port 8090 (all interfaces)
api.New(s, ":8090")
// Set a data channel to continuously log incoming data
dataChan := make(chan scale.DataPoint, 256)
s.SetDataChannel(dataChan)
// Setup a state handler to notify upon connection status change
s.SetStateChangeHandler(func(status scale.ConnectionStatus) {
log.Warnf("State change: %v", status)
})
// Setup a signal channel to gracefully disconnect the bluetooth device upon termination
sigChan := make(chan os.Signal)
signal.Notify(sigChan, syscall.SIGTERM)
signal.Notify(sigChan, os.Interrupt)
go func() {
<-sigChan
log.Infof("Got signal, terminating connection to device")
s.Close()
os.Exit(0)
}()
for v := range dataChan {
log.Warnf("Read DATA from Channel: %v, %v, %v, %v, %v", v, s.ConnectionStatus(), s.BatteryLevel(), s.IsBuzzingOnTouch(), s.ElapsedTime())
}
```
For additional examples please refer to the `cmd` folder.