wechat/device · weapp

ble_peripheral_server_add_service

pub fn ble_peripheral_server_add_service(
  server: BLEPeripheralServer,
  service s: object.JsObject,
) -> Nil

BLEPeripheralServer.addService Add service

ble_peripheral_server_close

</>

pub fn ble_peripheral_server_close(
  server: BLEPeripheralServer,
) -> Nil

BLEPeripheralServer.close Close server

ble_peripheral_server_off_characteristic_read_request

</>

pub fn ble_peripheral_server_off_characteristic_read_request(
  server: BLEPeripheralServer,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

BLEPeripheralServer.offCharacteristicReadRequest Remove characteristic read request listener

ble_peripheral_server_off_characteristic_subscribed

</>

pub fn ble_peripheral_server_off_characteristic_subscribed(
  server: BLEPeripheralServer,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

BLEPeripheralServer.offCharacteristicSubscribed Remove characteristic subscribed listener

ble_peripheral_server_off_characteristic_unsubscribed

</>

pub fn ble_peripheral_server_off_characteristic_unsubscribed(
  server: BLEPeripheralServer,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

BLEPeripheralServer.offCharacteristicUnsubscribed Remove characteristic unsubscribed listener

ble_peripheral_server_off_characteristic_write_request

</>

pub fn ble_peripheral_server_off_characteristic_write_request(
  server: BLEPeripheralServer,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

BLEPeripheralServer.offCharacteristicWriteRequest Remove characteristic write request listener

ble_peripheral_server_on_characteristic_read_request

</>

pub fn ble_peripheral_server_on_characteristic_read_request(
  server: BLEPeripheralServer,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

BLEPeripheralServer.onCharacteristicReadRequest Listen for characteristic read request

ble_peripheral_server_on_characteristic_subscribed

</>

pub fn ble_peripheral_server_on_characteristic_subscribed(
  server: BLEPeripheralServer,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

BLEPeripheralServer.onCharacteristicSubscribed Listen for characteristic subscribed

ble_peripheral_server_on_characteristic_unsubscribed

</>

pub fn ble_peripheral_server_on_characteristic_unsubscribed(
  server: BLEPeripheralServer,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

BLEPeripheralServer.onCharacteristicUnsubscribed Listen for characteristic unsubscribed

ble_peripheral_server_on_characteristic_write_request

</>

pub fn ble_peripheral_server_on_characteristic_write_request(
  server: BLEPeripheralServer,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

BLEPeripheralServer.onCharacteristicWriteRequest Listen for characteristic write request

ble_peripheral_server_remove_service

</>

pub fn ble_peripheral_server_remove_service(
  server: BLEPeripheralServer,
  service s: object.JsObject,
) -> Nil

BLEPeripheralServer.removeService Remove service

ble_peripheral_server_start_advertising

</>

pub fn ble_peripheral_server_start_advertising(
  server: BLEPeripheralServer,
) -> Nil

BLEPeripheralServer.startAdvertising Start advertising

ble_peripheral_server_stop_advertising

</>

pub fn ble_peripheral_server_stop_advertising(
  server: BLEPeripheralServer,
) -> Nil

BLEPeripheralServer.stopAdvertising Stop advertising

ble_peripheral_server_write_characteristic_value

</>

pub fn ble_peripheral_server_write_characteristic_value(
  server: BLEPeripheralServer,
  data d: object.JsObject,
) -> Nil

BLEPeripheralServer.writeCharacteristicValue Write characteristic value

check_is_open_accessibility

</>

pub fn check_is_open_accessibility() -> Bool

Phase 13: Device Advanced - Accessibility

wx.checkIsOpenAccessibility Check if accessibility is enabled on the device

close_ble_connection

</>

pub fn close_ble_connection(
  device_id d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.closeBLEConnection Disconnect from BLE peripheral

close_bluetooth_adapter

</>

pub fn close_bluetooth_adapter(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.closeBluetoothAdapter Close Bluetooth adapter

connect_wifi

</>

pub fn connect_wifi(
  ssid s: String,
  bssid b: String,
  password p: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Phase 13: Device Advanced - WiFi

wx.connectWifi Connect to a WiFi network

create_ble_connection

</>

pub fn create_ble_connection(
  device_id d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.createBLEConnection Connect to BLE peripheral

create_ble_peripheral_server

</>

pub fn create_ble_peripheral_server(
  options o: object.JsObject,
) -> BLEPeripheralServer

wx.createBLEPeripheralServer Create BLE peripheral server

get_battery_info_sync

</>

pub fn get_battery_info_sync() -> object.JsObject

Phase 13: Device Advanced - Battery

wx.getBatteryInfoSync Synchronously get battery information

get_beacons

</>

pub fn get_beacons(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getBeacons Get all discovered Beacon devices

get_ble_device_characteristics

</>

pub fn get_ble_device_characteristics(
  device_id d: String,
  service_id s: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getBLEDeviceCharacteristics Get characteristic values of specified service

get_ble_device_rssi

</>

pub fn get_ble_device_rssi(
  device_id d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getBLEDeviceRSSI Get BLE device RSSI (signal strength)

get_ble_device_services

</>

pub fn get_ble_device_services(
  device_id d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getBLEDeviceServices Get services of BLE device

get_ble_mtu

</>

pub fn get_ble_mtu(
  device_id d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getBLEMTU Get current BLE MTU size for a connection

get_bluetooth_adapter_state

</>

pub fn get_bluetooth_adapter_state(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getBluetoothAdapterState Get Bluetooth adapter state

get_bluetooth_devices

</>

pub fn get_bluetooth_devices(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getBluetoothDevices Get all discovered devices

get_connected_bluetooth_devices

</>

pub fn get_connected_bluetooth_devices(
  services s: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getConnectedBluetoothDevices Get devices connected according to UUID

get_nfc_adapter

</>

pub fn get_nfc_adapter() -> object.JsObject

Near Field Communication (NFC)

wx.getNFCAdapter Get NFC adapter

is_bluetooth_device_paired

</>

pub fn is_bluetooth_device_paired(
  device_id d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.isBluetoothDevicePaired Check if a Bluetooth device is paired

make_bluetooth_pair

</>

pub fn make_bluetooth_pair(
  device_id d: String,
  pin p: String,
  timeout t: Int,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Phase 12: Bluetooth Advanced

wx.makeBluetoothPair Initiate Bluetooth pairing with a device

nfc_adapter_off_discovered

</>

pub fn nfc_adapter_off_discovered(
  adapter: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

NfcAdapter.offDiscovered Cancel listening for discovered NFC tags

nfc_adapter_on_discovered

</>

pub fn nfc_adapter_on_discovered(
  adapter: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

NfcAdapter.onDiscovered Listen for discovered NFC tags

nfc_adapter_start_discovery

</>

pub fn nfc_adapter_start_discovery(
  adapter: object.JsObject,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

NfcAdapter.startDiscovery Start searching for NFC tags

nfc_adapter_stop_discovery

</>

pub fn nfc_adapter_stop_discovery(
  adapter: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

NfcAdapter.stopDiscovery Stop searching for NFC tags

notify_ble_characteristic_value_change

</>

pub fn notify_ble_characteristic_value_change(
  device_id d: String,
  service_id s: String,
  characteristic_id c: String,
  state s2: Bool,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.notifyBLECharacteristicValueChange Enable notifications for characteristic value changes

off_accelerometer_change

</>

pub fn off_accelerometer_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offAccelerometerChange Remove accelerometer change listener

off_beacon_service_change

</>

pub fn off_beacon_service_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offBeaconServiceChange Remove Beacon service state change event listener

off_beacon_update

</>

pub fn off_beacon_update(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offBeaconUpdate Remove Beacon device update event listener

off_ble_characteristic_value_change

</>

pub fn off_ble_characteristic_value_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offBLECharacteristicValueChange Cancel listening for characteristic value change

off_ble_connection_state_change

</>

pub fn off_ble_connection_state_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offBLEConnectionStateChange Cancel listening for BLE connection state change

off_ble_mtu_change

</>

pub fn off_ble_mtu_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offBLEMTUChange Remove BLE MTU change event listener

off_ble_peripheral_connection_state_changed

</>

pub fn off_ble_peripheral_connection_state_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offBLEPeripheralConnectionStateChanged Remove BLE peripheral connection state change listener

off_bluetooth_adapter_state_change

</>

pub fn off_bluetooth_adapter_state_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offBluetoothAdapterStateChange Cancel listening for Bluetooth adapter state change

off_bluetooth_device_found

</>

pub fn off_bluetooth_device_found(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offBluetoothDeviceFound Cancel listening for newly discovered devices

off_compass_change

</>

pub fn off_compass_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offCompassChange Remove compass change listener

off_device_motion_change

</>

pub fn off_device_motion_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offDeviceMotionChange Remove device motion change listener

off_gyroscope_change

</>

pub fn off_gyroscope_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offGyroscopeChange Remove gyroscope change listener

off_key_down

</>

pub fn off_key_down(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offKeyDown Remove keyboard key down event listener

off_key_up

</>

pub fn off_key_up(callback cb: fn(object.JsObject) -> Nil) -> Nil

wx.offKeyUp Remove keyboard key up event listener

off_memory_warning

</>

pub fn off_memory_warning(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offMemoryWarning Remove memory warning event listener

off_wifi_connected_with_partial_info

</>

pub fn off_wifi_connected_with_partial_info(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offWifiConnectedWithPartialInfo Remove WiFi connection event listener

on_accelerometer_change

</>

pub fn on_accelerometer_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onAccelerometerChange Listen for accelerometer changes

on_beacon_service_change

</>

pub fn on_beacon_service_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onBeaconServiceChange Listen for Beacon service state change event

on_beacon_update

</>

pub fn on_beacon_update(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onBeaconUpdate Listen for Beacon device update event

on_ble_characteristic_value_change

</>

pub fn on_ble_characteristic_value_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onBLECharacteristicValueChange Listen for characteristic value change

on_ble_connection_state_change

</>

pub fn on_ble_connection_state_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onBLEConnectionStateChange Listen for BLE connection state change

on_ble_mtu_change

</>

pub fn on_ble_mtu_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onBLEMTUChange Listen for BLE MTU change events

on_ble_peripheral_connection_state_changed

</>

pub fn on_ble_peripheral_connection_state_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onBLEPeripheralConnectionStateChanged Listen for BLE peripheral connection state change

on_bluetooth_adapter_state_change

</>

pub fn on_bluetooth_adapter_state_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onBluetoothAdapterStateChange Listen for Bluetooth adapter state change

on_bluetooth_device_found

</>

pub fn on_bluetooth_device_found(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onBluetoothDeviceFound Listen for newly discovered devices

on_compass_change

</>

pub fn on_compass_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onCompassChange Listen for compass changes

on_device_motion_change

</>

pub fn on_device_motion_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onDeviceMotionChange Listen for device motion changes

on_gyroscope_change

</>

pub fn on_gyroscope_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onGyroscopeChange Listen for gyroscope changes

on_key_down

</>

pub fn on_key_down(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

Phase 13: Device Advanced - Keyboard Events

wx.onKeyDown Listen for keyboard key down events

on_key_up

</>

pub fn on_key_up(callback cb: fn(object.JsObject) -> Nil) -> Nil

wx.onKeyUp Listen for keyboard key up events

on_memory_warning

</>

pub fn on_memory_warning(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

System Memory

wx.onMemoryWarning Listen for memory warning event

on_wifi_connected_with_partial_info

</>

pub fn on_wifi_connected_with_partial_info(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onWifiConnectedWithPartialInfo Listen for WiFi connection events with partial information

open_bluetooth_adapter

</>

pub fn open_bluetooth_adapter(
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Bluetooth Low Energy (BLE)

wx.openBluetoothAdapter Initialize Bluetooth adapter

read_ble_characteristic_value

</>

pub fn read_ble_characteristic_value(
  device_id d: String,
  service_id s: String,
  characteristic_id c: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.readBLECharacteristicValue Read characteristic value

set_ble_mtu

</>

pub fn set_ble_mtu(
  device_id d: String,
  mtu m: Int,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.setBLEMTU Set BLE MTU size for a connection

set_visual_effect_on_capture

</>

pub fn set_visual_effect_on_capture(
  visual_effect_enabled v: Bool,
  visual_effect_type t: String,
) -> Nil

Phase 13: Device Advanced - Screen

wx.setVisualEffectOnCapture Set visual effect when capturing screen

start_accelerometer

</>

pub fn start_accelerometer(
  interval i: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Accelerometer

wx.startAccelerometer Start accelerometer

start_beacon_discovery

</>

pub fn start_beacon_discovery(
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Beacon (蓝牙信标)

wx.startBeaconDiscovery Start searching for Beacon devices

start_bluetooth_devices_discovery

</>

pub fn start_bluetooth_devices_discovery(
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.startBluetoothDevicesDiscovery Start searching for nearby BLE devices

start_compass

</>

pub fn start_compass(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Compass

wx.startCompass Start compass

start_device_motion_listening

</>

pub fn start_device_motion_listening(
  acceleration ai: Bool,
  rotation_rate rr: Bool,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Device Motion

wx.startDeviceMotionListening Start device motion listening

start_gyroscope

</>

pub fn start_gyroscope(
  interval i: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Gyroscope

wx.startGyroscope Start gyroscope

stop_accelerometer

</>

pub fn stop_accelerometer(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.stopAccelerometer Stop accelerometer

stop_beacon_discovery

</>

pub fn stop_beacon_discovery() -> Nil

wx.stopBeaconDiscovery Stop searching for Beacon devices

stop_bluetooth_devices_discovery

</>

pub fn stop_bluetooth_devices_discovery(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.stopBluetoothDevicesDiscovery Stop searching for nearby BLE devices

stop_compass

</>

pub fn stop_compass(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.stopCompass Stop compass

stop_device_motion_listening

</>

pub fn stop_device_motion_listening(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.stopDeviceMotionListening Stop device motion listening

stop_gyroscope

</>

pub fn stop_gyroscope(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.stopGyroscope Stop gyroscope

write_ble_characteristic_value

</>

pub fn write_ble_characteristic_value(
  device_id d: String,
  service_id s: String,
  characteristic_id c: String,
  value v: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.writeBLECharacteristicValue Write characteristic value