# BLEServer Control

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.*

|  |  |
| --- | --- |
| [Listening](#listening-property-bleserver-control) | This property indicates whether the control is listening for incoming connections on LocalPort. |
| [ServerId](#serverid-property-bleserver-control) | TBD. |

## Method List

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

|  |  |
| --- | --- |
| [AddCharacteristic](#addcharacteristic-method-bleserver-control) | TBD. |
| [Config](#config-method-bleserver-control) | Sets or retrieves a configuration setting. |
| [DoEvents](#doevents-method-bleserver-control) | This method processes events from the internal message queue. |
| [StartListening](#startlistening-method-bleserver-control) | TBD. |
| [StopListening](#stoplistening-method-bleserver-control) | TBD. |

## 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.*

|  |  |
| --- | --- |
| [AdvertisementStatusChanged](#advertisementstatuschanged-event-bleserver-control) | TBD. |
| [Connected](#connected-event-bleserver-control) | TBD. |
| [Disconnected](#disconnected-event-bleserver-control) | TBD. |
| [Error](#error-event-bleserver-control) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-bleserver-control) | Fires once for each log message. |
| [ReadRequested](#readrequested-event-bleserver-control) | TBD. |
| [SessionStatusChanged](#sessionstatuschanged-event-bleserver-control) | TBD. |
| [SubscriptionChanged](#subscriptionchanged-event-bleserver-control) | TBD. |
| [WriteRequested](#writerequested-event-bleserver-control) | TBD. |

## Config Settings

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

|  |  |
| --- | --- |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Listening Property ([BLEServer](#bleserver-control) Control)

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

## Syntax

```text
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](#startlistening-method-bleserver-control) and [StopListening](#stoplistening-method-bleserver-control) 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](#bleserver-control) Control)

TBD.

## Syntax

```text
bleservercontrol.ServerId[=string]
```

## Default Value

""

## Remarks

TBD.

This property is not available at design time.

## Data Type

String

# AddCharacteristic Method ([BLEServer](#bleserver-control) Control)

TBD.

## Syntax

```text
bleservercontrol.AddCharacteristic ServiceId, CharacteristicId, Props
```

## Remarks

TBD.

# Config Method ([BLEServer](#bleserver-control) Control)

Sets or retrieves a configuration setting.

## Syntax

```text
bleservercontrol.Config ConfigurationString
```

## Remarks

Config is a generic method available in every control. It is used to set and retrieve [configuration settings](#config-settings-bleserver-control) 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](#config-settings-bleserver-control), you must call *Config("PROPERTY")*. The value will be returned as a string.

# DoEvents Method ([BLEServer](#bleserver-control) Control)

This method processes events from the internal message queue.

## Syntax

```text
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](#bleserver-control) Control)

TBD.

## Syntax

```text
bleservercontrol.StartListening ServiceId
```

## Remarks

TBD.

# StopListening Method ([BLEServer](#bleserver-control) Control)

TBD.

## Syntax

```text
bleservercontrol.StopListening ServiceId
```

## Remarks

TBD.

# AdvertisementStatusChanged Event ([BLEServer](#bleserver-control) Control)

TBD.

## Syntax

```text
Sub bleservercontrol_AdvertisementStatusChanged(Status As Integer, Error As Integer)
```

## Remarks

TBD.

# Connected Event ([BLEServer](#bleserver-control) Control)

TBD.

## Syntax

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

## Remarks

TBD.

# Disconnected Event ([BLEServer](#bleserver-control) Control)

TBD.

## Syntax

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

## Remarks

TBD.

# Error Event ([BLEServer](#bleserver-control) Control)

Fired when information is available about errors during data delivery.

## Syntax

```text
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](#trappable-errors-bleserver-control) section.

# Log Event ([BLEServer](#bleserver-control) Control)

Fires once for each log message.

## Syntax

```text
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](#LogLevel) setting.

*LogLevel* indicates the level of the *Message*. Possible values are:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data is logged. |
| 3 (Debug) | Debug data is logged. |

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](#bleserver-control) Control)

TBD.

## Syntax

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

## Remarks

TBD.

# SessionStatusChanged Event ([BLEServer](#bleserver-control) Control)

TBD.

## Syntax

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

## Remarks

TBD.

# SubscriptionChanged Event ([BLEServer](#bleserver-control) Control)

TBD.

## Syntax

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

## Remarks

TBD.

# WriteRequested Event ([BLEServer](#bleserver-control) Control)

TBD.

## Syntax

```text
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](#bleserver-control) 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](#config-method-bleserver-control) method.

### BLEServer Config Settings

**LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [Log](#log-event-bleserver-control) event. Possible values are:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data is logged. |
| 3 (Debug) | Debug data is logged. |

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.

### Base Config Settings

**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:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the control will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *True* tells the control to use the internal implementation instead of using the system security libraries.

 This setting is set to *False* by default on all platforms.

# Trappable Errors ([BLEServer](#bleserver-control) Control)

### BLEServer Errors

|  |  |
| --- | --- |
| 20601 | Invalid UUID. |
| 20602 | Invalid Id. |
| 20603 | Action not allowed. See error message for more details. |
| 20604 | Scanning error. See error message for more details. |
| 20605 | Connection error. See error message for more details. |
| 20606 | Must be connected to a device to perform the requested action. |
| 20607 | Error during communication. See error message for more details. |
| 20608 | Device unreachable during communication attempt. |
| 20609 | Error during discovery. See error message for more details. |
| 20610 | Control detected a cycle of included services. |
| 20611 | General read error. See error message for more details. |
| 20612 | General write error. See error message for more details. |
| 20613 | Application-specific protocol error. This error code indicates that a protocol error code in the range 0x80-0x9F was returned during a BLE communication. Such error codes are reserved for applications to use as they see fit. Refer to the documentation of your remote device for more information. |
| 20614 | Bluetooth low energy not supported. |
| 20702 | Invalid Handle: The attribute handle given was not valid on this server. |
| 20703 | Read Not Permitted: The attribute cannot be read due to its permissions. |
| 20704 | Write Not Permitted: The attribute cannot be written due to its permissions. |
| 20705 | Invalid PDU: The attribute PDU was invalid. |
| 20706 | Insufficient Authentication: The attribute requires authentication before it can be read or written. |
| 20707 | Request Not Supported: Attribute server does not support the request received from the client. |
| 20708 | Invalid Offset: Offset specified was past the end of the attribute's value. |
| 20709 | Insufficient Authorization: The attribute requires authorization before it can be read or written. |
| 20710 | Prepare Queue Full: Too many prepare writes have been queued. |
| 20711 | Attribute Not Found: No attribute found within the given attribute handle range. |
| 20712 | Attribute Not Long: The attribute cannot be read or written using the Read Blob Request. |
| 20713 | Insufficient Encryption Key Size: The Encryption Key Size used for encrypting this link is insufficient. |
| 20714 | Invalid Attribute Value Length: The attribute value length is invalid for the operation. |
| 20715 | Unlikely Error: The attribute request that was requested has encountered an error that was unlikely, and therefore could not be completed as requested. |
| 20716 | Insufficient Encryption: The attribute requires encryption before it can be read or written. |
| 20717 | Unsupported Group Type: The attribute type is not a supported grouping attribute as defined by a higher layer specification. |
| 20718 | Insufficient Resources: Insufficient Resources to complete the request. |
| 20953 | Write Request Rejected: A requested write operation could not be fulfilled for reasons other than its permissions. |
| 20954 | Client Characteristic Configuration Descriptor (CCCD) Improperly Configured: The CCCD is not configured according to the requirements of the profile or service. |
| 20955 | Procedure Already in Progress: A profile or service request cannot be serviced because a previously triggered operation is still in progress. |
| 20956 | Out of Range: An attribute value is out of range (as defined by a profile or service specification). |