BLEServer Control

Properties   Methods   Events   Config Settings   Errors  

TBD.

Syntax

BLEServer

Remarks

TBD.

Property List

---

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

Listening Property (BLEServer Control)

This property indicates whether the control is listening for incoming connections on LocalPort.

Syntax

bleservercontrol.Listening

Default Value

False

Remarks

This property indicates whether the control is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the control is listening.

This property is read-only and not available at design time.

Data Type

Boolean

ServerId Property (BLEServer Control)

TBD.

Syntax

bleservercontrol.ServerId[=string]

Default Value

""

Remarks

TBD.

This property is not available at design time.

Data Type

String

AddCharacteristic Method (BLEServer Control)

TBD.

Syntax

bleservercontrol.AddCharacteristic ServiceId, CharacteristicId, Props

Remarks

TBD.

Config Method (BLEServer Control)

Sets or retrieves a configuration setting.

Syntax

bleservercontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (BLEServer Control)

This method processes events from the internal message queue.

Syntax

bleservercontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

StartListening Method (BLEServer Control)

TBD.

Syntax

bleservercontrol.StartListening ServiceId

Remarks

TBD.

StopListening Method (BLEServer Control)

TBD.

Syntax

bleservercontrol.StopListening ServiceId

Remarks

TBD.

AdvertisementStatusChanged Event (BLEServer Control)

TBD.

Syntax

Sub bleservercontrol_AdvertisementStatusChanged(Status As Integer, Error As Integer)

Remarks

TBD.

Connected Event (BLEServer Control)

TBD.

Syntax

Sub bleservercontrol_Connected(ClientId As String, StatusCode As Integer, Description As String)

Remarks

TBD.

Disconnected Event (BLEServer Control)

TBD.

Syntax

Sub bleservercontrol_Disconnected(ClientId As String, StatusCode As Integer, Description As String)

Remarks

TBD.

Error Event (BLEServer Control)

Fired when information is available about errors during data delivery.

Syntax

Sub bleservercontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (BLEServer Control)

Fires once for each log message.

Syntax

Sub bleservercontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This events fires once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the Message. 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 control 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 control 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.

LogType identifies the type of log entry. Possible values are:

• Scanning: Messages relating to scanning and advertisements.
• Connection: Messages relating to connecting, disconnecting, and connection failures.
• Discovery: Messages relating to any service, characteristic, or descriptor discovery process.
• Read: Messages relating to reading values from the remote device.
• Write: Messages relating to writing values to the remote device.
• Subscriptions: Messages relating to subscribing to and unsubscribing from characteristics.
• Info, Verbose, and Debug: Miscellaneous messages fired at the applicable log level concerning internal control operations.

ReadRequested Event (BLEServer Control)

TBD.

Syntax

Sub bleservercontrol_ReadRequested(ClientId As String, ServiceId As String, CharacteristicId As String, ResponseValue As String, Accept As Boolean)

Remarks

TBD.

SessionStatusChanged Event (BLEServer Control)

TBD.

Syntax

Sub bleservercontrol_SessionStatusChanged(ClientId As String, Status As Integer, Error As Integer)

Remarks

TBD.

SubscriptionChanged Event (BLEServer Control)

TBD.

Syntax

Sub bleservercontrol_SubscriptionChanged(ServiceId As String, CharacteristicId As String, IsSubscribed As Boolean)

Remarks

TBD.

WriteRequested Event (BLEServer Control)

TBD.

Syntax

Sub bleservercontrol_WriteRequested(ClientId As String, ServiceId As String, CharacteristicId As String, Value As String, WithResponse As Boolean, Accept As Boolean)

Remarks

TBD.

Config Settings (BLEServer Control)

The control 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 control, access to these internal properties is provided through the Config method.

BLEServer Config Settings

Base Config Settings

Trappable Errors (BLEServer Control)

BLEServer Errors