Plugin Commands: BLE

Zigbee Application Framework Command Line Interface (CLI)

plugin ble connection close [connection-handle:1]

• Close BLE connection
  • connection-handle - INT8U - the connection handle which should be closed

plugin ble gap conn-open [address:-1] [address-type:1]

• Open a GAP connection
  • address - OCTET_STRING - The BLE address of the target device
  • address-type - INT8U - The address type: 0=public, 1=random, 2=public resolved by the stack, 3=public resolved by the stack, 16=classic bluetooth

plugin ble gap discover [discovery-mode:1]

• Start a GAP discovery procedure
  • discovery-mode - INT8U - The GAP discovery mode: 0=only limited discoverable devices, 1=limited and generic discoverable devices, 2=all devices

plugin ble gap set-adv-params [min-interval:2] [max-interval:2] [channel-map:1]

• Set the GAP advertisement parameters
  • min-interval - INT16U - minimum connection interval
  • max-interval - INT16U - maximum connection interval
  • channel-map - INT8U - Channel map indicating which of three channels will be used

plugin ble gap set-bt5-mode [advertisement-handle:1] [discoverable-mode:1] [connectable-mode:1] [max-events:2] [address-type:1]

• Set the BT5 GAP mode
  • advertisement-handle - INT8U - The handle index of advertisement
  • discoverable-mode - INT8U - The GAP discoverable mode: 0=non discoverable, 1=limited discoverable, 2=general discoverable, 3=broadcast, 4=user data
  • connectable-mode - INT8U - The GAP connectable mode: 0=non connectable, 1=directed connectable, 2=undirected connectable, 3=scannable non connectable
  • max-events - INT16U - The maximum number of events
  • address-type - INT8U - Address type: 0=public, 1=random, 2=public identity, 3=random identity, 16=classic bluetooth

plugin ble gap set-conn-params [min-interval:2] [max-interval:2] [slave-latency:2] [supervision-timeout:2]

• Set the GAP connection parameters
  • min-interval - INT16U - minimum connection event interval
  • max-interval - INT16U - maximum connection event interval
  • slave-latency - INT16U - number of connection intervals the slave can skip
  • supervision-timeout - INT16U - time before the connection is dropped

plugin ble gap set-mode [discoverable-mode:1] [connectable-mode:1]

• Set the GAP mode
  • discoverable-mode - INT8U - The GAP discoverable mode: 0=non discoverable, 1=limited discoverable, 2=general discoverable, 3=broadcast, 4=user data
  • connectable-mode - INT8U - The GAP connectable mode: 0=non connectable, 1=directed connectable, 2=undirected connectable, 3=scannable non connectable

plugin ble gap update-conn-params [connection-handle:2] [min-interval:2] [max-interval:2] [slave-latency:2] [supervision-timeout:2]

• Set the GAP connection parameters for connection
  • connection-handle - INT16U - connection handle
  • min-interval - INT16U - minimum connection event interval
  • max-interval - INT16U - maximum connection event interval
  • slave-latency - INT16U - number of connection intervals the slave can skip
  • supervision-timeout - INT16U - time before the connection is dropped

plugin ble gatt discover-characteristics [connection-handle:1] [serice-handle:4]

• GATT discovery of characteristics
  • connection-handle - INT8U - the connection handle on which discovery should be performed
  • serice-handle - INT32U - the service handle on which discovery should be performed

plugin ble gatt discover-primary-services [connection-handle:1]

• GATT discovery of primary services
  • connection-handle - INT8U - the connection handle on which discovery should be performed

plugin ble gatt set-characteristic-notification [connection-handle:1] [characteristic-handle:2] [flags:1]

• GATT set characteristic notification
  • connection-handle - INT8U - the connection handle for which the notification should be set
  • characteristic-handle - INT16U - the characteristic handle to set notification for
  • flags - INT8U - 0=disable, 1=notification, 2=indication

plugin ble gatt write-characteristic [connection-handle:1] [characteristic-handle:2] [value-len:1] [value-data:-1]

• GATT write characteristic value
  • connection-handle - INT8U - the connection handle
  • characteristic-handle - INT16U - the characteristic handle
  • value-len - INT8U - the lenght of data
  • value-data - OCTET_STRING - data to write

plugin ble get address

• Read the Bluetooth address

plugin ble hello

• Can be used to check that Bluetooth stack is functional

plugin ble sm delete-all-bondings

• Delete all bondings

plugin ble sm delete-bonding [boning-handle:1]

• Delete bonding
  • boning-handle - INT8U - the bonding handle to be deleted

plugin ble sm increase-security [connection-handle:1]

• Increase the security level
  • connection-handle - INT8U - the connection handle for which we want to increase the security level

plugin ble sm list-all-bondings

• Send a command to get all the current bondings

plugin ble sm set-bondable-mode [bondable-mode:1]

• Set the bondable mode
  • bondable-mode - INT8U - The bondable mode: 0=new bondings not accepted, 1=bondings allowed

plugin ble system set-tx-power [tx-power:2]

• Set the TX power
  • tx-power - INT16S - tx power to be set in 0.1dBm steps