BLEServer Component

Properties   Methods   Events   Config Settings   Errors  

TBD.

Syntax

TiplBLEServer

Remarks

TBD.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

Listening Property (BLEServer Component)

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

Syntax

property Listening: Boolean read get_Listening;

Default Value

false

Remarks

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

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

ServerId Property (BLEServer Component)

TBD.

Syntax

property ServerId: String read get_ServerId write set_ServerId;

Default Value

''

Remarks

TBD.

This property is not available at design time.

AddCharacteristic Method (BLEServer Component)

TBD.

Syntax

procedure AddCharacteristic(ServiceId: String; CharacteristicId: String; Props: Integer);

Remarks

TBD.

Config Method (BLEServer Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

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

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 Component)

This method processes events from the internal message queue.

Syntax

procedure DoEvents();

Remarks

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

StartListening Method (BLEServer Component)

TBD.

Syntax

procedure StartListening(ServiceId: String);

Remarks

TBD.

StopListening Method (BLEServer Component)

TBD.

Syntax

procedure StopListening(ServiceId: String);

Remarks

TBD.

AdvertisementStatusChanged Event (BLEServer Component)

TBD.

Syntax

type TAdvertisementStatusChangedEvent = procedure (
  Sender: TObject;
  Status: Integer;
  Error: Integer
) of Object;

property OnAdvertisementStatusChanged: TAdvertisementStatusChangedEvent read FOnAdvertisementStatusChanged write FOnAdvertisementStatusChanged;

Remarks

TBD.

Connected Event (BLEServer Component)

TBD.

Syntax

type TConnectedEvent = procedure (
  Sender: TObject;
  const ClientId: String;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;

Remarks

TBD.

Disconnected Event (BLEServer Component)

TBD.

Syntax

type TDisconnectedEvent = procedure (
  Sender: TObject;
  const ClientId: String;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;

Remarks

TBD.

Error Event (BLEServer Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 Component)

Fires once for each log message.

Syntax

type TLogEvent = procedure (
  Sender: TObject;
  LogLevel: Integer;
  const Message: String;
  const LogType: String
) of Object;

property OnLog: TLogEvent read FOnLog write FOnLog;

Remarks

This events fires once for each log message generated by the component. 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 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.

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 component operations.

ReadRequested Event (BLEServer Component)

TBD.

Syntax

type TReadRequestedEvent = procedure (
  Sender: TObject;
  const ClientId: String;
  const ServiceId: String;
  const CharacteristicId: String;
  var ResponseValue: String;
  var Accept: Boolean
) of Object;

property OnReadRequested: TReadRequestedEvent read FOnReadRequested write FOnReadRequested;

Remarks

TBD.

SessionStatusChanged Event (BLEServer Component)

TBD.

Syntax

type TSessionStatusChangedEvent = procedure (
  Sender: TObject;
  const ClientId: String;
  Status: Integer;
  Error: Integer
) of Object;

property OnSessionStatusChanged: TSessionStatusChangedEvent read FOnSessionStatusChanged write FOnSessionStatusChanged;

Remarks

TBD.

SubscriptionChanged Event (BLEServer Component)

TBD.

Syntax

type TSubscriptionChangedEvent = procedure (
  Sender: TObject;
  const ServiceId: String;
  const CharacteristicId: String;
  IsSubscribed: Boolean
) of Object;

property OnSubscriptionChanged: TSubscriptionChangedEvent read FOnSubscriptionChanged write FOnSubscriptionChanged;

Remarks

TBD.

WriteRequested Event (BLEServer Component)

TBD.

Syntax

type TWriteRequestedEvent = procedure (
  Sender: TObject;
  const ClientId: String;
  const ServiceId: String;
  const CharacteristicId: String;
  const Value: String;
  const ValueB: TBytes;
  WithResponse: Boolean;
  var Accept: Boolean
) of Object;

property OnWriteRequested: TWriteRequestedEvent read FOnWriteRequested write FOnWriteRequested;

Remarks

TBD.

Config Settings (BLEServer Component)

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.

BLEServer Config Settings

Base Config Settings

Trappable Errors (BLEServer Component)

BLEServer Errors