ble

Documentation

Overview

Package ble implements the Connector interface using BLE.

Index

• Variables
• func VehicleLocalName(vin string) string
• type Advertisement
  • func ScanVehicleBeacon(ctx context.Context, vin string) (Advertisement, error)
• type Connection
  • func NewConnection(ctx context.Context, vin string) (*Connection, error)
  • func NewConnectionToBleTarget(ctx context.Context, vin string, target Advertisement) (*Connection, error)
  • func (c *Connection) AllowedLatency() time.Duration
  • func (c *Connection) Close()
  • func (c *Connection) PreferredAuthMethod() connector.AuthMethod
  • func (c *Connection) Receive() <-chan []byte
  • func (c *Connection) RetryInterval() time.Duration
  • func (c *Connection) Send(_ context.Context, buffer []byte) error
  • func (c *Connection) VIN() string

Variables

var ErrMaxConnectionsExceeded = protocol.NewError("the vehicle is already connected to the maximum number of BLE devices", false, false)

Functions

func VehicleLocalName

func VehicleLocalName(vin string) string

Types

type Advertisement

type Advertisement = ble.Advertisement

func ScanVehicleBeacon

func ScanVehicleBeacon(ctx context.Context, vin string) (Advertisement, error)

type Connection

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

func NewConnection

func NewConnection(ctx context.Context, vin string) (*Connection, error)

func NewConnectionToBleTarget

func NewConnectionToBleTarget(ctx context.Context, vin string, target Advertisement) (*Connection, error)

func (*Connection) AllowedLatency

func (c *Connection) AllowedLatency() time.Duration

func (*Connection) Close

func (c *Connection) Close()

func (*Connection) PreferredAuthMethod

func (c *Connection) PreferredAuthMethod() connector.AuthMethod

func (*Connection) Receive

func (c *Connection) Receive() <-chan []byte

func (*Connection) RetryInterval

func (c *Connection) RetryInterval() time.Duration

func (*Connection) Send

func (c *Connection) Send(_ context.Context, buffer []byte) error

func (*Connection) VIN

func (c *Connection) VIN() string