The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:

• Android
• iOS
• default
• unknown

Whether the current device supports the extensions functionality

The native version string of the native extension.

The singleton instance of the Bluetooth class.

The version of this extension.

This should be of the format, MAJOR.MINOR.BUILD

Constructor You should not call this directly, but instead use the singleton access

Cancels the scan for discoverable devices

Close a listening connection with the specified uuid.

Parameters

Close all listening connections and all device connections. This effectively stops all bluetooth communications.

Connect to a device. You should listen for connection events to determine the outcome of the connect call. This forms the 'client' part of the bluetooth connection.

Parameters

See also

Disable the bluetooth adapter

Disconnect from a connection

Parameters

Disposes the extension and releases any allocated resources. Once this function has been called, a call to init is neccesary again before any of the extensions functionality will work.

Enable the bluetooth adapter.

Note: You must display some user interface to allow them the choice to enable bluetooth. It is against application guidelines not to give the user a choice. You can use the enableWithUI function to provide you a default UI for this.

See also

Displays a dialog to ask the user to enable bluetooth on the device. You should check the supported and enabled states of the bluetooth before calling this function to decide if the call is neccessary.

See also

Retrieves the devices that have been paired with this device.

See also

Retrieve the current scan mode of the bluetooth adapter

See also

Retrieve the current state of the bluetooth adapter. See the STATE_strings in the BleutoothDevice class for the available states.

See also

Initialises the extension class for use with the provided key.

Parameters

Check if the device is discoverable. This is very similar to checking if the scan mode is SCAN_MODE_CONNECTABLE_DISCOVERABLE.

See also

Whether the bluetooth device is enabled i.e. turned on and ready for use.

Start a listening connection to receive a connection from a client device. This forms the 'server' component to the connect command. A 'server' uses listen while a 'client' uses connect.

Both the client and server must use the same uuid and secure properties in setting up the connection.

Parameters

See also

When data has been received you'll receive a CONNECTION_RECEIVED_BYTES event from the extension. You will then be able to read bytes from that connection using this function. The event will contain the uuid of the connection that received the data.

Parameters

See also

Sets the device to be discoverable to other devices for a specified amount of time.

Parameters

Displays the bluetooth settings panel to the user.

This function will start the scan (discovery) process to find available devices. The process usually involves an inquiry scan of about 12 seconds, followed by a page scan of each found device to retrieve its Bluetooth name.

Performing device discovery is a heavy procedure for the Bluetooth adapter and will consume a lot of its resources. Once you have found a device to connect, be certain that you always stop discovery with #cancelScan() before attempting a connection.

Also, if you already hold a connection with a device, then performing discovery can significantly reduce the bandwidth available for the connection, so you should not perform discovery while connected.

See also

Write data to the open connection.

The data can be any valid byte array data.

The connection must have previously been successfully connected using the listen/connect functionality.

Parameters

See also

This simple example shows how to initialise the extension and enable the bluetooth adapater.

     ...
     
     Bluetooth.init( DEV_KEY );
     Bluetooth.service.addEventListener( BluetoothEvent.STATE_CHANGED, bluetooth_stateChangedHandler, false, 0, true );
     
     if (!Bluetooth.service.isEnabled())
         Bluetooth.service.enableWithUI();
     
     ...
     
     
     private function bluetooth_stateChangedHandler( event:BluetoothEvent ):void
     {
         trace( "state changed:: "+event.data );
     }
     

Retrieve the list of paired devices

     Bluetooth.init( DEV_KEY );
     var pairedDevices:Vector.<BluetoothDevice> = Bluetooth.service.getPairedDevices();
     if (pairedDevices.length == 0) 
     {
         trace( "No paired devices" );
     }
     else
     {
         for each (var device:BluetoothDevice in pairedDevices)
         {
             trace( "Device: " + device.deviceName + "::"+device.address );
             if (device.bluetoothClass != null)
                 trace( "  Class: " + device.bluetoothClass.deviceClass +"::"+device.bluetoothClass.majorDeviceClass );
         }
     }
     

Make the bluetooth device discoverable for 30 seconds

     Bluetooth.init( DEV_KEY );
     Bluetooth.service.setDeviceDiscoverable( true, 30 );
     

Scan for available bluetooth devices

     Bluetooth.init( DEV_KEY );
     Bluetooth.service.addEventListener( BluetoothDeviceEvent.DEVICE_FOUND, bluetooth_deviceFoundHandler, false, 0, true );
     
     if (Bluetooth.service.isEnabled())
     {
         Bluetooth.service.startScan();
     }
     ...
     
     private function bluetooth_deviceFoundHandler( event:BluetoothDeviceEvent ):void
     {
         trace( "device found:: '"+ event.device.deviceName + "' :: "+event.device.address );
         if (event.device.bluetoothClass != null)
             trace( "  Class: " + event.device.bluetoothClass.deviceClass + "::" + event.device.bluetoothClass.majorDeviceClass );
     }
     

This example shows how to create a connection between two devices. The server or listener makes itself discoverable and then waits for a connection. Once a connection is received the server then sends a small string to the client. The client scans for available devices and when found, attempts to connect to the device.

Note: This example does not show any error handling which you should use in a real application.

     // Server/Listener Device
     
     private static var UUID    : String = "00000000-DDDD-1111-0000-000000000000";
     
     public function setupBluetooth():void
     {
         Bluetooth.init( DEV_KEY );
         Bluetooth.service.addEventListener( BluetoothConnectionEvent.CONNECTION_REMOTE, bluetooth_remoteConnectionHandler, false, 0, true );
     
         Bluetooth.service.setDeviceDiscoverable();
         var listenResult:Boolean = Bluetooth.service.listen( UUID );
     }
     
     private function bluetooth_remoteConnectionHandler( event:BluetoothConnectionEvent ):void
     {
         var data:ByteArray = new ByteArray();
         data.writeUTF( "thanks for connecting to me" );
         var success:Boolean = Bluetooth.service.writeBytes( event.uuid, data );
         trace( "send to client: success="+success );
     }
     
     

     // Client
     
     private static var UUID    : String = "00000000-DDDD-1111-0000-000000000000";
     
     public function connectToServer():void
     {
         Bluetooth.init( DEV_KEY );
         Bluetooth.service.addEventListener( BluetoothDeviceEvent.DEVICE_FOUND, bluetooth_deviceFoundHandler, false, 0, true );
         Bluetooth.service.addEventListener( BluetoothConnectionEvent.CONNECTION_RECEIVED_BYTES, bluetooth_receivedBytesHandler, false, 0, true );
     
         Bluetooth.service.startScan();
     }
     
     
     private function bluetooth_deviceFoundHandler( event:BluetoothDeviceEvent ):void
     {
         Bluetooth.service.connect( event.device, UUID );
     }
     
     
     private function bluetooth_receivedBytesHandler( event:BluetoothConnectionEvent ):void
     {
         var read:ByteArray = Bluetooth.service.readBytes( event.uuid );
         if (read == null)
         {
             trace( "error reading data?" );
         }
         else
         {
             trace( "READ: " + read.readUTF() );
         }
     }