Documentation ¶
Index ¶
- Constants
- Variables
- 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 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
- type Addr
- type AdvFilter
- type AdvHandler
- type Advertisement
- type 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
- type Conn
- type ContextKey
- type Descriptor
- type Device
- type NotificationHandler
- type Notifier
- type NotifyHandler
- type NotifyHandlerFunc
- type Profile
- type Property
- type ReadHandler
- type ReadHandlerFunc
- type Request
- type ResponseWriter
- type Service
- type ServiceData
- type UUID
- type WriteHandler
- type WriteHandlerFunc
Constants ¶
const DefaultMTU = 23
DefaultMTU defines the default MTU of ATT protocol including 3 bytes of ATT header.
const MaxMTU = 512 + 3
MaxMTU is maximum of ATT_MTU, which is 512 bytes of value length, plus 3 bytes of ATT header. The maximum length of an attribute value shall be 512 octets [Vol 3, Part F, 3.2.9]
Variables ¶
var ( GAPUUID = UUID16(0x1800) // Generic Access GATTUUID = UUID16(0x1801) // Generic Attribute CurrentTimeUUID = UUID16(0x1805) // Current Time Service DeviceInfoUUID = UUID16(0x180A) // Device Information BatteryUUID = UUID16(0x180F) // Battery Service HIDUUID = UUID16(0x1812) // Human Interface Device PrimaryServiceUUID = UUID16(0x2800) SecondaryServiceUUID = UUID16(0x2801) IncludeUUID = UUID16(0x2802) CharacteristicUUID = UUID16(0x2803) ClientCharacteristicConfigUUID = UUID16(0x2902) ServerCharacteristicConfigUUID = UUID16(0x2903) DeviceNameUUID = UUID16(0x2A00) AppearanceUUID = UUID16(0x2A01) PeripheralPrivacyUUID = UUID16(0x2A02) ReconnectionAddrUUID = UUID16(0x2A03) PeferredParamsUUID = UUID16(0x2A04) ServiceChangedUUID = UUID16(0x2A05) )
UUIDs ...
var ( // ContextKeySig for SigHandler context ContextKeySig = ContextKey("sig") // ContextKeyCCC for per connection contexts ContextKeyCCC = ContextKey("ccc") )
var ErrDefaultDevice = errors.New("default device is not set")
ErrDefaultDevice ...
var ErrEIRPacketTooLong = errors.New("max packet length is 31")
ErrEIRPacketTooLong is the error returned when an AdvertisingPacket or ScanResponsePacket is too long.
var ErrNotImplemented = errors.New("not implemented")
ErrNotImplemented means the functionality is not implemented.
Functions ¶
func AdvertiseIBeacon ¶
AdvertiseIBeacon advertises iBeacon with specified parameters.
func AdvertiseIBeaconData ¶
AdvertiseIBeaconData advertise iBeacon with given manufacturer data.
func AdvertiseNameAndServices ¶
AdvertiseNameAndServices advertises device name, and specified service UUIDs. It tres to fit the UUIDs in the advertising packet as much as possi If name doesn't fit in the advertising packet, it will be put in scan response.
func RemoveAllServices ¶
func RemoveAllServices() error
RemoveAllServices removes all services that are currently in the database.
func Scan ¶
Scan starts scanning. Duplicated advertisements will be filtered out if allowDup is set to false.
func SetDefaultDevice ¶
func SetDefaultDevice(d Device)
SetDefaultDevice returns the default HCI device.
func SetServices ¶
SetServices set the specified service to the database. It removes all currently added services, if any.
Types ¶
type ATTError ¶
type ATTError byte
ATTError is the error code of Attribute Protocol [Vol 3, Part F, 3.4.1.1].
const ( ErrSuccess ATTError = 0x00 // ErrSuccess measn the operation is success. ErrInvalidHandle ATTError = 0x01 // ErrInvalidHandle means the attribute handle given was not valid on this server. ErrReadNotPerm ATTError = 0x02 // ErrReadNotPerm eans the attribute cannot be read. ErrWriteNotPerm ATTError = 0x03 // ErrWriteNotPerm eans the attribute cannot be written. ErrInvalidPDU ATTError = 0x04 // ErrInvalidPDU means the attribute PDU was invalid. ErrAuthentication ATTError = 0x05 // ErrAuthentication means the attribute requires authentication before it can be read or written. ErrReqNotSupp ATTError = 0x06 // ErrReqNotSupp means the attribute server does not support the request received from the client. ErrInvalidOffset ATTError = 0x07 // ErrInvalidOffset means the specified was past the end of the attribute. ErrAuthorization ATTError = 0x08 // ErrAuthorization means the attribute requires authorization before it can be read or written. ErrPrepQueueFull ATTError = 0x09 // ErrPrepQueueFull means too many prepare writes have been queued. ErrAttrNotFound ATTError = 0x0a // ErrAttrNotFound means no attribute found within the given attribute handle range. ErrAttrNotLong ATTError = 0x0b // ErrAttrNotLong means the attribute cannot be read or written using the Read Blob Request. ErrInsuffEncrKeySize ATTError = 0x0c // ErrInsuffEncrKeySize means the Encryption Key Size used for encrypting this link is insufficient. ErrInvalAttrValueLen ATTError = 0x0d // ErrInvalAttrValueLen means the attribute value length is invalid for the operation. ErrUnlikely ATTError = 0x0e // ErrUnlikely means the attribute request that was requested has encountered an error that was unlikely, and therefore could not be completed as requested. ErrInsuffEnc ATTError = 0x0f // ErrInsuffEnc means the attribute requires encryption before it can be read or written. ErrUnsuppGrpType ATTError = 0x10 // ErrUnsuppGrpType means the attribute type is not a supported grouping attribute as defined by a higher layer specification. ErrInsuffResources ATTError = 0x11 // ErrInsuffResources means insufficient resources to complete the request. )
ATTError is the error code of Attribute Protocol [Vol 3, Part F, 3.4.1.1].
type Addr ¶
type Addr interface {
String() string
}
Addr represents a network end point address. It's MAC address on Linux or Device UUID on OS X.
type AdvFilter ¶
type AdvFilter func(a Advertisement) bool
AdvFilter returns true if the advertisement matches specified condition.
type Advertisement ¶
type Advertisement interface { LocalName() string ManufacturerData() []byte ServiceData() []ServiceData Services() []UUID OverflowService() []UUID TxPowerLevel() int Connectable() bool SolicitedService() []UUID RSSI() int Addr() Addr }
Advertisement ...
type Characteristic ¶
type Characteristic struct { UUID UUID Property Property Secure Property // FIXME Descriptors []*Descriptor CCCD *Descriptor Value []byte ReadHandler ReadHandler WriteHandler WriteHandler NotifyHandler NotifyHandler IndicateHandler NotifyHandler Handle uint16 ValueHandle uint16 EndHandle uint16 }
A Characteristic is a BLE characteristic.
func NewCharacteristic ¶
func NewCharacteristic(u UUID) *Characteristic
NewCharacteristic creates and returns a Characteristic.
func (*Characteristic) AddDescriptor ¶
func (c *Characteristic) AddDescriptor(d *Descriptor) *Descriptor
AddDescriptor adds a descriptor to a characteristic. AddDescriptor panics if the characteristic already contains another descriptor with the same UUID.
func (*Characteristic) HandleIndicate ¶
func (c *Characteristic) HandleIndicate(h NotifyHandler)
HandleIndicate makes the characteristic support indicate requests, and routes notification requests to h. HandleIndicate must be called before the containing service is added to a server.
func (*Characteristic) HandleNotify ¶
func (c *Characteristic) HandleNotify(h NotifyHandler)
HandleNotify makes the characteristic support notify requests, and routes notification requests to h. HandleNotify must be called before the containing service is added to a server.
func (*Characteristic) HandleRead ¶
func (c *Characteristic) HandleRead(h ReadHandler)
HandleRead makes the characteristic support read requests, and routes read requests to h. HandleRead must be called before the containing service is added to a server. HandleRead panics if the characteristic has been configured with a static value.
func (*Characteristic) HandleWrite ¶
func (c *Characteristic) HandleWrite(h WriteHandler)
HandleWrite makes the characteristic support write and write-no-response requests, and routes write requests to h. The WriteHandler does not differentiate between write and write-no-response requests; it is handled automatically. HandleWrite must be called before the containing service is added to a server.
func (*Characteristic) NewDescriptor ¶
func (c *Characteristic) NewDescriptor(u UUID) *Descriptor
NewDescriptor adds a descriptor to a characteristic. NewDescriptor panics if the characteristic already contains another descriptor with the same UUID.
func (*Characteristic) SetValue ¶
func (c *Characteristic) SetValue(b []byte)
SetValue makes the characteristic support read requests, and returns a static value. SetValue must be called before the containing service is added to a server. SetValue panics if the characteristic has been configured with a ReadHandler.
type Client ¶
type Client interface { // Addr returns platform specific unique ID of the remote peripheral, e.g. MAC on Linux, Client UUID on OS X. Addr() Addr // Name returns the name of the remote peripheral. // This can be the advertised name, if exists, or the GAP device name, which takes priority. Name() string // Profile returns discovered profile. Profile() *Profile // DiscoverProfile discovers the whole hierarchy of a server. DiscoverProfile(force bool) (*Profile, error) // DiscoverServices finds all the primary services on a server. [Vol 3, Part G, 4.4.1] // If filter is specified, only filtered services are returned. DiscoverServices(filter []UUID) ([]*Service, error) // DiscoverIncludedServices finds the included services of a service. [Vol 3, Part G, 4.5.1] // If filter is specified, only filtered services are returned. DiscoverIncludedServices(filter []UUID, s *Service) ([]*Service, error) // DiscoverCharacteristics finds all the characteristics within a service. [Vol 3, Part G, 4.6.1] // If filter is specified, only filtered characteristics are returned. DiscoverCharacteristics(filter []UUID, s *Service) ([]*Characteristic, error) // DiscoverDescriptors finds all the descriptors within a characteristic. [Vol 3, Part G, 4.7.1] // If filter is specified, only filtered descriptors are returned. DiscoverDescriptors(filter []UUID, c *Characteristic) ([]*Descriptor, error) // ReadCharacteristic reads a characteristic value from a server. [Vol 3, Part G, 4.8.1] ReadCharacteristic(c *Characteristic) ([]byte, error) // ReadLongCharacteristic reads a characteristic value which is longer than the MTU. [Vol 3, Part G, 4.8.3] ReadLongCharacteristic(c *Characteristic) ([]byte, error) // WriteCharacteristic writes a characteristic value to a server. [Vol 3, Part G, 4.9.3] WriteCharacteristic(c *Characteristic, value []byte, noRsp bool) error // ReadDescriptor reads a characteristic descriptor from a server. [Vol 3, Part G, 4.12.1] ReadDescriptor(d *Descriptor) ([]byte, error) // WriteDescriptor writes a characteristic descriptor to a server. [Vol 3, Part G, 4.12.3] WriteDescriptor(d *Descriptor, v []byte) error // ReadRSSI retrieves the current RSSI value of remote peripheral. [Vol 2, Part E, 7.5.4] ReadRSSI() int // ExchangeMTU set the ATT_MTU to the maximum possible value that can be supported by both devices [Vol 3, Part G, 4.3.1] ExchangeMTU(rxMTU int) (txMTU int, err error) // Subscribe subscribes to indication (if ind is set true), or notification of a characteristic value. [Vol 3, Part G, 4.10 & 4.11] Subscribe(c *Characteristic, ind bool, h NotificationHandler) error // Unsubscribe unsubscribes to indication (if ind is set true), or notification of a specified characteristic value. [Vol 3, Part G, 4.10 & 4.11] Unsubscribe(c *Characteristic, ind bool) error // ClearSubscriptions clears all subscriptions to notifications and indications. ClearSubscriptions() error // CancelConnection disconnects the connection. CancelConnection() error // Disconnected returns a receiving channel, which is closed when the client disconnects. Disconnected() <-chan struct{} }
A Client is a GATT client.
type Conn ¶
type Conn interface { io.ReadWriteCloser // Context returns the context that is used by this Conn. Context() context.Context // SetContext sets the context that is used by this Conn. SetContext(ctx context.Context) // LocalAddr returns local device's address. LocalAddr() Addr // RemoteAddr returns remote device's address. RemoteAddr() Addr // RxMTU returns the ATT_MTU which the local device is capable of accepting. RxMTU() int // SetRxMTU sets the ATT_MTU which the local device is capable of accepting. SetRxMTU(mtu int) // TxMTU returns the ATT_MTU which the remote device is capable of accepting. TxMTU() int // SetTxMTU sets the ATT_MTU which the remote device is capable of accepting. SetTxMTU(mtu int) // Disconnected returns a receiving channel, which is closed when the connection disconnects. Disconnected() <-chan struct{} }
Conn implements a L2CAP connection.
type Descriptor ¶
type Descriptor struct { UUID UUID Property Property Handle uint16 Value []byte ReadHandler ReadHandler WriteHandler WriteHandler }
Descriptor is a BLE descriptor
func NewDescriptor ¶
func NewDescriptor(u UUID) *Descriptor
NewDescriptor creates and returns a Descriptor.
func (*Descriptor) HandleRead ¶
func (d *Descriptor) HandleRead(h ReadHandler)
HandleRead makes the descriptor support read requests, and routes read requests to h. HandleRead must be called before the containing service is added to a server. HandleRead panics if the descriptor has been configured with a static value.
func (*Descriptor) HandleWrite ¶
func (d *Descriptor) HandleWrite(h WriteHandler)
HandleWrite makes the descriptor support write and write-no-response requests, and routes write requests to h. The WriteHandler does not differentiate between write and write-no-response requests; it is handled automatically. HandleWrite must be called before the containing service is added to a server.
func (*Descriptor) SetValue ¶
func (d *Descriptor) SetValue(b []byte)
SetValue makes the descriptor support read requests, and returns a static value. SetValue must be called before the containing service is added to a server. SetValue panics if the descriptor has already configured with a ReadHandler.
type Device ¶
type Device interface { // AddService adds a service to database. AddService(svc *Service) error // RemoveAllServices removes all services that are currently in the database. RemoveAllServices() error // SetServices set the specified service to the database. // It removes all currently added services, if any. SetServices(svcs []*Service) error // Stop detatch the GATT server from a peripheral device. Stop() error // Advertise advertises a given Advertisement Advertise(ctx context.Context, adv Advertisement) error // AdvertiseNameAndServices advertises device name, and specified service UUIDs. // It tres to fit the UUIDs in the advertising packet as much as possi // If name doesn't fit in the advertising packet, it will be put in scan response. AdvertiseNameAndServices(ctx context.Context, name string, uuids ...UUID) error // AdvertiseMfgData avertises the given manufacturer data. AdvertiseMfgData(ctx context.Context, id uint16, b []byte) error // AdvertiseServiceData16 advertises data associated with a 16bit service uuid AdvertiseServiceData16(ctx context.Context, id uint16, b []byte) error // AdvertiseIBeaconData advertise iBeacon with given manufacturer data. AdvertiseIBeaconData(ctx context.Context, b []byte) error // AdvertiseIBeacon advertises iBeacon with specified parameters. AdvertiseIBeacon(ctx context.Context, u UUID, major, minor uint16, pwr int8) error // Scan starts scanning. Duplicated advertisements will be filtered out if allowDup is set to false. Scan(ctx context.Context, allowDup bool, h AdvHandler) error // Dial ... Dial(ctx context.Context, a Addr) (Client, error) }
Device ...
type NotificationHandler ¶
type NotificationHandler func(req []byte)
A NotificationHandler handles notification or indication from a server.
type Notifier ¶
type Notifier interface { // Context sends data to the central. Context() context.Context // Write sends data to the central. Write(b []byte) (int, error) // Close ... Close() error // Cap returns the maximum number of bytes that may be sent in a single notification. Cap() int }
Notifier ...
type NotifyHandler ¶
A NotifyHandler handles GATT requests.
type NotifyHandlerFunc ¶
NotifyHandlerFunc is an adapter to allow the use of ordinary functions as Handlers.
func (NotifyHandlerFunc) ServeNotify ¶
func (f NotifyHandlerFunc) ServeNotify(req Request, n Notifier)
ServeNotify returns f(r, maxlen, offset).
type Profile ¶
type Profile struct {
Services []*Service
}
A Profile is composed of one or more services necessary to fulfill a use case.
type Property ¶
type Property int
Property ...
const ( CharBroadcast Property = 0x01 // may be brocasted CharRead Property = 0x02 // may be read CharWriteNR Property = 0x04 // may be written to, with no reply CharWrite Property = 0x08 // may be written to, with a reply CharNotify Property = 0x10 // supports notifications CharIndicate Property = 0x20 // supports Indications CharSignedWrite Property = 0x40 // supports signed write CharExtended Property = 0x80 // supports extended properties )
Characteristic property flags (spec 3.3.3.1)
type ReadHandler ¶
type ReadHandler interface {
ServeRead(req Request, rsp ResponseWriter)
}
A ReadHandler handles GATT requests.
type ReadHandlerFunc ¶
type ReadHandlerFunc func(req Request, rsp ResponseWriter)
ReadHandlerFunc is an adapter to allow the use of ordinary functions as Handlers.
func (ReadHandlerFunc) ServeRead ¶
func (f ReadHandlerFunc) ServeRead(req Request, rsp ResponseWriter)
ServeRead returns f(r, maxlen, offset).
type ResponseWriter ¶
type ResponseWriter interface { // Write writes data to return as the characteristic value. Write(b []byte) (int, error) // Status reports the result of the request. Status() ATTError // SetStatus reports the result of the request. SetStatus(status ATTError) // Len ... Len() int // Cap ... Cap() int }
ResponseWriter ...
func NewResponseWriter ¶
func NewResponseWriter(buf *bytes.Buffer) ResponseWriter
NewResponseWriter ...
type Service ¶
type Service struct { UUID UUID Characteristics []*Characteristic Handle uint16 EndHandle uint16 }
A Service is a BLE service.
func NewService ¶
NewService creates and initialize a new Service using u as it's UUID.
func (*Service) AddCharacteristic ¶
func (s *Service) AddCharacteristic(c *Characteristic) *Characteristic
AddCharacteristic adds a characteristic to a service. AddCharacteristic panics if the service already contains another characteristic with the same UUID.
func (*Service) NewCharacteristic ¶
func (s *Service) NewCharacteristic(u UUID) *Characteristic
NewCharacteristic adds a characteristic to a service. NewCharacteristic panics if the service already contains another characteristic with the same UUID.
type UUID ¶
type UUID []byte
A UUID is a BLE UUID.
func MustParse ¶
MustParse parses a standard-format UUID string, like Parse, but panics in case of error.
func Parse ¶
Parse parses a standard-format UUID string, such as "1800" or "34DA3AD1-7110-41A1-B1EF-4430F509CDE7".
type WriteHandler ¶
type WriteHandler interface {
ServeWrite(req Request, rsp ResponseWriter)
}
A WriteHandler handles GATT requests.
type WriteHandlerFunc ¶
type WriteHandlerFunc func(req Request, rsp ResponseWriter)
WriteHandlerFunc is an adapter to allow the use of ordinary functions as Handlers.
func (WriteHandlerFunc) ServeWrite ¶
func (f WriteHandlerFunc) ServeWrite(req Request, rsp ResponseWriter)
ServeWrite returns f(r, maxlen, offset).