BLEServer Module

Properties   Methods   Events   Config Settings   Errors  

TBD.

Syntax

IPWorksBLE.BLEServer

Remarks

TBD.

Property List

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

Method List

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

Event List

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

Config Settings

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

Listening Property (BLEServer Module)

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

Syntax

• Swift
• Objective-C

public var listening: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=listening) BOOL listening;

- (BOOL)listening;

Default Value

False

Remarks

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setListening(listening: Bool) throws

ServerId Property (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

public var serverId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=serverId,setter=setServerId:) NSString* serverId;

- (NSString*)serverId;
- (void)setServerId :(NSString*)newServerId;

Default Value

""

Remarks

TBD.

AddCharacteristic Method (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

public func addCharacteristic(serviceId: String, characteristicId: String, props: Int32) throws -> Void

- (void)addCharacteristic:(NSString*)serviceId :(NSString*)characteristicId :(int)props;

Remarks

TBD.

Config Method (BLEServer Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

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

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

This method processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

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

StartListening Method (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

public func startListening(serviceId: String) throws -> Void

- (void)startListening:(NSString*)serviceId;

Remarks

TBD.

StopListening Method (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

public func stopListening(serviceId: String) throws -> Void

- (void)stopListening:(NSString*)serviceId;

Remarks

TBD.

AdvertisementStatusChanged Event (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

func onAdvertisementStatusChanged(status: Int32, error: Int32)

- (void)onAdvertisementStatusChanged:(int)status :(int)error;

Remarks

TBD.

Connected Event (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

func onConnected(clientId: String, statusCode: Int32, description: String)

- (void)onConnected:(NSString*)clientId :(int)statusCode :(NSString*)description;

Remarks

TBD.

Disconnected Event (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

func onDisconnected(clientId: String, statusCode: Int32, description: String)

- (void)onDisconnected:(NSString*)clientId :(int)statusCode :(NSString*)description;

Remarks

TBD.

Error Event (BLEServer Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

Fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

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

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

ReadRequested Event (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

func onReadRequested(clientId: String, serviceId: String, characteristicId: String, responseValue: inout String, accept: inout Bool)

- (void)onReadRequested:(NSString*)clientId :(NSString*)serviceId :(NSString*)characteristicId :(NSString**)responseValue :(int*)accept;

Remarks

TBD.

SessionStatusChanged Event (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

func onSessionStatusChanged(clientId: String, status: Int32, error: Int32)

- (void)onSessionStatusChanged:(NSString*)clientId :(int)status :(int)error;

Remarks

TBD.

SubscriptionChanged Event (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

func onSubscriptionChanged(serviceId: String, characteristicId: String, isSubscribed: Bool)

- (void)onSubscriptionChanged:(NSString*)serviceId :(NSString*)characteristicId :(BOOL)isSubscribed;

Remarks

TBD.

WriteRequested Event (BLEServer Module)

TBD.

Syntax

• Swift
• Objective-C

func onWriteRequested(clientId: String, serviceId: String, characteristicId: String, value: Data, withResponse: Bool, accept: inout Bool)

- (void)onWriteRequested:(NSString*)clientId :(NSString*)serviceId :(NSString*)characteristicId :(NSData*)value :(BOOL)withResponse :(int*)accept;

Remarks

TBD.

Config Settings (BLEServer Module)

BLEServer Config Settings

Base Config Settings

Trappable Errors (BLEServer Module)

BLEServer Errors