Dokumentacja pliku BLE.c

Kod obsługujący połączenia Bluetooth. Więcej...

#include "BLE.h"

Funkcje
static void	connected (struct bt_conn *conn, uint8_t err)
	Funkcja callback wywoływana w momencie nawiązania połączenia. Wypisuje komunikaty informacyjne z parametrami połączenia bądź komunikat błędu w przypadku problemów.
static void	disconnected (struct bt_conn *conn, uint8_t reason)
	Funkcja callback wywoływana w momencie utraty połączenia. Wypisuje komunikat informacyjny z kodem przyczyny utraty połączenia.
static bool	le_param_requested (struct bt_conn *conn, struct bt_le_conn_param *param)
	Funkja callback wywoływana w momencie żądania zmiany parametrów połączenia. Polegliwie zwraca się się na wszystkie zmiany.
static void	le_param_updated (struct bt_conn *conn, uint16_t interval, uint16_t latency, uint16_t timeout)
	Funkcja callback wywoływana po zmianie parametrów połączenia. Wypisuje komunikaty informacyjne z nowyni parametrami.
static void	security_changed (struct bt_conn *conn, bt_security_t lev, enum bt_security_err err)
	Funkcja callback wywoływana przy zmianie (bądź próbie zmiany) poziomu bezpieczeństwa połączenia. Wypisuje komunikat informacyjny z nowym poziomem połączenia, bądź kodem błędu w przypadku niepowodzenia zmiany.
static void	cancel_auth (struct bt_conn *conn)
	Funkcja callback wywoływana w momencie anulowania żądania powiązania przez drugą stronę połączenia. Wypisuje komunikat informacyjny i ustawia w zmiennej to_cancel wskaźnik do połączenia w którym żądanie zostało anulowane, aby nie podjąć działania w funkcji passkey_confirm(), która czekaja na reakcję użytkownika.
static void	passkey_confirm (struct bt_conn *conn, unsigned int pass)
	Funkcja callback wywoływana w momencie otrzymania żądania parowania. Wypisuje na konsole szeregową kod bezpieczeństwa i czeka na potwierdzenie przez użytkownika potwierdzenia poprawności wyświetlanego kodu.
int	init_ble_communication ()
	Funkcja inicjalizująca sprzęt bluetooth. Jest wywoływana z funkcji main i musi zostać wywołana przed jakąkolwiek interakcją z sprzętem bluetooth.

Zmienne
struct bt_conn *	my_conn
bool	is_bt_connected = false
struct bt_conn *	to_cancel = NULL
uint8_t	data_rx [MAX_TRANSMIT_SIZE]
uint8_t	data_tx [MAX_TRANSMIT_SIZE]
static struct bt_conn_cb	conn_callbacks
static struct bt_conn_auth_cb	auth_cb

Opis szczegółowy

Autor

Maciej Jędrasik (Maciej.Jedrasik.STUD@pw.edu.pl)

Wersja

1.0

Data

2024-05-29

Dokumentacja funkcji

cancel_auth()

static void cancel_auth ( struct bt_conn * conn )

static

Parametry

conn	Struktura opisująca połączenie, w ktrórym żądanie powiązania zostało anulowane.

connected()

static void connected ( struct bt_conn * conn, uint8_t err )

static

Parametry

conn	Struktura opisująca połączenie.
err	Kod błędu który wystąpił lub 0 w przypadku powodzenia.

disconnected()

static void disconnected ( struct bt_conn * conn, uint8_t reason )

static

Parametry

conn	Struktura opisująca połączenie, które zostało utracone
reason	Kod przyczyny utraty połączenia.

init_ble_communication()

int init_ble_communication

(

)

Zwraca

0 w przypadku powodzenia

err_code w przeciwnym przypadku

le_param_requested()

static bool le_param_requested ( struct bt_conn * conn, struct bt_le_conn_param * param )

static

Parametry

conn	Struktura opisująca połączenie, którego dotyczy żądanie zmiany parametrów.
param	Struktura opisująca żądane parametry.

Zwraca

true Zgoda na zmianę parametrów.

false Odmowa zmiany parametrów.

le_param_updated()

static void le_param_updated ( struct bt_conn * conn, uint16_t interval, uint16_t latency, uint16_t timeout )

static

Parametry

conn	Struktura opisująca połączenie, którego parametry uległy zmianie.
interval	Nowy interwał połączenia.
latency	Nowa wartość opóźnienia.
timeout	Nowy limit czasu połączenia.

passkey_confirm()

static void passkey_confirm ( struct bt_conn * conn, unsigned int pass )

static

Parametry

conn	Struktura opisująca połączenie w którym nastąpiło żądanie parowania.
pass	Klucz bezpieczeństwa do porównania z kluczem wyświetlanym na drugin urządzeniu.

security_changed()

static void security_changed ( struct bt_conn * conn, bt_security_t lev, enum bt_security_err err )

static

Parametry

conn	Struktura opisująca połączenie którego dotyczy zmiana.
lev	Nowy poziom bezpieczeństwa połączenia
err	Kod błędu jeżeli jakiś wystąpił lub 0 w przeciwnym przypadku.

Dokumentacja zmiennych

auth_cb

struct bt_conn_auth_cb auth_cb

static

Wartość początkowa:

= 
{
    .cancel = cancel_auth,
    .pairing_confirm = NULL,
    .passkey_confirm = passkey_confirm,
    .passkey_display = NULL,
}

Struktura z funkcjami callback obsługującymi proces parowania.

conn_callbacks

struct bt_conn_cb conn_callbacks

static

Wartość początkowa:

= 
{
    .connected = connected,
    .disconnected = disconnected,
    .le_param_req = le_param_requested,
    .le_param_updated = le_param_updated
}

Struktura z funkcjami callback wywoływanymi w przypadku zmian stanów połączenia.

data_rx

uint8_t data_rx[MAX_TRANSMIT_SIZE]

Bufor wejściowy

data_tx

uint8_t data_tx[MAX_TRANSMIT_SIZE]

Bufor wyjściowy

is_bt_connected

bool is_bt_connected = false

Zmienna przechowująca stan połączenia

my_conn

struct bt_conn* my_conn

Struktura przechowująca dane o bieżącym połączeniu

to_cancel

struct bt_conn* to_cancel = NULL

Zmienna przechowująca połączenie w którym żądanie parowania zostało anulowane przez drugą stronę.