Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Hôte BLE

Ce module inclut l'abstraction de plate-forme pour la communication de l'hôte BLE.

Résumé

La plate-forme doit implémenter Bluetooth LE 4.2 ou supérieur.

Énumérations

anonymous enum {
OT_BLE_ADDRESS_LENGTH = 6,
OT_BLE_TIMESLOT_UNIT = 625,
OT_BLE_CONN_INTERVAL_UNIT = 2 * OT_BLE_TIMESLOT_UNIT,
OT_BLE_CONN_INTERVAL_MIN = 0x0006,
OT_BLE_CONN_INTERVAL_MAX = 0x0C80,
OT_BLE_CONN_SLAVE_LATENCY_MAX = 0x01F3,
OT_BLE_CONN_SUPERVISOR_TIMEOUT_MIN = 0x000A,
OT_BLE_CONN_SUPERVISOR_TIMEOUT_MAX = 0x0C80,
OT_BLE_CONN_SUPERVISOR_UNIT = 16 * OT_BLE_TIMESLOT_UNIT,
OT_BLE_DEV_NAME_MAX_LENGTH = 248,
OT_BLE_ADV_DATA_MAX_LENGTH = 31,
OT_BLE_SCAN_RESPONSE_MAX_LENGTH = 31,
OT_BLE_ADV_INTERVAL_MIN = 0x0020,
OT_BLE_ADV_INTERVAL_MAX = 0x4000,
OT_BLE_ADV_INTERVAL_UNIT = OT_BLE_TIMESLOT_UNIT,
OT_BLE_SCAN_INTERVAL_MIN = 0x0004,
OT_BLE_SCAN_INTERVAL_MAX = 0x4000,
OT_BLE_SCAN_INTERVAL_UNIT = OT_BLE_TIMESLOT_UNIT,
OT_BLE_SCAN_WINDOW_MIN = 0x0004,
OT_BLE_SCAN_WINDOW_MAX = 0x4000,
OT_BLE_SCAN_WINDOW_UNIT = OT_BLE_TIMESLOT_UNIT,
OT_BLE_HCI_REMOTE_USER_TERMINATED = 0x13,
OT_BLE_INVALID_HANDLE = 0x0000,
OT_BLE_CHARACTERISTIC_MAX_LENGTH = 512,
OT_BLE_ATT_MTU_MAX = 511,
OT_BLE_UUID_LENGTH = 16,
OT_BLE_UUID_CCCD = 0x2902
}
énumération
otPlatBleAddressType {
OT_BLE_ADDRESS_TYPE_PUBLIC = 0,
OT_BLE_ADDRESS_TYPE_RANDOM_STATIC = 1,
OT_BLE_ADDRESS_TYPE_RANDOM_PRIVATE_RESOLVABLE = 2,
OT_BLE_ADDRESS_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE = 3
}
énumération
Cette énumération représente les types d'adresses de périphérique BLE.
otPlatBleAdvMode {
OT_BLE_ADV_MODE_CONNECTABLE = (1 << 0),
OT_BLE_ADV_MODE_SCANNABLE = (1 << 1)
}
énumération
Cette énumération définit des indicateurs pour le mode d'annonce BLE.
otPlatBleCccdFlags {
OT_BLE_CHAR_PROP_BROADCAST = (1 << 0),
OT_BLE_CHAR_PROP_READ = (1 << 1),
OT_BLE_CHAR_PROP_WRITE_NO_RESPONSE = (1 << 2),
OT_BLE_CHAR_PROP_WRITE = (1 << 3),
OT_BLE_CHAR_PROP_NOTIFY = (1 << 4),
OT_BLE_CHAR_PROP_INDICATE = (1 << 5),
OT_BLE_CHAR_PROP_AUTH_SIGNED_WRITE = (1 << 6),
OT_BLE_CHAR_PROP_EXTENDED = (1 << 7)
}
énumération
Cette énumération définit les indicateurs de propriétés characterstic pour un descripteur de configuration de caractéristique client (CCCD).
otPlatBleL2capError {
OT_BLE_L2C_ERROR_NONE = 0x00,
OT_BLE_L2C_ERROR_INVALID_PSM = 0x02,
OT_BLE_L2C_ERROR_NO_MEM = 0x04,
OT_BLE_L2C_ERROR_INVALID_PARAMS = 0x0b
}
énumération
L'énumération indique le résultat de la procédure de demande de connexion L2CAP.
otPlatBleUuidType {
OT_BLE_UUID_TYPE_NONE = 0,
OT_BLE_UUID_TYPE_16 = 1,
OT_BLE_UUID_TYPE_32 = 2,
OT_BLE_UUID_TYPE_128 = 3
}
énumération
Cette énumération représente la valeur UUID BLE.

Typedefs

otBleRadioPacket typedef
Cette structure représente un paquet BLE.
otPlatBleAddressType typedef
Cette énumération représente les types d'adresses de périphérique BLE.
otPlatBleAdvMode typedef
Cette énumération définit des indicateurs pour le mode d'annonce BLE.
otPlatBleCccdFlags typedef
Cette énumération définit les indicateurs de propriétés characterstic pour un descripteur de configuration de caractéristique client (CCCD).
otPlatBleDeviceAddr typedef
Cette structure représente l'adresse du périphérique BLE.
otPlatBleGapConnParams typedef
Cette structure représente les paramètres de connexion BLE.
otPlatBleGattCharacteristic typedef
Cette structure représente la caractéristique du GATT.
otPlatBleGattDescriptor typedef
Cette structure représente le descripteur GATT.
otPlatBleGattService typedef
Descripteur d'enregistrement pour un service du GATT.
otPlatBleL2capError typedef
L'énumération indique le résultat de la procédure de demande de connexion L2CAP.
otPlatBleUuid typedef
struct otPlatBleUuid
Cette structure représente BLE UUID.
otPlatBleUuidType typedef
Cette énumération représente la valeur UUID BLE.
otPlatBleUuidValue typedef
Cette structure représente la valeur UUID BLE.

Les fonctions

otPlatBleDisable ( otInstance *aInstance)
Désactivez la radio Bluetooth Low Energy.
otPlatBleEnable ( otInstance *aInstance)
Activez la radio Bluetooth Low Energy.
otPlatBleGapAddressGet ( otInstance *aInstance, otPlatBleDeviceAddr *aAddress)
Obtient l'adresse du périphérique Bluetooth.
otPlatBleGapAddressSet ( otInstance *aInstance, const otPlatBleDeviceAddr *aAddress)
Définit l'adresse du périphérique Bluetooth.
otPlatBleGapAdvDataSet ( otInstance *aInstance, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Définit le contenu du paquet de publicité BLE.
otPlatBleGapAdvStart ( otInstance *aInstance, uint16_t aInterval, uint8_t aType)
Démarre la procédure de publicité BLE.
otPlatBleGapAdvStop ( otInstance *aInstance)
Arrête la procédure de publicité BLE.
otPlatBleGapConnParamsSet ( otInstance *aInstance, const otPlatBleGapConnParams *aConnParams)
Définit les paramètres de connexion BLE souhaités.
otPlatBleGapConnect ( otInstance *aInstance, otPlatBleDeviceAddr *aAddress, uint16_t aInterval, uint16_t aWindow)
Démarre la procédure de connexion BLE.
otPlatBleGapDisconnect ( otInstance *aInstance)
Déconnecte la connexion BLE.
otPlatBleGapOnAdvReceived ( otInstance *aInstance, otPlatBleDeviceAddr *aAddress, otBleRadioPacket *aPacket)
void
Le pilote BLE appelle cette méthode pour notifier OpenThread qu'un paquet de publicité a été reçu.
otPlatBleGapOnConnected ( otInstance *aInstance, uint16_t aConnectionId)
void
Le pilote BLE appelle cette méthode pour informer OpenThread que le périphérique BLE a été connecté.
otPlatBleGapOnDisconnected ( otInstance *aInstance, uint16_t aConnectionId)
void
Le pilote BLE appelle cette méthode pour notifier OpenThread que le périphérique BLE a été déconnecté.
otPlatBleGapOnScanRespReceived ( otInstance *aInstance, otPlatBleDeviceAddr *aAddress, otBleRadioPacket *aPacket)
void
Le pilote BLE appelle cette méthode pour avertir OpenThread qu'un paquet de réponse d'analyse a été reçu.
otPlatBleGapScanResponseSet ( otInstance *aInstance, const uint8_t *aScanResponse, uint8_t aScanResponseLength)
Définit le contenu du paquet de réponse d'analyse BLE.
otPlatBleGapScanStart ( otInstance *aInstance, uint16_t aInterval, uint16_t aWindow)
Démarre la procédure d'analyse BLE.
otPlatBleGapScanStop ( otInstance *aInstance)
Arrête la procédure d'analyse BLE.
otPlatBleGapServiceSet ( otInstance *aInstance, const char *aDeviceName, uint16_t aAppearance)
Définit le nom et l'apparence du périphérique BLE visibles en tant que service GATT.
otPlatBleGattClientCharacteristicsDiscover ( otInstance *aInstance, uint16_t aStartHandle, uint16_t aEndHandle)
Effectue la découverte des caractéristiques GATT d'un service.
otPlatBleGattClientDescriptorsDiscover ( otInstance *aInstance, uint16_t aStartHandle, uint16_t aEndHandle)
Effectue la découverte des descripteurs GATT.
otPlatBleGattClientMtuExchangeRequest ( otInstance *aInstance, uint16_t aMtu)
Envoie une demande d'échange MTU.
otPlatBleGattClientOnCharacteristicsDiscoverDone ( otInstance *aInstance, otPlatBleGattCharacteristic *aChars, uint16_t aCount, otError aError)
void
Le pilote BLE appelle cette méthode pour informer OpenThread que la découverte des caractéristiques GATT d'un service a été effectuée.
otPlatBleGattClientOnDescriptorsDiscoverDone ( otInstance *aInstance, otPlatBleGattDescriptor *aDescs, uint16_t aCount, otError aError)
void
Le pilote BLE appelle cette méthode pour avertir OpenThread que la découverte de descripteur GATT a été effectuée.
otPlatBleGattClientOnIndication ( otInstance *aInstance, uint16_t aHandle, otBleRadioPacket *aPacket)
void
Le pilote BLE appelle cette méthode pour avertir OpenThread qu'une indication de valeur de handle ATT a été reçue.
otPlatBleGattClientOnMtuExchangeResponse ( otInstance *aInstance, uint16_t aMtu, otError aError)
void
Le pilote BLE appelle cette méthode pour informer OpenThread que la réponse Exchange MTU a été reçue.
otPlatBleGattClientOnReadResponse ( otInstance *aInstance, otBleRadioPacket *aPacket)
void
Le pilote BLE appelle cette méthode pour notifier à OpenThread que le paquet ATT Read Response a été reçu.
otPlatBleGattClientOnServiceDiscovered ( otInstance *aInstance, uint16_t aStartHandle, uint16_t aEndHandle, uint16_t aServiceUuid, otError aError)
void
Le pilote BLE appelle cette méthode pour informer OpenThread que l'entrée suivante de la découverte de service principal du GATT a été trouvée.
otPlatBleGattClientOnSubscribeResponse ( otInstance *aInstance, uint16_t aHandle)
void
Le pilote BLE appelle cette méthode pour notifier OpenThread que la réponse d'abonnement a été reçue.
otPlatBleGattClientOnWriteResponse ( otInstance *aInstance, uint16_t aHandle)
void
Le pilote BLE appelle cette méthode pour informer OpenThread que le paquet ATT Write Response a été reçu.
otPlatBleGattClientRead ( otInstance *aInstance, uint16_t aHandle)
Envoie une demande de lecture ATT.
otPlatBleGattClientServiceDiscover ( otInstance *aInstance, const otPlatBleUuid *aUuid)
Exécute la découverte du service principal du GATT par la procédure UUID d'un service spécifique.
otPlatBleGattClientServicesDiscover ( otInstance *aInstance)
Effectue la découverte du service principal du GATT de tous les services disponibles.
otPlatBleGattClientSubscribeRequest ( otInstance *aInstance, uint16_t aHandle, bool aSubscribing)
S'abonne aux indications caractéristiques.
otPlatBleGattClientWrite ( otInstance *aInstance, uint16_t aHandle, otBleRadioPacket *aPacket)
Envoie une demande d'écriture ATT.
otPlatBleGattMtuGet ( otInstance *aInstance, uint16_t *aMtu)
Lit actuellement la valeur d'utilisation de ATT_MTU.
otPlatBleGattServerIndicate ( otInstance *aInstance, uint16_t aHandle, otBleRadioPacket *aPacket)
Envoie une indication de valeur de handle ATT.
otPlatBleGattServerOnIndicationConfirmation ( otInstance *aInstance, uint16_t aHandle)
void
Le pilote BLE appelle cette méthode pour informer OpenThread qu'une confirmation de valeur de handle ATT a été reçue.
otPlatBleGattServerOnReadRequest ( otInstance *aInstance, uint16_t aHandle, otBleRadioPacket *aPacket)
void
Le pilote BLE appelle cette méthode pour informer OpenThread qu'un paquet de demande de lecture ATT a été reçu.
otPlatBleGattServerOnSubscribeRequest ( otInstance *aInstance, uint16_t aHandle, bool aSubscribing)
void
Le pilote BLE appelle cette méthode pour informer OpenThread qu'un paquet de demande d'abonnement ATT a été reçu.
otPlatBleGattServerOnWriteRequest ( otInstance *aInstance, uint16_t aHandle, otBleRadioPacket *aPacket)
void
Le pilote BLE appelle cette méthode pour informer OpenThread qu'un paquet de demande d'écriture ATT a été reçu.
otPlatBleGattServerServicesRegister ( otInstance *aInstance, otPlatBleGattService *aServices)
Enregistre une liste des services du GATT et leurs caractéristiques ci-jointes.
otPlatBleGattVendorUuidRegister ( otInstance *aInstance, const otPlatBleUuid *aUuid)
Enregistre la base UUID spécifique au fournisseur.
otPlatBleIsEnabled ( otInstance *aInstance)
bool
Vérifiez si la radio Bluetooth Low Energy est activée ou non.
otPlatBleL2capConnectionRequest ( otInstance *aInstance, uint16_t aPsm, uint16_t aMtu, uint16_t *aCid)
Envoie une demande de connexion basée sur le crédit LE.
otPlatBleL2capConnectionResponse ( otInstance *aInstance, otPlatBleL2capError aError, uint16_t aMtu, uint16_t *aCid)
Envoie une réponse de connexion basée sur le crédit LE.
otPlatBleL2capDisconnect ( otInstance *aInstance, uint16_t aLocalCid, uint16_t aPeerCid)
Envoie une demande de déconnexion L2CAP.
otPlatBleL2capOnConnectionRequest ( otInstance *aInstance, uint16_t aPsm, uint16_t aMtu, uint16_t aPeerCid)
void
Le pilote BLE appelle cette méthode pour informer OpenThread qu'un paquet de demande de connexion basé sur le crédit LE a été reçu.
otPlatBleL2capOnConnectionResponse ( otInstance *aInstance, otPlatBleL2capError aError, uint16_t aMtu, uint16_t aPeerCid)
void
Le pilote BLE appelle cette méthode pour notifier OpenThread qu'un paquet de réponse de connexion basé sur le crédit LE a été reçu.
otPlatBleL2capOnDisconnect ( otInstance *aInstance, uint16_t aLocalCid, uint16_t aPeerCid)
void
Le pilote BLE appelle cette méthode pour avertir OpenThread qu'une demande de déconnexion L2CAP a été reçue.
otPlatBleL2capOnSduReceived ( otInstance *aInstance, uint16_t aLocalCid, uint16_t aPeerCid, otBleRadioPacket *aPacket)
void
Le pilote BLE appelle cette méthode pour avertir OpenThread qu'une SDU L2CAP a été reçue.
otPlatBleL2capOnSduSent ( otInstance *aInstance)
void
Le pilote BLE appelle cette méthode pour notifier OpenThread qu'une SDU L2CAP a été envoyée.
otPlatBleL2capSduSend ( otInstance *aInstance, uint16_t aLocalCid, uint16_t aPeerCid, otBleRadioPacket *aPacket)
Envoie une SDU sur un canal L2CAP.
otPlatBleOnEnabled ( otInstance *aInstance)
void
Rappel envoyé lorsque Bluetooth Low Energy est prêt après avoir été activé.
otPlatBleReset ( otInstance *aInstance)
Réinitialisez le sous-système Bluetooth Low Energy.

Structs

otBleRadioPacket

Cette structure représente un paquet BLE.

otPlatBleDeviceAddr

Cette structure représente l'adresse du périphérique BLE.

otPlatBleGapConnParams

Cette structure représente les paramètres de connexion BLE.

otPlatBleGattCaractéristique

Cette structure représente la caractéristique du GATT.

otPlatBleGattDescriptor

Cette structure représente le descripteur GATT.

otPlatBleGattService

Descripteur d'enregistrement pour un service du GATT.

otPlatBleUuid

Cette structure représente BLE UUID.

Les syndicats

otPlatBleUuidValue

Cette structure représente la valeur UUID BLE.

Énumérations

énumération anonyme

 anonymous enum
Propriétés
OT_BLE_ADDRESS_LENGTH

La taille de l'adresse du périphérique Bluetooth [octets].

OT_BLE_ADV_DATA_MAX_LENGTH

Longueur maximale des données publicitaires [octets].

OT_BLE_ADV_INTERVAL_MAX

Intervalle maximal autorisé pour le paquet publicitaire en unités OT_BLE_ADV_INTERVAL_UNIT (10,24 s).

OT_BLE_ADV_INTERVAL_MIN

Intervalle minimum autorisé pour le paquet publicitaire en unités OT_BLE_ADV_INTERVAL_UNIT (20 ms).

OT_BLE_ADV_INTERVAL_UNIT

Unité utilisée pour calculer la durée de l'intervalle (0,625 ms).

OT_BLE_ATT_MTU_MAX

Valeur maximale de ATT_MTU [octets].

OT_BLE_CHARACTERISTIC_MAX_LENGTH

Taille maximale de la caractéristique BLE [octets].

OT_BLE_CONN_INTERVAL_MAX

Intervalle de connexion maximal autorisé en unités OT_BLE_CONN_INTERVAL_UNIT (4 s).

Voir v4.2 [Vol 2, Partie E] page 946

OT_BLE_CONN_INTERVAL_MIN

Intervalle de connexion minimum autorisé en unités OT_BLE_CONN_INTERVAL_UNIT (7,5 ms).

Voir v4.2 [Vol 2, Partie E] page 946

OT_BLE_CONN_INTERVAL_UNIT

Unité utilisée pour calculer l'intervalle de connexion (1,25 ms)

OT_BLE_CONN_SLAVE_LATENCY_MAX

Latence maximale autorisée des esclaves en unités d'événements de connexion.

Voir v4.2 [Vol 2, Partie E] page 946

OT_BLE_CONN_SUPERVISOR_TIMEOUT_MAX

Délai maximal de connexion autorisé (32 s).

Voir v4.2 [Vol 2, Partie E] page 946

OT_BLE_CONN_SUPERVISOR_TIMEOUT_MIN

Délai minimum de connexion autorisé en unités de 10 ms (100 ms).

Voir v4.2 [Vol 2, Partie E] page 946

OT_BLE_CONN_SUPERVISOR_UNIT

Unité utilisée pour calculer le délai d'expiration du superviseur de connexion (10 ms).

OT_BLE_DEV_NAME_MAX_LENGTH

Longueur maximale de la caractéristique de nom d'appareil [octets].

OT_BLE_HCI_REMOTE_USER_TERMINATED

Code BLE HCI pour la connexion terminée par l'utilisateur distant.

OT_BLE_INVALID_HANDLE

Valeur du handle non valide / inconnu.

OT_BLE_SCAN_INTERVAL_MAX

Intervalle d'analyse maximal autorisé (10,24 s).

OT_BLE_SCAN_INTERVAL_MIN

Intervalle d'analyse minimum autorisé (2,5 ms).

OT_BLE_SCAN_INTERVAL_UNIT

Unité utilisée pour calculer la durée de l'intervalle de balayage (0,625 ms).

OT_BLE_SCAN_RESPONSE_MAX_LENGTH

Longueur maximale des données de réponse d'analyse [octets].

OT_BLE_SCAN_WINDOW_MAX

Fenêtre d'analyse maximale autorisée en unités OT_BLE_TIMESLOT_UNIT (10,24 s).

OT_BLE_SCAN_WINDOW_MIN

Fenêtre d'analyse minimale autorisée en unités OT_BLE_TIMESLOT_UNIT (2,5 ms).

OT_BLE_SCAN_WINDOW_UNIT

Unité utilisée pour calculer la durée de la fenêtre de numérisation (0,625 ms).

OT_BLE_TIMESLOT_UNIT

Durée de l'intervalle de temps sur la couche PHY en microsecondes (0,625 ms).

OT_BLE_UUID_CCCD

Uuid of Client Configuration Characteristic Descriptor.

OT_BLE_UUID_LENGTH

Longueur de l'UUID BLE complet en octets.

otPlatBleAddressType

 otPlatBleAddressType

Cette énumération représente les types d'adresses de périphérique BLE.

Propriétés
OT_BLE_ADDRESS_TYPE_PUBLIC

Adresse de l'appareil public Bluetooth.

OT_BLE_ADDRESS_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE

Adresse non résoluble privée aléatoire Bluetooth.

OT_BLE_ADDRESS_TYPE_RANDOM_PRIVATE_RESOLVABLE

Adresse résoluble privée aléatoire Bluetooth.

OT_BLE_ADDRESS_TYPE_RANDOM_STATIC

Adresse statique aléatoire Bluetooth.

otPlatBleAdvMode

 otPlatBleAdvMode

Cette énumération définit des indicateurs pour le mode d'annonce BLE.

Propriétés
OT_BLE_ADV_MODE_CONNECTABLE

S'il est défini, le dispositif publicitaire autorisera l'établissement de connexions.

OT_BLE_ADV_MODE_SCANNABLE

S'il est défini, le dispositif publicitaire répondra aux demandes d'analyse.

otPlatBleCccdFlags

 otPlatBleCccdFlags

Cette énumération définit les indicateurs de propriétés characterstic pour un descripteur de configuration de caractéristique client (CCCD).

Voir v4.2 [Vol 3, Partie G] 3.3.1.1 Propriétés caractéristiques - Tableau 3.5

Propriétés
OT_BLE_CHAR_PROP_AUTH_SIGNED_WRITE

S'il est défini, autorise les écritures signées sur la valeur caractéristique.

OT_BLE_CHAR_PROP_BROADCAST

S'il est défini, autorise les diffusions de la valeur de caractéristique à l'aide du descripteur de configuration de caractéristique.

OT_BLE_CHAR_PROP_EXTENDED

S'il est défini, des propriétés de caractéristique supplémentaires sont définies dans le descripteur de propriétés étendues de caractéristique.

OT_BLE_CHAR_PROP_INDICATE

S'il est défini, permet d'indiquer une valeur caractéristique avec acquittement.

OT_BLE_CHAR_PROP_NOTIFY

S'il est défini, autorise les notifications d'une valeur de caractéristique sans accusé de réception.

OT_BLE_CHAR_PROP_READ

S'il est défini, autorise les lectures de la valeur caractéristique.

OT_BLE_CHAR_PROP_WRITE

S'il est défini, autorise les écritures de la valeur caractéristique avec réponse.

OT_BLE_CHAR_PROP_WRITE_NO_RESPONSE

S'il est défini, autorise les écritures de la valeur caractéristique sans réponse.

otPlatBleL2capError

 otPlatBleL2capError

L'énumération indique le résultat de la procédure de demande de connexion L2CAP.

Voir Bluetooth v5.0 | Vol 3, partie A, 4.23, tableau 4.20.

Propriétés
OT_BLE_L2C_ERROR_INVALID_PARAMS

Connexion refusée - paramètres inacceptables.

OT_BLE_L2C_ERROR_INVALID_PSM

Connexion refusée - LE_PSM non pris en charge.

OT_BLE_L2C_ERROR_NONE

Connexion réussie.

OT_BLE_L2C_ERROR_NO_MEM

Connexion refusée - aucune ressource disponible.

otPlatBleUuidType

 otPlatBleUuidType

Cette énumération représente la valeur UUID BLE.

Propriétés
OT_BLE_UUID_TYPE_128

UUID représenté par une valeur de 128 bits.

OT_BLE_UUID_TYPE_16

UUID représenté par une valeur de 16 bits.

OT_BLE_UUID_TYPE_32

UUID représenté par une valeur de 32 bits.

OT_BLE_UUID_TYPE_NONE

Valeur UUID non initialisée.

Typedefs

otBleRadioPacket

struct otBleRadioPacket otBleRadioPacket

Cette structure représente un paquet BLE.

otPlatBleAddressType

enum otPlatBleAddressType otPlatBleAddressType

Cette énumération représente les types d'adresses de périphérique BLE.

otPlatBleAdvMode

enum otPlatBleAdvMode otPlatBleAdvMode

Cette énumération définit des indicateurs pour le mode d'annonce BLE.

otPlatBleCccdFlags

enum otPlatBleCccdFlags otPlatBleCccdFlags

Cette énumération définit les indicateurs de propriétés characterstic pour un descripteur de configuration de caractéristique client (CCCD).

Voir v4.2 [Vol 3, Partie G] 3.3.1.1 Propriétés caractéristiques - Tableau 3.5

otPlatBleDeviceAddr

struct otPlatBleDeviceAddr otPlatBleDeviceAddr

Cette structure représente l'adresse du périphérique BLE.

otPlatBleGapConnParams

struct otPlatBleGapConnParams otPlatBleGapConnParams

Cette structure représente les paramètres de connexion BLE.

otPlatBleGattCaractéristique

struct otPlatBleGattCharacteristic otPlatBleGattCharacteristic

Cette structure représente la caractéristique du GATT.

otPlatBleGattDescriptor

struct otPlatBleGattDescriptor otPlatBleGattDescriptor

Cette structure représente le descripteur GATT.

otPlatBleGattService

struct otPlatBleGattService otPlatBleGattService

Descripteur d'enregistrement pour un service du GATT.

otPlatBleL2capError

enum otPlatBleL2capError otPlatBleL2capError

L'énumération indique le résultat de la procédure de demande de connexion L2CAP.

Voir Bluetooth v5.0 | Vol 3, partie A, 4.23, tableau 4.20.

otPlatBleUuid

struct otPlatBleUuid otPlatBleUuid

Cette structure représente BLE UUID.

otPlatBleUuidType

enum otPlatBleUuidType otPlatBleUuidType

Cette énumération représente la valeur UUID BLE.

otPlatBleUuidValue

union otPlatBleUuidValue otPlatBleUuidValue

Cette structure représente la valeur UUID BLE.

Les fonctions

otPlatBleDisable

 otError otPlatBleDisable(
  otInstance *aInstance
)

Désactivez la radio Bluetooth Low Energy.

Lorsqu'elle est désactivée, la pile BLE videra les files d'attente d'événements et ne générera pas de nouveaux événements. Le périphérique BLE est éteint ou mis en état de veille à faible consommation. Toute mémoire dynamique utilisée par la pile doit être libérée, mais la mémoire statique peut rester réservée.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
Transition réussie en désactivée.
OT_ERROR_FAILED
La radio BLE n'a pas pu être désactivée.

otPlatBleEnable

 otError otPlatBleEnable(
  otInstance *aInstance
)

Activez la radio Bluetooth Low Energy.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
Activé avec succès.
OT_ERROR_FAILED
La radio BLE n'a pas pu être activée.

otPlatBleGapAddressGet

 otError otPlatBleGapAddressGet(
  otInstance *aInstance,
  otPlatBleDeviceAddr *aAddress
)

Obtient l'adresse du périphérique Bluetooth.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[out] aAddress
Le pointeur vers l'adresse du périphérique Bluetooth.
Valeurs de retour
OT_ERROR_NONE
La demande a été effectuée avec succès.
OT_ERROR_INVALID_ARGS
Des paramètres non valides ont été fournis.

otPlatBleGapAddressSet

 otError otPlatBleGapAddressSet(
  otInstance *aInstance,
  const otPlatBleDeviceAddr *aAddress
)

Définit l'adresse du périphérique Bluetooth.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aAddress
Le pointeur vers l'adresse du périphérique Bluetooth.
Valeurs de retour
OT_ERROR_NONE
La demande a été effectuée avec succès.
OT_ERROR_INVALID_ARGS
Des paramètres non valides ont été fournis.

otPlatBleGapAdvDataSet

 otError otPlatBleGapAdvDataSet(
  otInstance *aInstance,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

Définit le contenu du paquet de publicité BLE.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aAdvData
Un pointeur vers le contenu de données publicitaires au format brut.
[in] aAdvDataLength
La taille des données publicitaires. Ne doit pas dépasser OT_BLE_ADV_DATA_MAX_LENGTH.
Valeurs de retour
OT_ERROR_NONE
Les données publicitaires ont été correctement définies.
OT_ERROR_INVALID_ARGS
Des données publicitaires non valides ont été fournies.

otPlatBleGapAdvStart

 otError otPlatBleGapAdvStart(
  otInstance *aInstance,
  uint16_t aInterval,
  uint8_t aType
)

Démarre la procédure de publicité BLE.

Le dispositif BLE doit utiliser de la publicité non dirigée sans aucun filtre appliqué. Un seul paquet publicitaire BLE doit être envoyé sur tous les canaux publicitaires (37, 38 et 39).

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aInterval
L'intervalle entre les paquets publicitaires suivants en unités OT_BLE_ADV_INTERVAL_UNIT. Doit être compris entre OT_BLE_ADV_INTERVAL_MIN et OT_BLE_ADV_INTERVAL_MAX.
[in] aType
Les propriétés de la publicité sous forme de masque binaire: si elle est connectable | numérisable.
Valeurs de retour
OT_ERROR_NONE
La procédure de publicité a été lancée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Une valeur d'intervalle non valide a été fournie.

otPlatBleGapAdvStop

 otError otPlatBleGapAdvStop(
  otInstance *aInstance
)

Arrête la procédure de publicité BLE.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
La procédure de publicité a été interrompue.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.

otPlatBleGapConnParamsSet

 otError otPlatBleGapConnParamsSet(
  otInstance *aInstance,
  const otPlatBleGapConnParams *aConnParams
)

Définit les paramètres de connexion BLE souhaités.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aConnParams
Un pointeur vers la structure des paramètres de connexion.
Valeurs de retour
OT_ERROR_NONE
Les paramètres de connexion ont été définis avec succès.
OT_ERROR_INVALID_ARGS
Des paramètres de connexion non valides ont été fournis.

otPlatBleGapConnect

 otError otPlatBleGapConnect(
  otInstance *aInstance,
  otPlatBleDeviceAddr *aAddress,
  uint16_t aInterval,
  uint16_t aWindow
)

Démarre la procédure de connexion BLE.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aAddress
Une adresse de l'appareil publicitaire.
[in] aInterval
L'intervalle d'analyse en unités OT_BLE_SCAN_INTERVAL_UNIT. Doit être dans la plage OT_BLE_SCAN_INTERVAL_MIN et OT_BLE_SCAN_INTERVAL_MAX.
[in] aWindow
La fenêtre de numérisation en unités OT_BLE_SCAN_WINDOW_UNIT. Doit être dans la plage OT_BLE_SCAN_WINDOW_MIN et OT_BLE_SCAN_WINDOW_MAX.
Valeurs de retour
OT_ERROR_NONE
La procédure de connexion a été lancée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Une adresse, un intervalle ou une valeur de fenêtre non valide ont été fournis.

otPlatBleGapDisconnect

 otError otPlatBleGapDisconnect(
  otInstance *aInstance
)

Déconnecte la connexion BLE.

Le dispositif BLE doit indiquer la raison du code HCI OT_BLE_HCI_REMOTE_USER_TERMINATED.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
La procédure de déconnexion a été lancée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.

otPlatBleGapOnAdvReceived

void otPlatBleGapOnAdvReceived(
  otInstance *aInstance,
  otPlatBleDeviceAddr *aAddress,
  otBleRadioPacket *aPacket
)

Le pilote BLE appelle cette méthode pour notifier OpenThread qu'un paquet de publicité a été reçu.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aAddress
Une adresse de l'appareil publicitaire.
[in] aPacket
Un pointeur vers le paquet reçu.

otPlatBleGapOnConnected

void otPlatBleGapOnConnected(
  otInstance *aInstance,
  uint16_t aConnectionId
)

Le pilote BLE appelle cette méthode pour informer OpenThread que le périphérique BLE a été connecté.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aConnectionId
L'identifiant de la connexion ouverte.

otPlatBleGapOnDisconnected

void otPlatBleGapOnDisconnected(
  otInstance *aInstance,
  uint16_t aConnectionId
)

Le pilote BLE appelle cette méthode pour notifier OpenThread que le périphérique BLE a été déconnecté.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aConnectionId
L'identifiant de la connexion fermée.

otPlatBleGapOnScanRespReceived

void otPlatBleGapOnScanRespReceived(
  otInstance *aInstance,
  otPlatBleDeviceAddr *aAddress,
  otBleRadioPacket *aPacket
)

Le pilote BLE appelle cette méthode pour avertir OpenThread qu'un paquet de réponse d'analyse a été reçu.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aAddress
Une adresse de l'appareil publicitaire.
[in] aPacket
Un pointeur vers le paquet reçu.

otPlatBleGapScanResponseSet

 otError otPlatBleGapScanResponseSet(
  otInstance *aInstance,
  const uint8_t *aScanResponse,
  uint8_t aScanResponseLength
)

Définit le contenu du paquet de réponse d'analyse BLE.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aScanResponse
Un pointeur pour analyser les données de réponse au format brut.
[in] aScanResponseLength
La taille des données de réponse à l'analyse. Ne doit pas dépasser OT_BLE_SCAN_RESPONSE_MAX_LENGTH.
Valeurs de retour
OT_ERROR_NONE
Les données de réponse d'analyse ont été définies avec succès.
OT_ERROR_INVALID_ARGS
Des données de réponse de scan non valides ont été fournies.

otPlatBleGapScanStart

 otError otPlatBleGapScanStart(
  otInstance *aInstance,
  uint16_t aInterval,
  uint16_t aWindow
)

Démarre la procédure d'analyse BLE.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aInterval
L'intervalle d'analyse en unités OT_BLE_SCAN_INTERVAL_UNIT. Doit être dans la plage OT_BLE_SCAN_INTERVAL_MIN et OT_BLE_SCAN_INTERVAL_MAX.
[in] aWindow
La fenêtre de numérisation en unités OT_BLE_SCAN_WINDOW_UNIT. Doit être dans la plage OT_BLE_SCAN_WINDOW_MIN et OT_BLE_SCAN_WINDOW_MAX.
Valeurs de retour
OT_ERROR_NONE
La procédure de numérisation a été lancée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Un intervalle ou une valeur de fenêtre non valide a été fourni.

otPlatBleGapScanStop

 otError otPlatBleGapScanStop(
  otInstance *aInstance
)

Arrête la procédure d'analyse BLE.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
La procédure de numérisation a été arrêtée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.

otPlatBleGapServiceSet

 otError otPlatBleGapServiceSet(
  otInstance *aInstance,
  const char *aDeviceName,
  uint16_t aAppearance
)

Définit le nom et l'apparence du périphérique BLE visibles en tant que service GATT.

La pile de l'hôte BLE doit définir le mode de sécurité 1, niveau 1 (pas de sécurité) pour ces caractéristiques.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aDeviceName
Un pointeur vers la chaîne de nom de périphérique (terminé par null). Ne doit pas dépasser OT_BLE_DEV_NAME_MAX_LENGTH.
[in] aAppearance
La valeur de la caractéristique d'apparence.
Valeurs de retour
OT_ERROR_NONE
Les paramètres de connexion ont été définis avec succès.
OT_ERROR_INVALID_ARGS
Des paramètres non valides ont été fournis.

otPlatBleGattClientCaractéristiquesDécouvrir

 otError otPlatBleGattClientCharacteristicsDiscover(
  otInstance *aInstance,
  uint16_t aStartHandle,
  uint16_t aEndHandle
)

Effectue la découverte des caractéristiques GATT d'un service.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aStartHandle
La poignée de démarrage d'un service.
[in] aEndHandle
La poignée de fin d'un service.
Valeurs de retour
OT_ERROR_NONE
La procédure de découverte des caractéristiques a été lancée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Un descripteur de début ou de fin non valide a été fourni.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattClientDescriptorsDécouvrir

 otError otPlatBleGattClientDescriptorsDiscover(
  otInstance *aInstance,
  uint16_t aStartHandle,
  uint16_t aEndHandle
)

Effectue la découverte des descripteurs GATT.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aStartHandle
La poignée de démarrage.
[in] aEndHandle
La poignée d'extrémité.
Valeurs de retour
OT_ERROR_NONE
La procédure de découverte des descripteurs a été lancée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Un descripteur de début ou de fin non valide a été fourni.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattClientMtuExchangeRequest

 otError otPlatBleGattClientMtuExchangeRequest(
  otInstance *aInstance,
  uint16_t aMtu
)

Envoie une demande d'échange MTU.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aMtu
Une valeur de GATT Client reçoit la taille MTU.
Valeurs de retour
OT_ERROR_NONE
La demande d'échange MTU a été envoyée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Un aMtu non valide a été fourni.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattClientOnCaractéristiquesDécouvrirFait

void otPlatBleGattClientOnCharacteristicsDiscoverDone(
  otInstance *aInstance,
  otPlatBleGattCharacteristic *aChars,
  uint16_t aCount,
  otError aError
)

Le pilote BLE appelle cette méthode pour informer OpenThread que la découverte des caractéristiques GATT d'un service a été effectuée.

En cas de succès, tous les éléments à l'intérieur de aChars doivent avoir une valeur mHandleValue valide.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aChars
Un pointeur vers la liste des caractéristiques découvertes.
[in] aCount
Nombre de caractéristiques dans aChar liste aChar .
[in] aError
La valeur de OT_ERROR_NONE indique qu'au moins une caractéristique a été trouvée et le nombre total d'entre elles est stocké dans aCount . L'erreur OT_ERROR_NOT_FOUND doit être définie si aucune caractéristique n'est trouvée. Sinon, l'erreur indique que la raison de l'échec est utilisée.

otPlatBleGattClientOnDescriptorsDiscoverDone

void otPlatBleGattClientOnDescriptorsDiscoverDone(
  otInstance *aInstance,
  otPlatBleGattDescriptor *aDescs,
  uint16_t aCount,
  otError aError
)

Le pilote BLE appelle cette méthode pour avertir OpenThread que la découverte de descripteur GATT a été effectuée.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aDescs
Un pointeur vers la liste des descripteurs découverts.
[in] aCount
Nombre de descripteurs dans la liste aDescs .
[in] aError
La valeur de OT_ERROR_NONE indique qu'au moins un descripteur a été trouvé et le nombre total d'entre eux est stocké dans aCount . L'erreur OT_ERROR_NOT_FOUND doit être définie si aucun descripteur n'est trouvé. Sinon, l'erreur indique que la raison de l'échec est utilisée.

otPlatBleGattClientOnIndication

void otPlatBleGattClientOnIndication(
  otInstance *aInstance,
  uint16_t aHandle,
  otBleRadioPacket *aPacket
)

Le pilote BLE appelle cette méthode pour avertir OpenThread qu'une indication de valeur de handle ATT a été reçue.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle sur lequel l'indication de valeur de handle ATT a été envoyée.
[in] aPacket
Un pointeur vers le paquet contient la valeur indiquée.

otPlatBleGattClientOnMtuExchangeResponse

void otPlatBleGattClientOnMtuExchangeResponse(
  otInstance *aInstance,
  uint16_t aMtu,
  otError aError
)

Le pilote BLE appelle cette méthode pour informer OpenThread que la réponse Exchange MTU a été reçue.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aMtu
Le serveur d'attributs reçoit la taille MTU.
[in] aError
La valeur de OT_ERROR_NONE indique qu'une réponse MTU d'échange valide a été reçue. Sinon, l'erreur indique que la raison de l'échec est utilisée.

otPlatBleGattClientOnReadResponse

void otPlatBleGattClientOnReadResponse(
  otInstance *aInstance,
  otBleRadioPacket *aPacket
)

Le pilote BLE appelle cette méthode pour notifier à OpenThread que le paquet ATT Read Response a été reçu.

Cette méthode est appelée uniquement si otPlatBleGattClientRead été précédemment demandé.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aPacket
Un pointeur vers le paquet contient une valeur de lecture.

otPlatBleGattClientOnServiceDécouvert

void otPlatBleGattClientOnServiceDiscovered(
  otInstance *aInstance,
  uint16_t aStartHandle,
  uint16_t aEndHandle,
  uint16_t aServiceUuid,
  otError aError
)

Le pilote BLE appelle cette méthode pour informer OpenThread que l'entrée suivante de la découverte de service principal du GATT a été trouvée.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aStartHandle
La poignée de démarrage d'un service.
[in] aEndHandle
La poignée de fin d'un service.
[in] aServiceUuid
Uuid16 pour l'entrée de service.
[in] aError
La valeur de OT_ERROR_NONE indique que le service a été trouvé et que les structures aStartHandle et aEndHandle contiennent des aEndHandle valides. L'erreur OT_ERROR_NOT_FOUND doit être définie si le service n'a pas été trouvé. Sinon, l'erreur indique que la raison de l'échec est utilisée.

otPlatBleGattClientOnSubscribeResponse

void otPlatBleGattClientOnSubscribeResponse(
  otInstance *aInstance,
  uint16_t aHandle
)

Le pilote BLE appelle cette méthode pour notifier OpenThread que la réponse d'abonnement a été reçue.

Cette méthode est appelée uniquement si otPlatBleGattClienSubscribe été précédemment demandé.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle sur lequel la réponse d'écriture ATT a été envoyée.

otPlatBleGattClientOnWriteResponse

void otPlatBleGattClientOnWriteResponse(
  otInstance *aInstance,
  uint16_t aHandle
)

Le pilote BLE appelle cette méthode pour informer OpenThread que le paquet ATT Write Response a été reçu.

Cette méthode est appelée uniquement si otPlatBleGattClientWrite été précédemment demandé.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle sur lequel la réponse d'écriture ATT a été envoyée.

otPlatBleGattClientRead

 otError otPlatBleGattClientRead(
  otInstance *aInstance,
  uint16_t aHandle
)

Envoie une demande de lecture ATT.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle de l'attribut à lire.
Valeurs de retour
OT_ERROR_NONE
La demande d'écriture ATT a été envoyée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Une valeur de descripteur non valide a été fournie.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattClientServiceDécouvrir

 otError otPlatBleGattClientServiceDiscover(
  otInstance *aInstance,
  const otPlatBleUuid *aUuid
)

Exécute la découverte du service principal du GATT par la procédure UUID d'un service spécifique.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aUuid
L'UUID d'un service à enregistrer.
Valeurs de retour
OT_ERROR_NONE
La procédure de découverte de service a été lancée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Un UUID de service non valide a été fourni.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattClientServicesDécouvrir

 otError otPlatBleGattClientServicesDiscover(
  otInstance *aInstance
)

Effectue la découverte du service principal du GATT de tous les services disponibles.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
La procédure de découverte de service a été lancée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Un UUID de service non valide a été fourni.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattClientSubscribeRequest

 otError otPlatBleGattClientSubscribeRequest(
  otInstance *aInstance,
  uint16_t aHandle,
  bool aSubscribing
)

S'abonne aux indications caractéristiques.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle de l'attribut à écrire.
[in] aSubscribing
Vrai si vous vous abonnez, sinon vous vous désabonnez.
Valeurs de retour
OT_ERROR_NONE
L'abonnement a été envoyé.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Une valeur, des données ou une longueur de données non valides ont été fournies.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattClientWrite

 otError otPlatBleGattClientWrite(
  otInstance *aInstance,
  uint16_t aHandle,
  otBleRadioPacket *aPacket
)

Envoie une demande d'écriture ATT.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle de l'attribut à écrire.
[in] aPacket
Un pointeur vers le paquet contient une valeur à écrire dans l'attribut.
Valeurs de retour
OT_ERROR_NONE
La demande d'écriture ATT a été envoyée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Une valeur, des données ou une longueur de données non valides ont été fournies.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattMtuGet

 otError otPlatBleGattMtuGet(
  otInstance *aInstance,
  uint16_t *aMtu
)

Lit actuellement la valeur d'utilisation de ATT_MTU.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[out] aMtu
Un pointeur contient la valeur ATT_MTU actuelle.
Valeurs de retour
OT_ERROR_NONE
La valeur ATT_MTU a été placée dans aMtu .
OT_ERROR_FAILED
Le périphérique BLE ne peut pas déterminer son ATT_MTU.

otPlatBleGattServerIndicate

 otError otPlatBleGattServerIndicate(
  otInstance *aInstance,
  uint16_t aHandle,
  otBleRadioPacket *aPacket
)

Envoie une indication de valeur de handle ATT.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle de l'attribut à indiquer.
[in] aPacket
Un pointeur vers le paquet contient une valeur à indiquer.
Valeurs de retour
OT_ERROR_NONE
L'indication de valeur de handle ATT a été envoyée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Une valeur, des données ou une longueur de données non valides ont été fournies.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattServerOnIndicationConfirmation

void otPlatBleGattServerOnIndicationConfirmation(
  otInstance *aInstance,
  uint16_t aHandle
)

Le pilote BLE appelle cette méthode pour informer OpenThread qu'une confirmation de valeur de handle ATT a été reçue.

Cette méthode est appelée uniquement si otPlatBleGattServerIndicate été précédemment demandé.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle sur lequel ATT Handle Value Confirmation a été envoyé.

otPlatBleGattServerOnReadRequest

void otPlatBleGattServerOnReadRequest(
  otInstance *aInstance,
  uint16_t aHandle,
  otBleRadioPacket *aPacket
)

Le pilote BLE appelle cette méthode pour informer OpenThread qu'un paquet de demande de lecture ATT a été reçu.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle de l'attribut à lire.
[out] aPacket
Un pointeur vers le paquet à remplir avec des pointeurs vers les données d'attribut à lire.

otPlatBleGattServerOnSubscribeRequest

void otPlatBleGattServerOnSubscribeRequest(
  otInstance *aInstance,
  uint16_t aHandle,
  bool aSubscribing
)

Le pilote BLE appelle cette méthode pour informer OpenThread qu'un paquet de demande d'abonnement ATT a été reçu.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle de l'attribut à écrire.
[in] aSubscribing
Vrai si vous vous abonnez, sinon vous vous désabonnez.

otPlatBleGattServerOnWriteRequest

void otPlatBleGattServerOnWriteRequest(
  otInstance *aInstance,
  uint16_t aHandle,
  otBleRadioPacket *aPacket
)

Le pilote BLE appelle cette méthode pour informer OpenThread qu'un paquet de demande d'écriture ATT a été reçu.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aHandle
Le handle de l'attribut à écrire.
[in] aPacket
Un pointeur vers le paquet contient une valeur à écrire dans l'attribut.

otPlatBleGattServerServicesRegister

 otError otPlatBleGattServerServicesRegister(
  otInstance *aInstance,
  otPlatBleGattService *aServices
)

Enregistre une liste des services du GATT et leurs caractéristiques ci-jointes.

Les descripteurs générés seront réécrits dans cette structure lorsque la pile BLE est activée.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aServices
Tableau de structures de service terminé nul à enregistrer.
Valeurs de retour
OT_ERROR_NONE
Le service a été enregistré avec succès.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état non valide.
OT_ERROR_INVALID_ARGS
Un UUID de service non valide a été fourni.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleGattVendorUuidRegister

 otError otPlatBleGattVendorUuidRegister(
  otInstance *aInstance,
  const otPlatBleUuid *aUuid
)

Enregistre la base UUID spécifique au fournisseur.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aUuid
Un pointeur vers la base UUID 128 bits spécifique au fournisseur.

otPlatBleIsEnabled

bool otPlatBleIsEnabled(
  otInstance *aInstance
)

Vérifiez si la radio Bluetooth Low Energy est activée ou non.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
Valeurs de retour
::true
La radio Bluetooth Low Energy est activée.
::false
La radio Bluetooth Low Energy est désactivée.

otPlatBleL2capConnectionRequest

 otError otPlatBleL2capConnectionRequest(
  otInstance *aInstance,
  uint16_t aPsm,
  uint16_t aMtu,
  uint16_t *aCid
)

Envoie une demande de connexion basée sur le crédit LE.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aPsm
La valeur du multiplexeur de protocole / service LE.
[in] aMtu
La valeur spécifie la taille SDU maximale (en octets) que l'entité de couche L2CAP qui envoie la demande de connexion basée sur le crédit LE peut recevoir sur ce canal.
[out] aCid
Le CID source représente un point de terminaison de canal sur l'appareil.
Valeurs de retour
OT_ERROR_NONE
La demande de connexion basée sur le crédit LE a été envoyée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état invalide, par exemple pas dans la connexion GAP.
OT_ERROR_INVALID_ARGS
Des paramètres non valides ont été fournis.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleL2capConnectionResponse

 otError otPlatBleL2capConnectionResponse(
  otInstance *aInstance,
  otPlatBleL2capError aError,
  uint16_t aMtu,
  uint16_t *aCid
)

Envoie une réponse de connexion basée sur le crédit LE.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aError
La valeur d'erreur indique le résultat de la demande de connexion.
[in] aMtu
La valeur spécifie la taille SDU maximale (en octets) que l'entité de couche L2CAP qui envoie la réponse de connexion basée sur le crédit LE peut recevoir sur ce canal.
[out] aCid
Le CID source représente un point de terminaison de canal sur l'appareil. Si aResult valeur de résultat est différente de OT_BLE_L2C_ERROR_NONE , cette variable est inutilisée et doit être définie sur NULL.
Valeurs de retour
OT_ERROR_NONE
LE Credit Based Connection La réponse a été envoyée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état invalide, par exemple pas dans la connexion GAP.
OT_ERROR_INVALID_ARGS
Des paramètres non valides ont été fournis.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleL2capDisconnect

 otError otPlatBleL2capDisconnect(
  otInstance *aInstance,
  uint16_t aLocalCid,
  uint16_t aPeerCid
)

Envoie une demande de déconnexion L2CAP.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aLocalCid
La valeur de l'ID du point de terminaison du canal local.
[in] aPeerCid
La valeur de l'ID de point de terminaison du canal homologue.
Valeurs de retour
OT_ERROR_NONE
La demande de déconnexion L2CAP a été envoyée.
OT_ERROR_INVALID_STATE
Le périphérique BLE est dans un état invalide, par exemple pas dans la connexion GAP.
OT_ERROR_INVALID_ARGS
Des paramètres non valides ont été fournis.
OT_ERROR_NO_BUFS
Aucun tampon interne disponible trouvé.

otPlatBleL2capOnConnectionRequest

void otPlatBleL2capOnConnectionRequest(
  otInstance *aInstance,
  uint16_t aPsm,
  uint16_t aMtu,
  uint16_t aPeerCid
)

Le pilote BLE appelle cette méthode pour informer OpenThread qu'un paquet de demande de connexion basé sur le crédit LE a été reçu.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aPsm
La valeur du multiplexeur de protocole / service LE.
[in] aMtu
La valeur spécifie la taille maximale de SDU (en octets) que l'entité de couche L2CAP qui envoie la demande de connexion basée sur le crédit LE peut recevoir sur ce canal.
[in] aPeerCid
Le CID représente un point de terminaison de canal sur le périphérique homologue.

otPlatBleL2capOnConnectionResponse

void otPlatBleL2capOnConnectionResponse(
  otInstance *aInstance,
  otPlatBleL2capError aError,
  uint16_t aMtu,
  uint16_t aPeerCid
)

Le pilote BLE appelle cette méthode pour notifier OpenThread qu'un paquet de réponse de connexion basé sur le crédit LE a été reçu.

Détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aError
La valeur d'erreur indique le résultat de la demande de connexion.
[in] aMtu
La valeur spécifie la taille maximale de SDU (en octets) que l'entité de couche L2CAP qui envoie la réponse de connexion basée sur le crédit LE peut recevoir sur ce canal.
[in] aPeerCid
The CID represents a channel endpoint on the peer device.

otPlatBleL2capOnDisconnect

void otPlatBleL2capOnDisconnect(
  otInstance *aInstance,
  uint16_t aLocalCid,
  uint16_t aPeerCid
)

The BLE driver calls this method to notify OpenThread that an L2CAP Disconnection Request has been received.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aLocalCid
The local channel endpoint ID value.
[in] aPeerCid
The peer channel endpoint ID value.

otPlatBleL2capOnSduReceived

void otPlatBleL2capOnSduReceived(
  otInstance *aInstance,
  uint16_t aLocalCid,
  uint16_t aPeerCid,
  otBleRadioPacket *aPacket
)

The BLE driver calls this method to notify OpenThread that an L2CAP SDU has been received.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aLocalCid
The local channel endpoint ID value.
[in] aPeerCid
The peer channel endpoint ID value.
[in] aPacket
A pointer to the packet containing SDU.

otPlatBleL2capOnSduSent

void otPlatBleL2capOnSduSent(
  otInstance *aInstance
)

The BLE driver calls this method to notify OpenThread that an L2CAP SDU has been sent.

Details
Parameters
[in] aInstance
The OpenThread instance structure.

otPlatBleL2capSduSend

 otError otPlatBleL2capSduSend(
  otInstance *aInstance,
  uint16_t aLocalCid,
  uint16_t aPeerCid,
  otBleRadioPacket *aPacket
)

Sends an SDU on an L2CAP channel.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aLocalCid
The local channel endpoint ID value.
[in] aPeerCid
The peer channel endpoint ID value.
[in] aPacket
A pointer to the packet containing SDU.
Return Values
OT_ERROR_NONE
LE Credit Based Connection Request has been sent.
OT_ERROR_INVALID_STATE
BLE Device is in invalid state eg not in the GAP connection.
OT_ERROR_INVALID_ARGS
Invalid parameters has been supplied.
OT_ERROR_NO_BUFS
No available internal buffer found.

otPlatBleOnEnabled

void otPlatBleOnEnabled(
  otInstance *aInstance
)

Callback sent when Bluetooth Low Energy is ready after being enabled.

Details
Parameters
[in] aInstance
The OpenThread instance structure.

otPlatBleReset

 otError otPlatBleReset(
  otInstance *aInstance
)

Reset the Bluetooth Low Energy subsystem.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
Return Values
OT_ERROR_NONE
Successfully reset.
OT_ERROR_FAILED
The BLE stack could not be reset.

Macros

OT_BLE_MS_TO_TICKS

 OT_BLE_MS_TO_TICKS (((x)*1000) / OT_BLE_ADV_INTERVAL_UNIT)

Convert the advertising interval from [ms] to [ble symbol times].