Referensi API JavaScript WindVane untuk Bluetooth-SuperApp-Alibaba Cloud - SuperApp

Dokumen ini merupakan Referensi API untuk kelas JavaScript WVBluetooth. Gunakan API ini untuk mengembangkan aplikasi HTML5 atau Miniapp. Kemampuan yang tersedia mencakup permintaan izin Bluetooth, pemindaian perangkat BLE, koneksi ke perangkat Bluetooth, dan penemuan layanan perangkat.

WVBluetooth.requestAuthorization

Meminta izin Bluetooth yang diperlukan dan mengaktifkan Bluetooth.

Parameter input

Tidak ada.

Parameter callback

Parameter callback sukses:

[object] value: Objek JSON yang berisi pasangan kunci-nilai berikut:
- [string] state: Mengembalikan 'poweredOn'.

Parameter callback gagal:

[string] msg: Pesan error.

window.WindVane.call('WVBluetooth', 'requestAuthorization', {}, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVBluetooth.scan

Memindai perangkat BLE.

Parameter input

Tidak ada.

Parameter callback

Parameter callback sukses:

Tidak ada.

Parameter callback gagal:

[string] msg: Pesan error.

Pendengaran event

WV.Event.WVBluetooth.discoverDevice: Temukan perangkat BLE

Parameter event:

[string] name: Nama perangkat Bluetooth.
[string] deviceId: Alamat Bluetooth perangkat.

document.addEventListener('WV.Event.WVBluetooth.discoverDevice', function (e) {
        alert('event discoverDevice: ' + JSON.stringify(e.param));
});

window.WindVane.call('WVBluetooth', 'scan', {}, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.stopScan

Menghentikan pemindaian perangkat BLE.

Parameter input

Tidak ada.

Parameter callback

Parameter callback sukses:

Tidak ada.

Parameter callback kegagalan:

[string] msg: Pesan error.

window.WindVane.call('WVBluetooth', 'stopScan', {}, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.connect

Menghubungkan ke perangkat Bluetooth berdasarkan alamatnya.

Parameter Input

[string] deviceId: Alamat Bluetooth perangkat.

Parameter callback

Parameter callback sukses:

Tidak ada.

Parameter callback kegagalan:

[string] msg: Pesan error.

var params = {
  deviceId: '00:aa:bb:cc:dd'
};

window.WindVane.call('WVBluetooth', 'connect', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.disconnect

Memutus koneksi dari perangkat Bluetooth yang terhubung.

Parameter input

Tidak ada.

Parameter callback

Parameter callback sukses:

Tidak ada.

Parameter callback gagal:

[string] msg: Pesan error.

Event Listening

WV.Event.WVBluetooth.GATTServerDisconnected: Koneksi Bluetooth terputus

document.addEventListener('WV.Event.WVBluetooth.GATTServerDisconnected', function (e) {
        alert('event GATTServerDisconnected: ' + JSON.stringify(e.param));
});
window.WindVane.call('WVBluetooth', 'disconnect', {}, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.getServices

Memulai penemuan layanan pada perangkat BLE.

Parameter input

[string] deviceId: Alamat Bluetooth perangkat.

Catatan

Anda harus terhubung ke perangkat sebelum memanggil metode ini.

Parameter callback

Parameter callback sukses:

[boolean] started: true jika penemuan layanan berhasil dimulai; false jika tidak.

Parameter callback kegagalan:

[string] msg: Pesan error.

var params = {
  deviceId: '00:aa:bb:cc:dd'
};
window.WindVane.call('WVBluetooth', 'getServices', params, function(e) {
  			alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.getCharacteristics

Mengambil semua characteristic untuk layanan tertentu pada perangkat BLE.

Parameter input

[string] deviceId: Alamat Bluetooth perangkat.
Catatan
Anda harus terhubung ke perangkat sebelum memanggil metode ini.
[string] serviceId: ID layanan, dalam format UUID.

Parameter callback

Parameter callback sukses:

[object] characteristics: Array objek characteristic, masing-masing memiliki parameter berikut:
- [string] characteristicId: ID characteristic, dalam format UUID.

Parameter callback kegagalan:

[string] msg: Pesan error.

var params = {
  deviceId: '00:aa:bb:cc:dd',
  serviceId: 'xxxx'
};
window.WindVane.call('WVBluetooth', 'getCharacteristics', params, function(e) {
  			alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.writeValue

Menulis nilai ke characteristic tertentu dari perangkat BLE yang terhubung.

Parameter input

[string] deviceId: Alamat Bluetooth perangkat yang terhubung.
[string] serviceId: ID layanan, dalam format UUID.
[string] characteristicId: ID characteristic, dalam format UUID.
[string] value: Nilai yang akan ditulis.
Catatan
Nilai tersebut harus berupa string yang di-encode Base64.

Parameter callback

Parameter callback sukses:

Tidak ada.

Parameter callback gagal:

[string] msg: Pesan error.

Event Listening

WV.Event.WVBluetooth.characteristicValueChanged: Nilai characteristic berubah (memerlukan startNotifications)

document.addEventListener('WV.Event.WVBluetooth.characteristicValueChanged', function (e) {
        alert('event characteristicValueChanged: ' + JSON.stringify(e.param));
});
var params = {
  deviceId: '00:aa:bb:cc:dd',
  serviceId: 'xxxx',
  characteristicId: 'xxx',
  value: 'xxx'
};
window.WindVane.call('WVBluetooth', 'writeValue', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.readValue

Membaca nilai characteristic tertentu dari perangkat BLE yang terhubung.

Parameter input

[string] deviceId: Alamat Bluetooth perangkat.
Catatan
Anda harus terhubung ke perangkat sebelum memanggil metode ini.
[string] serviceId: ID layanan, dalam format UUID.
[string] characteristicId: ID characteristic, dalam format UUID.

Parameter callback

Parameter callback sukses:

Objek yang berisi nilai characteristic, berupa string yang di-encode Base64.

Parameter callback kegagalan:

[string] msg: Pesan error.

var params = {
  deviceId: '00:aa:bb:cc:dd',
  serviceId: 'xxxx',
  characteristicId: 'xxx'
};
window.WindVane.call('WVBluetooth', 'readValue', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.startNotifications

Mengaktifkan notifikasi perubahan nilai characteristic.

Parameter input

[string] deviceId: Alamat Bluetooth perangkat.
Catatan
Anda harus terhubung ke perangkat sebelum memanggil metode ini.
[string] serviceId: ID layanan, dalam format UUID.
[string] characteristicId: ID characteristic, dalam format UUID.

Parameter callback

Parameter callback sukses:

Tidak ada.

Parameter callback gagal:

[string] msg: Pesan error.

var params = {
  deviceId: '00:aa:bb:cc:dd',
  serviceId: 'xxxx',
  characteristicId: 'xxx'
};
window.WindVane.call('WVBluetooth', 'startNotifications', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}

WVBluetooth.stopNotifications

Menonaktifkan notifikasi perubahan nilai characteristic.

Parameter input

[string] deviceId: Alamat Bluetooth perangkat.
Catatan
Anda harus terhubung ke perangkat sebelum memanggil metode ini.
[string] serviceId: ID layanan, dalam format UUID.
[string] characteristicId: ID characteristic, dalam format UUID.

Parameter callback

Parameter callback sukses:

Tidak ada.

Parameter callback gagal:

[string] msg: Pesan error.

var params = {
  deviceId: '00:aa:bb:cc:dd',
  serviceId: 'xxxx',
  characteristicId: 'xxx'
};
window.WindVane.call('WVBluetooth', 'stopNotifications', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
}