ble

package module

Go to main page

Versions in this module

v0

v0.0.13

Jul 18, 2024

v0.0.12

Jul 2, 2024

Changes in this version

type Device

+ SetDisconnectedHandler func(func(Conn)) error

v0.0.11

May 31, 2024

v0.0.10

May 31, 2024

v0.0.9

Mar 17, 2022

Changes in this version

type UUID

+ func (u *UUID) MarshalJSON() ([]byte, error)

+ func (u *UUID) UnmarshalJSON(bs []byte) error

v0.0.8

Aug 26, 2020

v0.0.7

Jul 9, 2020

v0.0.6

Jul 9, 2020

Changes in this version

+ var ErrAlreadyInitialized = errors.New("already initialized")

+ var ErrRestartScan = errors.New("unable to restart scanning for bluetooth devices after connection")

+ func Close() error

+ type AddressType uint8

+ const AddressTypePublic

+ const AddressTypeRandom

type Advertisement

+ AddressType func() AddressType

type Client

+ func DialBLE(ctx context.Context, address Addr, addressType AddressType) (Client, error)

+ type ClientBLE interface

+ ClearSubscriptions func() error

+ Connection func() Conn

+ DiscoverCharacteristics func(filter []UUID, s *Service) ([]*Characteristic, error)

+ DiscoverDescriptors func(filter []UUID, c *Characteristic) ([]*Descriptor, error)

+ DiscoverIncludedServices func(filter []UUID, s *Service) ([]*Service, error)

+ DiscoverProfile func(force bool) (*Profile, error)

+ DiscoverServices func(filter []UUID) ([]*Service, error)

+ ExchangeMTU func(rxMTU int) (txMTU int, err error)

+ Name func() string

+ Profile func() *Profile

+ ReadCharacteristic func(c *Characteristic) ([]byte, error)

+ ReadDescriptor func(d *Descriptor) ([]byte, error)

+ ReadLongCharacteristic func(c *Characteristic) ([]byte, error)

+ ReadRSSI func() int

+ Subscribe func(c *Characteristic, ind bool, h NotificationHandler) error

+ Unsubscribe func(c *Characteristic, ind bool) error

+ WriteCharacteristic func(c *Characteristic, value []byte, noRsp bool) error

+ WriteDescriptor func(d *Descriptor, v []byte) error

+ type ClientRFCOMM interface

type Conn

+ Close func(ctx context.Context) error

type Device

+ Advertise func(ctx context.Context, adv Advertisement) error

+ Close func() error

+ DialBLE func(context.Context, Addr, AddressType) (ClientBLE, error)

+ Initialize func(context.Context) error

type Inquiry

+ AddressType func() AddressType

type Profile

+ func (p *Profile) FindCharacteristic(char *Characteristic) *Characteristic

+ func (p *Profile) FindDescriptor(desc *Descriptor) *Descriptor

+ func (p *Profile) FindService(service *Service) *Service

v0.0.5

Nov 25, 2019

v0.0.4

Nov 25, 2019

Changes in this version

type Device

+ Closed func() <-chan struct{}

+ Error func() error

v0.0.3

Mar 4, 2019

Changes in this version

type Device

+ SocketError func() <-chan error

v0.0.2

May 2, 2018

v0.0.1

Feb 6, 2018

Changes in this version

+ const DefaultACLMTU

+ const DefaultMTU

+ const MaxACLMTU

+ const MaxMTU

+ var AppearanceUUID = UUID16(0x2A01)

+ var BatteryUUID = UUID16(0x180F)

+ var CharacteristicUUID = UUID16(0x2803)

+ var ClientCharacteristicConfigUUID = UUID16(0x2902)

+ var CurrentTimeUUID = UUID16(0x1805)

+ var DeviceInfoUUID = UUID16(0x180A)

+ var DeviceNameUUID = UUID16(0x2A00)

+ var ErrDefaultDevice = errors.New("default device is not set")

+ var ErrEIRPacketTooLong = errors.New("max packet length is 31")

+ var ErrNotImplemented = errors.New("not implemented")

+ var GAPUUID = UUID16(0x1800)

+ var GATTUUID = UUID16(0x1801)

+ var HIDUUID = UUID16(0x1812)

+ var IncludeUUID = UUID16(0x2802)

+ var PeferredParamsUUID = UUID16(0x2A04)

+ var PeripheralPrivacyUUID = UUID16(0x2A02)

+ var PrimaryServiceUUID = UUID16(0x2800)

+ var ReconnectionAddrUUID = UUID16(0x2A03)

+ var SecondaryServiceUUID = UUID16(0x2801)

+ var ServerCharacteristicConfigUUID = UUID16(0x2903)

+ var ServiceChangedUUID = UUID16(0x2A05)

+ func AddService(svc *Service) error

+ func AdvertiseIBeacon(ctx context.Context, u UUID, major, minor uint16, pwr int8) error

+ func AdvertiseIBeaconData(ctx context.Context, b []byte) error

+ func AdvertiseNameAndServices(ctx context.Context, name string, uuids ...UUID) error

+ func Contains(s []UUID, u UUID) bool

+ func Inquire(ctx context.Context, numResponses int, h InqHandler) error

+ func Name(u UUID) string

+ func RemoveAllServices() error

+ func Reverse(u []byte) []byte

+ func Scan(ctx context.Context, allowDup bool, h AdvHandler, f AdvFilter) error

+ func SetDefaultDevice(d Device)

+ func SetServices(svcs []*Service) error

+ func Stop() error

+ func WithSigHandler(ctx context.Context, cancel func()) context.Context

+ type ATTError byte

+ const ErrAttrNotFound

+ const ErrAttrNotLong

+ const ErrAuthentication

+ const ErrAuthorization

+ const ErrInsuffEnc

+ const ErrInsuffEncrKeySize

+ const ErrInsuffResources

+ const ErrInvalAttrValueLen

+ const ErrInvalidHandle

+ const ErrInvalidOffset

+ const ErrInvalidPDU

+ const ErrPrepQueueFull

+ const ErrReadNotPerm

+ const ErrReqNotSupp

+ const ErrSuccess

+ const ErrUnlikely

+ const ErrUnsuppGrpType

+ const ErrWriteNotPerm

+ func (e ATTError) Error() string

+ type Addr interface

+ func NewAddr(s string) Addr

+ type AdvFilter func(a Advertisement) bool

+ type AdvHandler func(a Advertisement)

+ type Advertisement interface

+ Address func() Addr

+ Connectable func() bool

+ LocalName func() string

+ ManufacturerData func() []byte

+ OverflowService func() []UUID

+ RSSI func() int

+ ServiceData func() []ServiceData

+ Services func() []UUID

+ SolicitedService func() []UUID

+ TxPowerLevel func() int

+ func Find(ctx context.Context, allowDup bool, f AdvFilter) ([]Advertisement, error)

+ type Characteristic struct

+ CCCD *Descriptor

+ Descriptors []*Descriptor

+ EndHandle uint16

+ Handle uint16

+ IndicateHandler NotifyHandler

+ NotifyHandler NotifyHandler

+ Property Property

+ ReadHandler ReadHandler

+ Secure Property

+ UUID UUID

+ Value []byte

+ ValueHandle uint16

+ WriteHandler WriteHandler

+ func NewCharacteristic(u UUID) *Characteristic

+ func (c *Characteristic) AddDescriptor(d *Descriptor) *Descriptor

+ func (c *Characteristic) HandleIndicate(h NotifyHandler)

+ func (c *Characteristic) HandleNotify(h NotifyHandler)

+ func (c *Characteristic) HandleRead(h ReadHandler)

+ func (c *Characteristic) HandleWrite(h WriteHandler)

+ func (c *Characteristic) NewDescriptor(u UUID) *Descriptor

+ func (c *Characteristic) SetValue(b []byte)

+ type Client interface

+ Address func() Addr

+ CancelConnection func() error

+ ClearSubscriptions func() error

+ Connection func() Conn

+ Disconnected func() <-chan struct{}

+ DiscoverCharacteristics func(filter []UUID, s *Service) ([]*Characteristic, error)

+ DiscoverDescriptors func(filter []UUID, c *Characteristic) ([]*Descriptor, error)

+ DiscoverIncludedServices func(filter []UUID, s *Service) ([]*Service, error)

+ DiscoverProfile func(force bool) (*Profile, error)

+ DiscoverServices func(filter []UUID) ([]*Service, error)

+ ExchangeMTU func(rxMTU int) (txMTU int, err error)

+ Name func() string

+ Profile func() *Profile

+ ReadCharacteristic func(c *Characteristic) ([]byte, error)

+ ReadDescriptor func(d *Descriptor) ([]byte, error)

+ ReadLongCharacteristic func(c *Characteristic) ([]byte, error)

+ ReadRSSI func() int

+ Subscribe func(c *Characteristic, ind bool, h NotificationHandler) error

+ Unsubscribe func(c *Characteristic, ind bool) error

+ WriteCharacteristic func(c *Characteristic, value []byte, noRsp bool) error

+ WriteDescriptor func(d *Descriptor, v []byte) error

+ func Connect(ctx context.Context, f AdvFilter) (Client, error)

+ func Dial(ctx context.Context, a Addr) (Client, error)

+ type Conn interface

+ Context func() context.Context

+ Disconnected func() <-chan struct{}

+ LocalAddr func() Addr

+ Read func([]byte) (n int, err error)

+ RemoteAddr func() Addr

+ RxMTU func() int

+ SetContext func(ctx context.Context)

+ SetRxMTU func(mtu int)

+ SetTxMTU func(mtu int)

+ TxMTU func() int

+ type Descriptor struct

+ Handle uint16

+ Property Property

+ ReadHandler ReadHandler

+ UUID UUID

+ Value []byte

+ WriteHandler WriteHandler

+ func NewDescriptor(u UUID) *Descriptor

+ func (d *Descriptor) HandleRead(h ReadHandler)

+ func (d *Descriptor) HandleWrite(h WriteHandler)

+ func (d *Descriptor) SetValue(b []byte)

+ type Device interface

+ AddService func(svc *Service) error

+ AdvertiseIBeacon func(ctx context.Context, u UUID, major, minor uint16, pwr int8) error

+ AdvertiseIBeaconData func(ctx context.Context, b []byte) error

+ AdvertiseMfgData func(ctx context.Context, id uint16, b []byte) error

+ AdvertiseNameAndServices func(ctx context.Context, name string, uuids ...UUID) error

+ AdvertiseServiceData16 func(ctx context.Context, id uint16, b []byte) error

+ Dial func(ctx context.Context, a Addr) (Client, error)

+ DialRFCOMM func(ctx context.Context, a Addr, clockOffset uint16, ...) (RFCOMMClient, error)

+ Inquire func(ctx context.Context, numResponses int, h InqHandler) error

+ RemoveAllServices func() error

+ RequestRemoteName func(a Addr) (string, error)

+ Scan func(ctx context.Context, allowDup bool, h AdvHandler) error

+ SetServices func(svcs []*Service) error

+ Stop func() error

+ type InqHandler func(i Inquiry)

+ type Inquiry interface

+ Address func() Addr

+ ClassOfDevice func() [3]byte

+ ClockOffset func() uint16

+ ExtendedInquiryResponse func() [240]byte

+ PageScanRepetitionMode func() uint8

+ RSSI func() int

+ type NotificationHandler func(req []byte)

+ type Notifier interface

+ Cap func() int

+ Close func() error

+ Context func() context.Context

+ Write func(b []byte) (int, error)

+ func NewNotifier(send func([]byte) (int, error)) Notifier

+ type NotifyHandler interface

+ ServeNotify func(req Request, n Notifier)

+ type NotifyHandlerFunc func(req Request, n Notifier)

+ func (f NotifyHandlerFunc) ServeNotify(req Request, n Notifier)

+ type Profile struct

+ Services []*Service

+ func (p *Profile) Find(target interface{}) interface{}

+ type Property int

+ const CharBroadcast

+ const CharExtended

+ const CharIndicate

+ const CharNotify

+ const CharRead

+ const CharSignedWrite

+ const CharWrite

+ const CharWriteNR

+ type RFCOMMClient interface

+ Address func() Addr

+ CancelConnection func() error

+ Disconnected func() <-chan struct{}

+ Read func([]byte) (int, error)

+ Write func([]byte) (int, error)

+ func DialRFCOMM(ctx context.Context, a Addr, clockOffset uint16, ...) (RFCOMMClient, error)

+ type ReadHandler interface

+ ServeRead func(req Request, rsp ResponseWriter)

+ type ReadHandlerFunc func(req Request, rsp ResponseWriter)

+ func (f ReadHandlerFunc) ServeRead(req Request, rsp ResponseWriter)

+ type Request interface

+ Conn func() Conn

+ Data func() []byte

+ Offset func() int

+ func NewRequest(conn Conn, data []byte, offset int) Request

+ type ResponseWriter interface

+ Cap func() int

+ Len func() int

+ SetStatus func(status ATTError)

+ Status func() ATTError

+ Write func(b []byte) (int, error)

+ func NewResponseWriter(buf *bytes.Buffer) ResponseWriter

+ type Service struct

+ Characteristics []*Characteristic

+ EndHandle uint16

+ Handle uint16

+ UUID UUID

+ func NewService(u UUID) *Service

+ func (s *Service) AddCharacteristic(c *Characteristic) *Characteristic

+ func (s *Service) NewCharacteristic(u UUID) *Characteristic

+ type ServiceData struct

+ Data []byte

+ UUID UUID

+ type UUID []byte

+ func MustParse(s string) UUID

+ func Parse(s string) (UUID, error)

+ func UUID16(i uint16) UUID

+ func (u UUID) Equal(v UUID) bool

+ func (u UUID) Len() int

+ func (u UUID) String() string

+ type WriteHandler interface

+ ServeWrite func(req Request, rsp ResponseWriter)

+ type WriteHandlerFunc func(req Request, rsp ResponseWriter)

+ func (f WriteHandlerFunc) ServeWrite(req Request, rsp ResponseWriter)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL