BLEClient Configuration
The class 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 class, 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 class 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 class 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 class 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 class 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 class 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 class 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 class 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 class 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. | |||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to false to use the class in a background thread on macOS. By default this setting is True. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API. |