• Public
  • Public/Protected
  • All

The BLE Component (Bluetooth Low Energy) enables Bluetooth to be used in a project.

var uComps = require('u-components');
var uActions = require('u-actions');
var Action = uActions.Action;
new Action('Bluetooth Demo', bluetoothDemo)
.addParameter('Bluetooth', uActions.ParamType.BLE)
function bluetoothDemo(comp) {
var bleComp = uComps.cast.toBle(comp);





alpha: number

The alpha transparency of the Component. Range from 0 to 100.

clippingType: ClippingType

Clip the components contents using one of the options in ClippingType.

components: ComponentList

Access this Component's sub-components.

formEnabled: boolean

Whether or not is component is enabled for the parent form. Only relevant when inside a Form Component.

formFieldName: string

Label used to identify the field this Component belongs to in a form. Only relevant when inside a Form Component.

height: number

The height of the Component.

Shape component to be used as a mask. Can be either a Rectangle or Circle Component.

name: string

Name of the component.

parent: Component

Access this Component's parent component.

passedFormValidation: boolean

Whether or not the Component has passed form validation. Only relevant when inside a Form Component.

type: string

Type of the component.

uniqueId: string

Unique ID of the component.

visible: boolean

Whether or not the Component is visible.

width: number

The width of the Component.

x: number

The x position of the Component relative to its parent.

y: number

The y position of the Component relative to its parent.


  • checkPermission(onGrantedCallback: string, onDeniedCallback: string, onBluetoothError: string): void
  • Check the user has granted permission to use Bluetooth on this device. If permission has not been granted, display the Bluetooth Permissions dialog.


    • onGrantedCallback: string

      function name to call if permission has been granted.

    • onDeniedCallback: string

      function name to call if permission has been denied.

    • onBluetoothError: string

      function name to call if an error occurs.

      var bleComp = uComps.cast.toBle(comp);
      bleComp.checkPermission("bleOnGrantedCallback", "bleOnDeniedCallback", "bleOnBluetoothError");

    Returns void

  • clearState(): void
  • Clear the Bluetooth functionality.

    var bleComp = uComps.cast.toBle(comp);

    Returns void

  • connectToDevice(deviceId: string): void
  • Connect to a Bluetooth device with a matching deviceId.


    • deviceId: string

      Id used to identify the Bluetooth device.

    Returns void

  • emit(eventType: string, data: Object): void
  • Call each callback that is registered for the given eventType, in the order they were registered, passing the supplied data to each.


    • eventType: string

      The type of the event to emit.

    • data: Object

      Data object to pass to each callback.

    Returns void

  • enableBluetooth(): void
  • Starts Bluetooth operations, without starting scanning.

    var bleComp = uComps.cast.toBle(comp);

    Returns void

  • focus(): void
  • Set the keyboard focus to this component.

    new uActions.Action('set focus', setFocus)
    .addParameter('text entry',uActions.ParamType.TEXT_ENTRY)
    function setFocus(textEntry) {

    Returns void

  • get(propertyName: string): any
  • Get a property by name.

    var uActions = require('u-actions');
    new uActions.Action('get fontsize',getFontSize).register();
    function getFontSize() {
    var text1=uPages.current.components.getText('Text 1');


    • propertyName: string

      The name of the property to get.

    Returns any

    Returned value can be of any type, or even null.

  • on(eventType: string, callback: Function): void
  • Adds the callback function to the end of the listeners array for eventType.


    • eventType: string

      The type of the event.

    • callback: Function

      The callback function

    Returns void

  • refresh(): void
  • Refresh this component to force it to be re-rendered, or for its dynamic data to be updated.

    Returns void

  • set(propertyName: string, value: any): void
  • set(data: Object): void
  • Set a properties value by name.

    var uActions = require('u-actions');
    new uActions.Action('set text color',setTextColor).register();
    function setTextColor() {
    uPages.get('follow').components.getText('Text 1').set('font_color','0x0000FFFF');


    • propertyName: string

      The name of the property to set.

    • value: any

      The value to set. Can be of any type.

    Returns void

  • Set a number properties at once.


    • data: Object

      Data object containing property name and value pairs to set on this component.

    Returns void

  • setCharcteristic(serviceId: string, characteristicId: string, valueAttribute: string): void
  • Changes a setting or parameter on a Bluetooth device.


    • serviceId: string

      A service can have one or more characteristics, and each service distinguishes itself from other services by means of a unique numeric ID called a UUID.

    • characteristicId: string

      A Characteristic encapsulates a single data point and distinguishes itself via a pre-defined 16-bit or 128-bit UUID.

    • valueAttribute: string

      Contains the actual user data that the client can read from and write to for practical information exchanges.

    Returns void

  • setFrequency(frequency: number): void
  • Starts scanning for beacons.


    • frequency: number

      in milliseconds.

      var bleComp = uComps.cast.toBle(comp);

    Returns void

  • tween(seconds: number, params: Object, type?: TweenType): void
  • Tween a component property over time.


    • seconds: number

      The number of seconds to tween for.

    • params: Object

      An objects that contains key/value pairs of the properties and values to tween.

    • Optional type: TweenType

      (Optional) Tween type can be any type from "Tween.type"

    Returns void