diff --git a/wireless/bluetooth/btsak/README.txt b/wireless/bluetooth/btsak/README.txt new file mode 100644 index 000000000..49df05fdb --- /dev/null +++ b/wireless/bluetooth/btsak/README.txt @@ -0,0 +1,104 @@ +btsak -- Bluetooth Swiss Army Knife + +Commands: + + Command: help + Description: Should overall command help + Usage: bt help + + Command: info + Description: Show Bluetooth driver information + Usage: bt info [-h] + + Command: features + Description: Show Bluetooth driver information + Usage: bt features [-h] [le] + Where: le - Selects LE features vs BR/EDR features + + Command: scan + Description: Bluetooth scan commands + Usage: bt scan [-h] + Where: start - Starts scanning. The -d option enables duplicate + filtering. + get - Shows new accumulated scan results + stop - Stops scanning + + Command: advertise + Description: Bluetooth advertise commands + Usage: bt advertise [-h] + Where: start - Starts advertising + stop - Stops advertising + + Command: security + Description: Enable security (encryption) for a connection: + If device is paired, key encryption will be enabled. If + the link is already encrypted with sufficiently strong + key this command does nothing. + + If the device is not paired pairing will be initiated. If + the device is paired and keys are too weak but input output + capabilities allow for strong enough keys pairing will be + initiated. + + This command may return error if required level of security + is not possible to achieve due to local or remote device + limitation (eg input output capabilities). + Usage: bt security [-h] public|private + Where: - The 6-byte address of the connected peer + - Security level, on of: + + low - No encryption and no authentication + medium - Encryption and no authentication (no MITM) + high - Encryption and authentication (MITM) + fips - Authenticated LE secure connections and encryption + + Command: gatt + Description: Generic Attribute (GATT) commands + Usage: bt gatt [-h] [option [option [option...]]] + Where: See "GATT Commands" below + +GATT Commands + + Command: exchange-mtu + Description: Set MTU to out maximum and negotiate MTU with peer + Usage: bt gatt exchange-mtu [-h] public|private + + Command: mget + Description: Get the pass/fail result of the last GATT 'exchange-mtu' command + Usage: bt gatt mget [-h] + + Command: discover + Description: Initiate discovery + Usage: bt gatt discover [-h] public|private [ []] + + Command: characteristic + Description: Initiate characteristics discovery + Usage: bt gatt characteristic [-h] public|private [ []] + + Command: descriptor + Description: Initiate characteristics discovery + Usage: bt gatt descriptor [-h] public|private [ []] + + Command: dget + Description: Get the result of the last discovery action + Usage: bt gatt dget [-h] + + Command: read + Description: Initiate a GATT read operation. + Usage: bt gatt read [-h] public|private [] + + Command: read-multiple + Description: Initiate a GATT read-multiple operation. + Usage: bt gatt read-multiple [-h] public|private [ []..] + + Command: rget + Description: Get the data resulting from the last read operation + Usage: bt gatt rget [-h] + + Command: write + Description: Initiate a GATT write operation. + Usage: bt gatt write [-h] public|private [ []..] + + Command: wget + Description: Get the pass/fail result of the last GATT 'write' command + Usage: bt gatt wget [-h] diff --git a/wireless/bluetooth/btsak/btsak_scan.c b/wireless/bluetooth/btsak/btsak_scan.c index c95d75744..08feb7656 100644 --- a/wireless/bluetooth/btsak/btsak_scan.c +++ b/wireless/bluetooth/btsak/btsak_scan.c @@ -75,7 +75,7 @@ static void btsak_scan_showusage(FAR const char *progname, fprintf(stderr, "\nWhere the options do the following:\n\n"); fprintf(stderr, "\tstart\t- Starts scanning. The -d option enables duplicate\n"); fprintf(stderr, "\t\t filtering.\n"); - fprintf(stderr, "\tget\t - Shows new accumulated scan results\n"); + fprintf(stderr, "\tget\t- Shows new accumulated scan results\n"); fprintf(stderr, "\tstop\t- Stops scanning\n"); exit(exitcode); }