BTLEListDevice (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / BTLE functions

Miscellaneous
Required versions
Required permissions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

BTLEListDevice (Function)

In french: BTLEListePériphérique

Returns the list of accessible Bluetooth Low Energy devices.

Example

BTLEListDevice(ProcDétectePériph)
...
INTERNAL PROCEDURE ProcDétectePériph(UnPériph)
// Traitement de UnPériph
END

Syntax

BTLEListDevice(<WLanguage procedure> [, <Timeout>])

<WLanguage procedure>: Procedure name

Name of the WLanguage procedure ("callback") called to list the devices. This procedure is used to get information about the devices found.
This procedure has the following format:
PROCEDURE <Procedure name> (<Device>, <Signal intensity>)

where:
<Device> is a btleDevice variable corresponding to the connected device.
<Signal intensity> is an integer corresponding to the intensity of signal expressed in decibel per meter.
If the procedure returns False, the analysis of accessible devices will be immediately stopped.

<Timeout>: Optional integer or optional Duration

Timeout for the search (in seconds). This parameter can correspond to:
an integer corresponding to the number of seconds,
a Duration variable,
the duration in a readable format (e.g., 1 s).
If this parameter is not specified, the default timeout is set to 10 seconds.

Remarks

Miscellaneous

If BTLEListDevice is called when an analysis is in progress, the previous analysis will be stopped and a new analysis will be started.

Required versions

Android applications:
- Bluetooth Low Energy WLanguage functions are only available on devices with Android 4.3 or later (api level 18).
- A fatal error occurs if the function is used with an earlier system version.
- To determine the version of Android the application is running on, use SysAndroidVersion.
iOS applications:
The WLanguage Bluetooth Low Energy functions are available for the devices running iOS 9.
WINDEV applications:
- Bluetooth Low Energy WLanguage functions are only available on:
  - PCs that support at least Bluetooth Low Energy 5.
  - PCs using a Bluetooth device that supports at least Bluetooth Low Energy 5.
- If necessary, you can check the Bluetooth version of a PC in the Windows device manager: https://support.microsoft.com/en-us/windows/what-bluetooth-version-is-on-my-pc-f5d4cff7-c00d-337b-a642-d2d23b082793
- Pairing must be done via Windows. Therefore, BTLEListDevice will only list devices that are visible and associated in the Windows Bluetooth settings.

Required permissions

This function changes the permissions required by the application.

Required permissions:

BLUETOOTH: this permission allows applications to connect to Bluetooth services.
ACCESS_COARSE_LOCATION: this permission allows an application to access an undefined location (Cell-ID, WiFi).

Android 11 specific case: This function requires the ACCESS_BACKGROUND_LOCATION permission to access the device's location.
This permission allows using the function when the application is in the background.

If the application needs to use background location:

Manually add the "ACCESS_BACKGROUND_LOCATION" permission in the Android application generation wizard.

Explicitly request background location permission with PermissionRequest. For example:

PermissionRequest(permBackgroundLocation, Callback)
INTERNAL PROCEDURE Callback(p is Permission)
	IF p.Accordé THEN
		// Utilisation possible des fonctions nécessitant la localisation en arrière-plan
	END
END

A window allows users to:

allow access to the device location while the application is in the background,
allow access to the location only while the application is in use,
deny access to the location. The user can also change these permissions at any time in the Android settings.

Remarks:

Follow Google's guidelines for applications that require background location access. For more details, see https://support.google.com/googleplay/android-developer/answer/9799150. If these conditions are not met (especially user information requirements), applications may not be accepted for publication on Google Play.
The background location permission should only be requested if the location permission has been granted. Otherwise, PermissionRequest will fail.
If the option chosen by the user for the background location access request is more restrictive than the option chosen for the location access request, the application will be automatically restarted.
On devices running Android 10 or earlier, if location permission has been granted to the application, the background location permission will be granted without displaying a window.

Related Examples:

Cross-platform examples (WINDEV Mobile): WM Bluetooth 4

[ + ] This example explains how to use the Bluetooth Low Energy functions (Bluetooth LE): BTLExxx.

It is an application allowing you to find the nearby BTLE devices, to connect to them and to interact with the proposed services.

Business / UI classification: Business Logic

Component: wd300com.dll