BLEClient Configuration
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.BLEClient Configuration Settings
AutoDiscoverCharacteristics:
Whether to automatically discover all characteristics when a service is discovered.When enabled, the component will automatically attempt to discover all characteristics for every service (or included service) that it discovers.
This is disabled by default; keep in mind that enabling it will likely cause increased power consumption. | |||||||||
AutoDiscoverDescriptors:
Whether to automatically discover all descriptors when a characteristic is discovered.When enabled, the component will automatically attempt to discover all descriptors for every characteristic that it discovers.
This is disabled by default; keep in mind that enabling it will likely cause increased power consumption. | |||||||||
AutoDiscoverIncludedServices:
Whether to automatically discover all included services when a service is discovered.When enabled, the component will automatically attempt to discover all included services for every service (or included service) that it discovers.
An exception will be thrown if a cycle of included services is detected (this should not occur on a properly configured server). This is disabled by default; keep in mind that enabling it will likely cause increased power consumption. | |||||||||
GattObjTreeInfo: Returns a string representation of the currently discovered GATT object tree.When queried, the component will return a string with information about the current discovered GATT object tree. This is only useful for debugging purposes. | |||||||||
IncludeRediscovered:
Whether to fire the Discovered event for rediscovered services, characteristics, and descriptors.When disabled, the component will not fire the Discovered event during a discovery process for any services, characteristics, or descriptors which have already been discovered.
This is enabled by default (the component will fire Discovered for every discovery, regardless of whether or not it was a rediscovery). | |||||||||
LogLevel:
The level of detail that is logged.This setting controls the level of detail that is logged through the Log event. Possible values are:
The default log level, Info, provides information when most BLE operations begin and end, and should be sufficient to get a good idea of what the component is doing at a high level. The Verbose log level adds a few extra operation timing messages, and adds more detail to some messages logged at the Info level. The Debug log level causes the component to output as much information as possible about what it is doing at all times. All BLE communications, even those which are typically abstracted away by the API, are logged in full detail. Typically the additional information added by this log level is not helpful to the end user, and would only be necessary to capture if you wish to report an issue to the support team. | |||||||||
ManufacturerCompanyId[i]:
The manufacturer company Id at index 'i'.The setting can be queried while within the Advertisement event handler to get the company Id from the manufacturer data section at index 'i'.
Valid indices are from 0 to ManufacturerDataCount - 1. This setting is only valid when used within the Advertisement event handler. | |||||||||
ManufacturerData[i]:
The manufacturer data at index 'i'.The setting can be queried while within the Advertisement event handler to get the data from the manufacturer data section at index 'i'. The data is returned as a byte string.
Valid indices are from 0 to ManufacturerDataCount - 1. This setting is only valid when used within the Advertisement event handler. | |||||||||
ManufacturerDataCount:
The number of manufacturer data sections an advertisement has.This setting can be queried while within the Advertisement event handler to determine how many manufacturer data sections the advertisement contains.
This setting is only valid when used within the Advertisement event handler. | |||||||||
PreferIndications:
Whether to subscribe to characteristics using indicate when possible.There are two types of characteristic subscriptions: notifications, which are not acknowledged; and indications, which are acknowledged. This setting is disabled by default, so the component will prefer notifications when subscribing to a characteristic which supports both types of subscriptions. If this setting is enabled, the component will instead prefer indications when subscribing to such characteristics.
Note that preferring indications over notifications can result in increased power consumption since indications require an additional transmit/receive operation. | |||||||||
ScanStartedTimeout: The maximum amount of time to wait for scanning to start.This setting determines how long the StartScanning method will wait to let the scanning process start. If the scan status does not update in that time, the Log event will fire with a message that scanning failed to start. The default value is 2 seconds. | |||||||||
ServiceData:
Gets the data associated with a service UUID from an advertisement.While within the Advertisement event handler, you can set this to one of the UUIDs from the Advertisement event's ServicesWithData parameter to get the data associated with it. The data is returned as a byte string.
This setting is only valid when used within the Advertisement event handler. |
Base Configuration Settings
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | |
GUIAvailable:
Tells the component whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.
In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events. | |
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:
| |
UseInternalSecurityAPI:
Tells the component whether or not to use the system security libraries or an internal implementation.
By default the component will use the system security libraries to perform cryptographic functions.
When set to False calls to unmanaged code will be made. In certain environments this is not desirable.
To use a completely managed security implementation set this setting to True.
Setting this to True tells the component to use the internal implementation
instead of using the system's security API.
Note: This setting is static. The value set is applicable to all components used in the application. When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file. |