presence

Documentation

Index

• type Action
• type ActionFunc
  • func (a ActionFunc) Status(mac string, found bool)
• type BluetoothScanner
• type HCITool
  • func NewHCITool() (*HCITool, error)
  • func (h *HCITool) IsPresent(ctx context.Context, mac string) (bool, error)
• type Presence
  • func New(btScanner BluetoothScanner) *Presence
  • func (p *Presence) RegisterAction(mac string, actions ...Action)
  • func (p *Presence) Scan(ctx context.Context)
  • func (p *Presence) ScanPeriodically(ctx context.Context, interval time.Duration)
  • func (p *Presence) UnregisterActions(mac string)

Types

type Action

type Action interface {
	Status(mac string, found bool)
}

Action Status function is called with the processed MAC address and info whether the device was found or not

type ActionFunc

type ActionFunc func(mac string, found bool)

ActionFunc is called with the processed MAC address and info whether the device was found or not

func (ActionFunc) Status

func (a ActionFunc) Status(mac string, found bool)

Status is called with the status of the given MAC address

type BluetoothScanner

type BluetoothScanner interface {
	IsPresent(context context.Context, mac string) (bool, error)
}

BluetoothScanner provides required methods to scan for bluetooth devices

type HCITool

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

HCITool is the default BluetoothScanner implementation

func NewHCITool

func NewHCITool() (*HCITool, error)

NewHCITool returns a new instance of HCITool

func (*HCITool) IsPresent

func (h *HCITool) IsPresent(ctx context.Context, mac string) (bool, error)

IsPresent checks if bluetooth device with given MAC address can be found

type Presence

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

Presence allows scanning for nearby bluetooth devices based on their MAC address

func New

func New(btScanner BluetoothScanner) *Presence

New returns new Presence instance

func (*Presence) RegisterAction

func (p *Presence) RegisterAction(mac string, actions ...Action)

RegisterAction registers one ore more actions for a certain MAC address.

Note: Given actions are added to already existing registered actions for given MAC address.

func (*Presence) Scan

func (p *Presence) Scan(ctx context.Context)

Scan executes a single presence check for all registered MAC addresses and calls action functions with the scan result.

func (*Presence) ScanPeriodically

func (p *Presence) ScanPeriodically(ctx context.Context, interval time.Duration)

ScanPeriodically will call Scan periodically with a given interval after a run cycle has finished

func (*Presence) UnregisterActions

func (p *Presence) UnregisterActions(mac string)

UnregisterActions removes all registered actions for a given MAC address

If no actions are registered, this method is a no-op.