ble

README

BLE Plugin

Documentation

Documentation

Index

• Constants
• Variables
• func GetReadBind(actor *Actor) func(char string) Response
• func GetWriteBind(actor *Actor) func(char string, payload []byte, withResponse bool) Response
• func New() plugins.Pluggable
• func NewActions() map[string]plugins.ActorAction
• func NewSettings() map[string]*m.Attribute
• func NewTriggerParams() m.TriggerParams
• type Actor
  • func NewActor(entity *m.Entity, service plugins.Service) (actor *Actor)
  • func (e *Actor) Destroy()
  • func (e *Actor) SetState(params plugins.EntityStateParams) error
  • func (e *Actor) Spawn()
• type Ble
  • func NewBle(address string, timeout, connectionTimeout int64, debug bool) *Ble
  • func (b *Ble) Connect() error
  • func (b *Ble) Disconnect() error
  • func (b *Ble) GetCharacteristics(chars []bluetooth.UUID) ([]bluetooth.DeviceCharacteristic, error)
  • func (b *Ble) GetServices() ([]bluetooth.DeviceService, error)
  • func (b *Ble) IsConnected() bool
  • func (b *Ble) Read(c string) ([]byte, error)
  • func (b *Ble) Scan(param *string)
  • func (b *Ble) Subscribe(c string, handler func([]byte)) error
  • func (b *Ble) Write(c string, request []byte, withResponse bool) ([]byte, error)
• type Bluetooth
• type Response
• type Trigger
  • func NewTrigger(eventBus bus.Bus) *Trigger
  • func (t *Trigger) AsyncAttach(wg *sync.WaitGroup)
  • func (t *Trigger) Connect(params *TriggerParams, firstTime bool) error
  • func (t *Trigger) FunctionName() string
  • func (t *Trigger) Name() string
  • func (t *Trigger) Shutdown()
  • func (t *Trigger) Subscribe(options triggers.Subscriber) error
  • func (t *Trigger) Unsubscribe(options triggers.Subscriber) error
• type TriggerParams

Constants

const (
	// Name ...
	Name = "ble"
	// FuncEntityAction ...
	FuncEntityAction = "entityAction"

	AttrAddress              = "address"
	AttrCharacteristic       = "characteristic"
	AttrService              = "service"
	AttrTimeoutSec           = "timeout_sec"
	AttrConnectionTimeoutSec = "connection_timeout_sec"
	AttrDebug                = "debug"
	ActionScan               = "SCAN"
	AttrSystemInfo           = "SystemInfo"

	FunctionName = "automationTriggerBle"

	DefaultTimeout           int64 = 5
	DefaultConnectionTimeout int64 = 5
)

Variables

var F embed.FS

Functions

func GetReadBind

func GetReadBind(actor *Actor) func(char string) Response

func GetWriteBind

func GetWriteBind(actor *Actor) func(char string, payload []byte, withResponse bool) Response

func New

func New() plugins.Pluggable

New ...

func NewActions

func NewActions() map[string]plugins.ActorAction

func NewSettings

func NewSettings() map[string]*m.Attribute

NewSettings ...

func NewTriggerParams

func NewTriggerParams() m.TriggerParams

Types

type Actor

type Actor struct {
	*supervisor.BaseActor
	// contains filtered or unexported fields
}

Actor ...

func NewActor

func NewActor(entity *m.Entity,
	service plugins.Service) (actor *Actor)

NewActor ...

func (*Actor) Destroy

func (e *Actor) Destroy()

func (*Actor) SetState

func (e *Actor) SetState(params plugins.EntityStateParams) error

SetState ...

func (*Actor) Spawn

func (e *Actor) Spawn()

type Ble

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

func NewBle

func NewBle(address string, timeout, connectionTimeout int64, debug bool) *Ble

func (*Ble) Connect

func (b *Ble) Connect() error

func (*Ble) Disconnect

func (b *Ble) Disconnect() error

func (*Ble) GetCharacteristics

func (b *Ble) GetCharacteristics(chars []bluetooth.UUID) ([]bluetooth.DeviceCharacteristic, error)

func (*Ble) GetServices

func (b *Ble) GetServices() ([]bluetooth.DeviceService, error)

func (*Ble) IsConnected

func (b *Ble) IsConnected() bool

func (*Ble) Read

func (b *Ble) Read(c string) ([]byte, error)

func (*Ble) Scan

func (b *Ble) Scan(param *string)

func (*Ble) Subscribe

func (b *Ble) Subscribe(c string, handler func([]byte)) error

func (*Ble) Write

func (b *Ble) Write(c string, request []byte, withResponse bool) ([]byte, error)

type Bluetooth

type Bluetooth interface {
	Connect() error
	IsConnected() bool
	Disconnect() error
	Scan(address *string)
	Write(char string, request []byte, withResponse bool) ([]byte, error)
	Read(char string) ([]byte, error)
	Subscribe(char string, handler func([]byte)) error
}

type Response

type Response struct {
	Response []byte `json:"response"`
	Error    string `json:"error"`
}

type Trigger

type Trigger struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewTrigger

func NewTrigger(eventBus bus.Bus) *Trigger

func (*Trigger) AsyncAttach

func (t *Trigger) AsyncAttach(wg *sync.WaitGroup)

func (*Trigger) Connect

func (t *Trigger) Connect(params *TriggerParams, firstTime bool) error

func (*Trigger) FunctionName

func (t *Trigger) FunctionName() string

FunctionName ...

func (*Trigger) Name

func (t *Trigger) Name() string

func (*Trigger) Shutdown

func (t *Trigger) Shutdown()

func (*Trigger) Subscribe

func (t *Trigger) Subscribe(options triggers.Subscriber) error

Subscribe ...

func (*Trigger) Unsubscribe

func (t *Trigger) Unsubscribe(options triggers.Subscriber) error

Unsubscribe ...

type TriggerParams

type TriggerParams struct {
	Bluetooth
	// contains filtered or unexported fields
}