scanner

Documentation

Index

• func Filter(peripherals map[string]string) func(ble.Advertisement) bool
• func LogInvalidData(ctx context.Context, logger *slog.Logger, data []byte, err error)
• func NewMockBLEScanner(advertisements ...ble.Advertisement) *mockBLEScanner
• func Read(a ble.Advertisement) (sd commonsensor.Data, err error)
• func Validate(cfg Config) error
• type BLEScanner
• type Config
  • func DefaultConfig() Config
• type DeviceCreator
• type Discover
  • func NewDiscover(device string, ble BLEScanner, dev DeviceCreator, logger *slog.Logger) (*Discover, error)
  • func (d *Discover) Close() error
  • func (d *Discover) Discover(ctx context.Context) ([]string, error)
• type GoBLEDeviceCreator
  • func (c *GoBLEDeviceCreator) NewDevice(impl string) (ble.Device, error)
• type GoBLEScanner
  • func (s *GoBLEScanner) Scan(ctx context.Context, allowDup bool, h ble.AdvHandler, f ble.AdvFilter) error
• type Measurements
  • func (s *Measurements) Channel(ctx context.Context) chan sensor.Data
• type Scanner
  • func NewContinuous(cfg Config) (Scanner, error)
  • func NewInterval(cfg Config) (Scanner, error)
  • func NewOnce(cfg Config) (Scanner, error)

Functions

func Filter

func Filter(peripherals map[string]string) func(ble.Advertisement) bool

func LogInvalidData

func LogInvalidData(ctx context.Context, logger *slog.Logger, data []byte, err error)

LogInvalidData logs invalid BLE advertisement data

func NewMockBLEScanner

func NewMockBLEScanner(advertisements ...ble.Advertisement) *mockBLEScanner

func Read

func Read(a ble.Advertisement) (sd commonsensor.Data, err error)

Read reads sensor data from advertisement

func Validate

func Validate(cfg Config) error

Types

type BLEScanner

type BLEScanner interface {
	Scan(ctx context.Context, allowDup bool, h ble.AdvHandler, f ble.AdvFilter) error
}

type Config

type Config struct {
	Exporters     []exporter.Exporter
	DeviceName    string
	BLEScanner    BLEScanner
	Peripherals   map[string]string
	DeviceCreator DeviceCreator
	Logger        *slog.Logger
}

func DefaultConfig

func DefaultConfig() Config

type DeviceCreator

type DeviceCreator interface {
	NewDevice(impl string) (ble.Device, error)
}

type Discover

type Discover struct {
	// contains filtered or unexported fields
}

func NewDiscover

func NewDiscover(device string, ble BLEScanner, dev DeviceCreator, logger *slog.Logger) (*Discover, error)

func (*Discover) Close

func (d *Discover) Close() error

func (*Discover) Discover

func (d *Discover) Discover(ctx context.Context) ([]string, error)

type GoBLEDeviceCreator

type GoBLEDeviceCreator struct {
}

func (*GoBLEDeviceCreator) NewDevice

func (c *GoBLEDeviceCreator) NewDevice(impl string) (ble.Device, error)

type GoBLEScanner

type GoBLEScanner struct {
}

func (*GoBLEScanner) Scan

func (s *GoBLEScanner) Scan(ctx context.Context, allowDup bool, h ble.AdvHandler, f ble.AdvFilter) error

type Measurements

type Measurements struct {
	BLE         BLEScanner
	Peripherals map[string]string
	Logger      *slog.Logger
}

func (*Measurements) Channel

func (s *Measurements) Channel(ctx context.Context) chan sensor.Data

Channel creates a channel that will receive measurements read from all registered peripherals. The cancel function should be called after the client is done with receiving measurements or wishes to abort the scan.

type Scanner

type Scanner interface {
	io.Closer
	Scan(ctx context.Context, interval time.Duration) error
}

func NewContinuous

func NewContinuous(cfg Config) (Scanner, error)

func NewInterval

func NewInterval(cfg Config) (Scanner, error)

func NewOnce

func NewOnce(cfg Config) (Scanner, error)