Class BleCharacteristic

Hierarchy

Constructors

constructor

Properties

onreadfromremote? onwritefromremote? service uuid

Accessors

descriptors

Methods

addDescriptor addProperty getDescriptor notify readWait removeProperty writeWait

Constructors

constructor

  • Create Characteristics

    await obniz.ble.initWait();
    var characteristic = new obniz.ble.characteristic({
         "uuid" : "FFF1",
         "properties" : ["read","write"],  // read, write, notify
         "data" : [0x0e, 0x00, ...],     //data for dataArray or  text for string
         "descriptors" : [{
             "uuid" : "2901",   //Characteristic User Description
             "text" : "hello world characteristic",    //data for dataArray or  text for string
         }]
    });

    var service = new obniz.ble.service({
                   "uuid" : "fff0",
                   "characteristics" : [ characteristic ]
    });
    obniz.ble.peripheral.addService(service);

    Parameters

    Returns BleCharacteristic

Properties

Optional onreadfromremote

onreadfromremote?: ((address) => void)

Type declaration

    • (address): void

    • This is a callback function used when characteristic is read by an external device.

      characteristic.onreadfromremote = function(address){
        console.log("remote address :",address);
      }

      Parameters

      • address: string

      Returns void

Optional onwritefromremote

onwritefromremote?: ((address, data) => void)

Type declaration

    • (address, data): void

    • This is a callback function used when characteristic is read by an external device.

      characteristic.onwritefromremote = function(address, newvalue){
         console.log("remote address :",address);
         console.log("remote data :",newvalue);
      }

      Parameters

      • address: string
      • data: number[]

      Returns void

service

service: BleService

Service instance

uuid

uuid: string

It is uuid as string.

console.log(attr.uuid); // => '4C84'

Accessors

descriptors

Methods

addDescriptor

addProperty

getDescriptor

notify

  • This sends notify to the connected central.

    var characteristic = new obniz.ble.characteristic({
      uuid: 'FFF1',
      data: [0x0e, 0x00],
      properties : ["read","write","notify"],  // add notify properties
    });

     var service = new obniz.ble.service({
      uuid: 'FFF0',
      characteristics: [characteristic],
    });
    obniz.ble.peripheral.addService(service);


    // after central connected
    characteristic.notify();

    Returns void

readWait

removeProperty

writeWait

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc