UM1870 datasheet(26/58 Pages) STMICROELECTRONICS

26 / 58 page

GUI software description

UM1870

26/58

DocID027602 Rev 1

The WAIT_EVENT macro-command waits for an event with 'Event Code' parameter equal

to event_code. If no event_code is indicated, the macro-command waits for any event.

The timeout parameter allows to set the event timeout. If no timeout is set, the macro-

command waits until an event occurs. If a timeout (greater than zero) is set and

continueOnEvtMiss is False and no event occurs before the timeout, an HCITimeoutError

error happens. Otherwise, if the input parameter continueOnEvtMiss is True and a timeout

(greater than zero) is set, the macro-command returns the value None even when no event

occurs before the timeout.

If one or more optional filtering parameters are specified, the macro-command performs a

check on them and it returns only the first detected event that satisfies these parameters.

The events received before the one returned are discarded.

The WAIT_EVENT() command return value can be:

• an event

• None, if a timeout occurs and the input parameter “continueOnEvtMiss” is set to True.

An HCITimeoutError error exception is raised when a timeout occurs.

The event_code parameter can be one of the following values:

Table 8. WAIT_EVENT macro-command

Command name

Parameters

Description

WAIT_EVENT

event_code = None (default)

timeout = None (default)

continueOnEvtMiss = False

(default)

param_checks = optional

filtering parameters

It waits an event with ‘Event Code’ parameter

equal to event_code. If no event_code is

indicated, the macro-command waits any event.

Optional filtering parameters allow to define

additional filters on event fields.

Table 9. WAIT_EVENT: event_code types

event_code

event param.

name

event parameter name

HCI_LE_META

Subevent_Code

HCI_LE_CONNECTION_COMPLETE

HCI_LE_ADVERTISING_REPORT

HCI_LE_CONNECTION_UPDATE_COMPLETE

HCI_LE_READ_REMOTE_USED_FEATURES_COMPLETE

HCI_LE_LONG_TERM_KEY_REQUEST

UM1870 Datasheet(PDF) 26 Page - STMicroelectronics

UM1870 Datasheet(HTML) 26 Page - STMicroelectronics

Html Pages

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

Datasheet Download

Link URL