appcelerator.bluetooth

For example "00:11:22:AA:BB:CC". This method will only return valid address if the android API < 23. Otherwise, it will return a constant value of 02:00:00:00:00:00.

This name is visible to remote Bluetooth devices. In case of error it can be null.

This value indicates that inquiry scan is disabled, but page scan is enabled on the local Bluetooth adapter. Therefore this device is not discoverable from remote Bluetooth devices, but is connectable from remote Bluetooth devices that have previously discovered this devices.

This value indicates that both inquiry scan and page scan are enabled on the local Bluetooth adapter. Therefore this device is both discoverable and connectable from remote Bluetooth devices.

This value indicated that both inquiry and page scan is disabled on the local Bluetooth adapter. Therefore this device neither discoverable nor connectable from the remote Bluetooth devices.

The Bluetooth scan mode determines if the local adapter is connectable and/or discoverable from remote Bluetooth devices. Possible values are SCAN_MODE_CONNECTABLE, SCAN_MODE_CONNECTABLE_DISCOVERABLE and SCAN_MODE_NONE. If Bluetooth state is not STATE_ON, this API will return SCAN_MODE_NONE. After turning the Bluetooth on, wait for the stateChanged event with STATE_ON to get the updated value. If Bluetooth is not supported on the device, this property returns an error number which is different from the possible values.

Possible values are STATE_OFF, STATE_ON, STATE_TURNING_OFF, STATE_TURNING_ON If Bluetooth is not supported on the device, this property returns an error number which is different from the possible values.

Listen for the stateChanged event to be notified when the local Bluetooth adapter is off.

Listen for the stateChanged event to be notified when the local Bluetooth adapter is on.

Listen for the stateChanged event to be notified when the local Bluetooth adapter is turning off.

Listen for the stateChanged event to be notified when the local Bluetooth adapter is turning on.

As discovery is a heavyweight procedure for the Bluetooth adapter, this method should always be called before attempting to connect to a remote device via connect. Discovery is run as a system service, so an application should always call cancel discovery even if it did not directly request a discovery, just to be sure. If Bluetooth state is not STATE_ON or if there is no ongoing discovery process this function will return false. Listen for the discoveryFinished event to be notified when the device discovery process finished.

This method, when called, creates an object of BluetoothServerSocket which can be used to listen for the incoming connection and accept it by calling the startAccept method. This method returns null, if Bluetooth is not supported on the device.

Listen for the stateChanged event to be notified when the local Bluetooth adapter is turning off.

Listen for the stateChanged event to be notified when the local Bluetooth adapter is turning on.

Displays a system activity that asks the user for permission to make the local device discoverable by other devices, and to turn on Bluetooth if it is not currently enabled. Change the scan mode to SCAN_MODE_CONNECTABLE_DISCOVERABLE. By default, the device becomes discoverable for 300 seconds, or 5 minutes. You can define a different duration, up to 3600 seconds or 1 hour.

Returns the PairedDevicesType. In this if the paired devices are successfully fetched then the success will be true and can get array of paired devices with the pairedDevices. If it is false then we can get description of it via message If there's any issue fetching paired device, or if there no paired devices then this methods return false. Refer message for detailed reason of failure.

If Bluetooth is not supported on the device, this method return null.

Device discovery is a heavyweight procedure. New connections to remote Bluetooth devices should not be attempted while discovery is in progress, and existing connections will experience limited bandwidth and high latency. Use cancelDiscovery to cancel an ongoing discovery. If Bluetooth is not supported on the device or Bluetooth state is not STATE_ON this function will return false.

If Bluetooth is not supported on the device, this method will return false.

Checks if the following permissions are defined and have been granted by the user:

• android.permission.ACCESS_FINE_LOCATION
• android.permission.BLUETOOTH
• android.permission.BLUETOOTH_ADMIN
• android.permission.BLUETOOTH_ADVERTISE
• android.permission.BLUETOOTH_CONNECT
• android.permission.BLUETOOTH_SCAN

If this method returns false, then you should call the requestPermissions method to display a dialog requesting permissions from the user.

Displays a dialog requesting the user for the ACCESS_FINE_LOCATION permission. This permission is required by the startDiscovery method. The dialog will not be dispayed if permission has already been granted.

The given optional callback argument and returned Promise will provide a success property indicating if permission was granted or not.

Displays a dialog requesting the user for the ACCESS_FINE_LOCATION permission. Will also request the BLUETOOTH_ADVERTISE, BLUETOOTH_CONNECT, and BLUETOOTH_SCAN permissions if running on Android 12 or higher. These permission are required by this module to discover devices and to make the app's device discoverable by other devices.

The given optional callback argument and returned Promise will provide a success property indicating if permissions were granted or not.

The Bluetooth adapter must be turned on before you can set the name. After turning the Bluetooth on, wait for the stateChanged event with STATE_ON to get the updated value.

This method starts the discovery for the nearby Bluetooth devices. The process of the discovery takes upto 12 seconds.This is an asynchronous call, it will return immediately. Register for discoveryStarted and discoveryFinished events to determine exactly when discovery starts and completes. Register for deviceFound event to be notified when a nearby device is found. From API level 29 and above make sure that the location services is on in the device to start the scanning process. Device discovery will only find remote devices that are currently in discoverable mode. Many Bluetooth devices are not discoverable by default, and need to be entered into a discoverable mode. This method may return same device multiple times from the deviceFound event in span of 12 seconds. If Bluetooth state is not STATE_ON or the required permission not granted than this function will return false.

This event may get called several times for the same Bluetooth device in the range. For not listing the same Bluetooth device many times, one should add a check before adding it to the list. You can do following to avoid the above.

// Extract the device from this event properties.
  var device = e.device;
  var numRows = btDevicesListSection.rowCount; // count the number of rows in the section where rows are added.
  if(numRows > 0)
  {
    var rowArray = btDevicesListSection.rows; // Extract all the rows into an array.
    for(var i =0; i< numRows; i++)
    {
      //Check if the already added row with the id is same as newly found device.
      // The id is the property of the row. You should add device address into it.
      if(rowarray[i].id == device.address) 
      {
        //update the device info. Some devices might get updated and changed the friendly name.
        return;
      }
    }
  }          

Most possible reason for this event to occur is either bluetooth is turning on or off.

This property returns the Bluetooth hardware address as string. For example, "00:11:22:AA:BB:CC".

This property returns the Bluetooth name or null if there was a problem.

Possible values are DEVICE_TYPE_UNKNOWN, DEVICE_TYPE_CLASSIC, DEVICE_TYPE_DUAL and DEVICE_TYPE_LE.

This property does not start a service discovery procedure to retrieve the UUIDs from the remote device. Rather, the local cached copy of the service UUIDs are returned. Can be null on error.

This method, when called, creates an RFCOMM Bluetooth socket ready to start an outgoing connection to the remote device using SDP lookup of UUID.

The outcome of the discovery is reported via the fetchedUUIDs event.

This method, when called, closes the server socket. One cannot start accepting connections again after calling this method. On error, this method will throw an exception.

This method, when called, starts listening for the incoming Bluetooth connections and block until a connection is established. Listen for the connectionReceived event to be notified when a connection is received or the error event when an error occured during accepting connection.

This method, when called stop accepting incoming connections. One can again start accepting connections via startAccept method after calling this method. On error, this method will throw an exception.

If there is no connection attempt in progress, it does nothing.

Listen for the disconnected event to be notified when socket is closed or the error in case of failure.

This call will block until a connection is established or the connection fails. Listen for the connected event to be notified when the connection is established.

You can set the read buffer size at any time, but it will only take effect during the next connection. By default, the buffer size is 4*1024 bytes.

If the socket is not connected, then this method will throw an error.