Module nrf5x::ble_advertising_driver [−] [src]

Bluetooth Low Energy Advertising Driver

A system call driver that exposes the Bluetooth Low Energy advertising channel. The driver generates a unique static address for each process, allowing each process to act as its own device and send or scan for advertisements. Timing of advertising or scanning events is handled by the driver but processes can request an advertising or scanning interval. Processes can also control the TX power used for their advertisements.

Data payloads are limited to 31 bytes since the maximum advertising channel protocol data unit (PDU) is 37 bytes and includes a 6-byte header.

Allow system call

The allow systems calls are used for buffers from allocated by userland

There are three different buffers:

The following allow numbers are supported:

The possible return codes from the 'allow' system call indicate the following:

Subscribe system call

The 'subscribe' system call supports two arguments `subscribe_num' and 'callback'. 'subscribe' is used to specify the specific operation, currently:

The possible return codes from the 'allow' system call indicate the following:

Command system call

The command system call supports two arguments cmd and 'sub_cmd'. 'cmd' is used to specify the specific operation, currently the following cmd's are supported:

The possible return codes from the 'command' system call indicate the following:

Usage

Advertisement:

          +-------------------------------+
          | Initilize Advertisement Buffer|
          +-------------------------------+
                         |
          +-------------------------------+
          | Request BLE Address           |
          +-------------------------------+
                         |
          +-------------------------------+
          | Configure  ADV_TYPE           |
          +-------------------------------+
                         |
          +-------------------------------+
          | Start Advertising             |
          +-------------------------------+
                         |
          +-------------------------------+
          | Configure Alarm               |------------|
          +-------------------------------+            |
                         |                             |
          +-------------------------------+            |
          | Send Packet                   |------------|
          +-------------------------------+

Client
          +-------------------------------+
          | Packet Sent or Error          |------------|
          +-------------------------------+            |
                        |                              |
          +-------------------------------+            |
          | Notify BLE Driver             |------------|
          +-------------------------------+

Passive Scanning:

          +-----------------------+
          | Configure Callback    |
          +-----------------------+
                     |
          +-----------------------+
          | Initilize Scan Buffer |
          +-----------------------+
                     |
          +-----------------------+
          | Start Passive Scanning|
          +-----------------------+
                     |
          +-----------------------+
          | Configure Alarm       |--------------|
          +-----------------------+              |
                     |                           |
          +-----------------------+              |
          | Receive Packet        |--------------|
          +-----------------------+

Client
          +-------------------------------+
          | Packet Received or Error      |------------|
          +-------------------------------+            |
                        |                              |
          +-------------------------------+            |
          | Notify BLE Driver             |------------|
          +-------------------------------+

You need a device that provides the nrf5x::ble_advertising_hil::BleAdvertisementDriver trait along with a virtual timer to perform events and not block the entire kernel

let ble_radio = static_init!(
    nrf5x::ble_advertising_driver::BLE
    <'static, nrf52::radio::Radio, VirtualMuxAlarm<'static, Rtc>>,
    nrf5x::ble_advertising_driver::BLE::new(
        &mut nrf52::radio::RADIO,
    kernel::Grant::create(),
        &mut nrf5x::ble_advertising_driver::BUF,
        ble_radio_virtual_alarm));
   nrf5x::ble_advertising_hil::BleAdvertisementDriver::set_rx_client(&nrf52::radio::RADIO,
                                                                     ble_radio);
   nrf5x::ble_advertising_hil::BleAdvertisementDriver::set_tx_client(&nrf52::radio::RADIO,
                                                                     ble_radio);
   ble_radio_virtual_alarm.set_client(ble_radio);

Authors

Reexports

use ble_advertising_hil;
use ble_advertising_hil::RadioChannel;
use core::cell::Cell;
use core::cmp;
use kernel;
use kernel::hil::time::Frequency;
use kernel::returncode::ReturnCode;

Structs

AlarmData
App
BLE
BLEGap

Enums

AllowType
BLEAdvertisementType
BLEGapType
BLEState
Expiration

Constants

DRIVER_NUM

Syscall Number
PACKET_ADDR_END
PACKET_ADDR_START
PACKET_HDR_LEN
PACKET_HDR_PDU
PACKET_LENGTH
PACKET_PAYLOAD_START
PACKET_START

Statics

BUF