Expand description
§bt-hci
Rust types for the Bluetooth HCI (Host Controller Interface) specification, and traits for implementing the Controller part of the interface.
See Trouble for an example of using this crate.
§Bluetooth UUIDs
The bluetooth specification includes reference information for pre-defined UUIDs that can be used to communicate specific services, characteristics, properties, etc of a device. These are also made available as constants from this crate through the uuid module for users of this crate.
For crate maintainers, to update these constants run the update_uuids binary, which will redownload the bluetooth-sig yaml spec and rebuild the uuids module based on the latest version.
§License
bt-hci is licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
§Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Re-exports§
pub use btuuid as uuid;
Modules§
- cmd
- HCI commands 📖
- controller
- HCI controller
- data
- HCI data packets 📖
- event
- HCI events 📖
- param
- Parameter types for HCI command and event packets 📖
- transport
- HCI transport layers 📖
Enums§
- Controller
ToHost Packet - Type representing valid deserialized HCI packets.
- From
HciBytes Error - Errors from parsing HCI data.
- Packet
Kind - Enum of valid HCI packet types.
- Read
HciError - Errors from reading HCI data.
Traits§
- AsHci
Bytes - A HCI type which can be represented as bytes.
- Byte
Aligned Value - Marker trait for
FixedSizeValues that have byte alignment. - Fixed
Size Value - Marker trait for HCI values that have a known, fixed size
- From
HciBytes - A fixed size HCI type that can be deserialized from bytes.
- Host
ToController Packet - Trait representing a HCI packet.
- ReadHci
- Adapter trait for deserializing HCI types from embedded-io implementations.
- Write
Hci - Adapter trait for serializing HCI types to embedded-io implementations.