harald v0.2.0 API Reference
Modules
An Elixir Bluetooth Host library.
Company identifiers are unique numbers assigned by the Bluetooth SIG to member companies requesting one.
Assigned numbers are used in GAP for inquiry response, EIR data type values, manufacturer-specific data, advertising data, low energy UUIDs and appearance characteristics, and class of device.
Reference: Core Specification Supplement, Part A
The Manufacturer Specific data type is used for manufacturer specific data.
Serialization module for Apple.
The Service Data data type consists of a service UUID with the data associated with that service.
Defines all error codes and functions to map between error code and name.
The HCI provides a uniform interface method of accessing a Bluetooth Controller’s capabilities.
Serialization functions for arrayed data.
HCI commands for working with the controller and baseband.
Serialization module for HCI Events.
The Inquiry Complete event indicates that the Inquiry is finished. This event contains a Status parameter, which is used to indicate if the Inquiry completed successfully or if the Inquiry was not completed.
The LE Meta Event is used to encapsulate all LE Controller specific events.
A struct representing a LE Advertising Report.
A struct representing a single device within a LE Advertising Report.
The LE Controller Commands provide access and control to various capabilities of the Bluetooth hardware, as well as methods for the Host to affect how the Link Layer manages the piconet, and controls connections.
There are four kinds of HCI packets that can be sent via the UART Transport Layer; i.e. HCI Command Packet, HCI Event Packet, HCI ACL Data Packet and HCI Synchronous Data Packet.
A collection of high level functions for working with BLE (Bluetooth Low Energy) functionality.
Defines a behaviour that manufacturer data modules should implement.
Serializable behaviour.
A server to manage lower level transports and parse bluetooth events.
A behaviour for transport adapters.
A behaviour for transport handlers.
The objective of this HCI UART Transport Layer is to make it possible to use the Bluetooth HCI over a serial interface between two UARTs on the same PCB. The HCI UART Transport Layer assumes that the UART communication is free from line errors.
A framer module that defines a frame as a HCI packet.