Add BLE CLI tests (#502)

* bt: introduce bt CLI commands
* api-hal-bt: add get rssi
* bt: fix cli commands
* bt: fix typos
* Bt: add missing newline in console message

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>

applications/applications.c

@@ -43,6 +43,7 @@ int32_t notification_app(void* p);
 // On system start hooks declaration
 void nfc_cli_init();
 void subghz_cli_init();
+void bt_cli_init();
 
 const FlipperApplication FLIPPER_SERVICES[] = {
 #ifdef SRV_CLI
@@ -208,6 +209,9 @@ const FlipperOnStartHook FLIPPER_ON_SYSTEM_START[] = {
 #ifdef APP_SUBGHZ
     subghz_cli_init,
 #endif
+#ifdef SRV_BT
+    bt_cli_init,
+#endif
 };
 
 const size_t FLIPPER_ON_SYSTEM_START_COUNT =

applications/bt/bt.c

@@ -26,8 +26,6 @@ Bt* bt_alloc() {
     bt->update_status_timer = osTimerNew(bt_update_statusbar, osTimerPeriodic, bt, NULL);
     osTimerStart(bt->update_status_timer, 4000);
     bt->hopping_mode_timer = osTimerNew(bt_switch_freq, osTimerPeriodic, bt, NULL);
-    bt->cli = furi_record_open("cli");
-    cli_add_command(bt->cli, "bt_info", bt_cli_info, bt);
     bt->gui = furi_record_open("gui");
     bt->menu = furi_record_open("menu");
 
@@ -134,14 +132,6 @@ void bt_menu_start_app(void* context) {
     furi_check(osMessageQueuePut(bt->message_queue, &message, 0, osWaitForever) == osOK);
 }
 
-void bt_cli_info(Cli* cli, string_t args, void* context) {
-    string_t buffer;
-    string_init(buffer);
-    api_hal_bt_dump_state(buffer);
-    printf(string_get_cstr(buffer));
-    string_clear(buffer);
-}
-
 int32_t bt_task() {
     Bt* bt = bt_alloc();
 
@@ -176,7 +166,7 @@ int32_t bt_task() {
             bt->state.type = BtStatusReady;
         } else if(message.type == BtMessageTypeSetupTestPacketTx) {
             // Update packet test setup
-            api_hal_bt_stop_packet_tx();
+            api_hal_bt_stop_packet_test();
             with_view_model(
                 bt->view_test_packet_tx, (BtViewTestPacketTxModel * model) {
                     model->type = bt->state.type;
@@ -187,7 +177,7 @@ int32_t bt_task() {
             view_dispatcher_switch_to_view(bt->view_dispatcher, BtViewTestPacketTx);
         } else if(message.type == BtMessageTypeStartTestPacketTx) {
             // Start sending packets
-            api_hal_bt_start_packet_tx(message.param.channel, message.param.datarate);
+            api_hal_bt_start_packet_tx(message.param.channel, 1, message.param.datarate);
             with_view_model(
                 bt->view_test_packet_tx, (BtViewTestPacketTxModel * model) {
                     model->type = bt->state.type;
@@ -198,7 +188,7 @@ int32_t bt_task() {
             view_dispatcher_switch_to_view(bt->view_dispatcher, BtViewTestPacketTx);
         } else if(message.type == BtMessageTypeStopTestPacketTx) {
             // Stop test packet tx
-            api_hal_bt_stop_packet_tx();
+            api_hal_bt_stop_packet_test();
             bt->state.type = BtStatusReady;
         } else if(message.type == BtMessageTypeStartTestRx) {
             // Start test rx

applications/bt/bt_cli.c

@@ -0,0 +1,153 @@
+#include "bt_cli.h"
+#include <furi.h>
+#include <api-hal.h>
+
+void bt_cli_init() {
+    Cli* cli = furi_record_open("cli");
+
+    cli_add_command(cli, "bt_info", bt_cli_command_info, NULL);
+    cli_add_command(cli, "bt_tx_carrier", bt_cli_command_carrier_tx, NULL);
+    cli_add_command(cli, "bt_rx_carrier", bt_cli_command_carrier_rx, NULL);
+    cli_add_command(cli, "bt_tx_pt", bt_cli_command_packet_tx, NULL);
+    cli_add_command(cli, "bt_rx_pt", bt_cli_command_packet_rx, NULL);
+
+    furi_record_close("cli");
+}
+
+void bt_cli_command_info(Cli* cli, string_t args, void* context) {
+    string_t buffer;
+    string_init(buffer);
+    api_hal_bt_dump_state(buffer);
+    printf(string_get_cstr(buffer));
+    string_clear(buffer);
+}
+
+void bt_cli_command_carrier_tx(Cli* cli, string_t args, void* context) {
+    uint16_t channel;
+    uint16_t power;
+    int ret = sscanf(string_get_cstr(args), "%hu %hu", &channel, &power);
+    if(ret != 2) {
+        printf("sscanf returned %d, channel: %hu, power: %hu\r\n", ret, channel, power);
+        cli_print_usage("bt_tx_carrier", "<Channel number> <Power>", string_get_cstr(args));
+        return;
+    }
+    if(channel > 39) {
+        printf("Channel number must be in 0...39 range, not %hu\r\n", channel);
+        return;
+    }
+    if(power > 6) {
+        printf("Power must be in 0...6 dB range, not %hu\r\n", power);
+        return;
+    }
+    printf("Transmitting carrier at %hu channel at %hu dB power\r\n", channel, power);
+    printf("Press CTRL+C to stop\r\n");
+    api_hal_bt_start_tone_tx(channel, 0x19 + power);
+
+    while(!cli_cmd_interrupt_received(cli)) {
+        osDelay(250);
+    }
+    api_hal_bt_stop_tone_tx();
+}
+
+void bt_cli_command_carrier_rx(Cli* cli, string_t args, void* context) {
+    uint16_t channel;
+    int ret = sscanf(string_get_cstr(args), "%hu", &channel);
+    if(ret != 1) {
+        printf("sscanf returned %d, channel: %hu\r\n", ret, channel);
+        cli_print_usage("bt_rx_carrier", "<Channel number>", string_get_cstr(args));
+        return;
+    }
+    if(channel > 39) {
+        printf("Channel number must be in 0...39 range, not %hu\r\n", channel);
+        return;
+    }
+    printf("Receiving carrier at %hu channel\r\n", channel);
+    printf("Press CTRL+C to stop\r\n");
+    api_hal_bt_start_packet_rx(channel, 1);
+
+    float rssi_raw = 0;
+    while(!cli_cmd_interrupt_received(cli)) {
+        osDelay(250);
+        rssi_raw = api_hal_bt_get_rssi();
+        printf("RSSI: %03.1f dB\r", rssi_raw);
+        fflush(stdout);
+    }
+    api_hal_bt_stop_packet_test();
+}
+
+void bt_cli_command_packet_tx(Cli* cli, string_t args, void* context) {
+    uint16_t channel;
+    uint16_t pattern;
+    uint16_t datarate;
+    int ret = sscanf(string_get_cstr(args), "%hu %hu %hu", &channel, &pattern, &datarate);
+    if(ret != 3) {
+        printf("sscanf returned %d, channel: %hu %hu %hu\r\n", ret, channel, pattern, datarate);
+        cli_print_usage(
+            "bt_tx_pt", "<Channel number> <Pattern> <Datarate>", string_get_cstr(args));
+        return;
+    }
+    if(channel > 39) {
+        printf("Channel number must be in 0...39 range, not %hu\r\n", channel);
+        return;
+    }
+    if(pattern > 5) {
+        printf("Pattern must be in 0...5 range, not %hu\r\n", pattern);
+        printf("0 - Pseudo-Random bit sequence 9\r\n");
+        printf("1 - Pattern of alternating bits '11110000'\r\n");
+        printf("2 - Pattern of alternating bits '10101010'\r\n");
+        printf("3 - Pseudo-Random bit sequence 15\r\n");
+        printf("4 - Pattern of All '1' bits\r\n");
+        printf("5 - Pattern of All '0' bits\r\n");
+        return;
+    }
+    if(datarate < 1 || datarate > 2) {
+        printf("Datarate must be in 1 or 2 Mb, not %hu\r\n", datarate);
+        return;
+    }
+
+    printf(
+        "Transmitting %hu pattern packet at %hu channel at %hu M datarate\r\n",
+        pattern,
+        channel,
+        datarate);
+    printf("Press CTRL+C to stop\r\n");
+    api_hal_bt_start_packet_tx(channel, pattern, datarate);
+
+    while(!cli_cmd_interrupt_received(cli)) {
+        osDelay(250);
+    }
+    api_hal_bt_stop_packet_test();
+    printf("Transmitted %lu packets", api_hal_bt_get_transmitted_packets());
+}
+
+void bt_cli_command_packet_rx(Cli* cli, string_t args, void* context) {
+    uint16_t channel;
+    uint16_t datarate;
+    int ret = sscanf(string_get_cstr(args), "%hu %hu", &channel, &datarate);
+    if(ret != 2) {
+        printf("sscanf returned %d, channel: %hu datarate: %hu\r\n", ret, channel, datarate);
+        cli_print_usage("bt_rx_pt", "<Channel number> <Datarate>", string_get_cstr(args));
+        return;
+    }
+    if(channel > 39) {
+        printf("Channel number must be in 0...39 range, not %hu\r\n", channel);
+        return;
+    }
+    if(datarate < 1 || datarate > 2) {
+        printf("Datarate must be in 1 or 2 Mb, not %hu\r\n", datarate);
+        return;
+    }
+    printf("Receiving packets at %hu channel at %hu M datarate\r\n", channel, datarate);
+    printf("Press CTRL+C to stop\r\n");
+    api_hal_bt_start_packet_rx(channel, datarate);
+
+    float rssi_raw = 0;
+    while(!cli_cmd_interrupt_received(cli)) {
+        osDelay(250);
+        rssi_raw = api_hal_bt_get_rssi();
+        printf("RSSI: %03.1f dB\r", rssi_raw);
+        fflush(stdout);
+    }
+    uint16_t packets_received = api_hal_bt_stop_packet_test();
+    printf("Received %hu packets", packets_received);
+}

applications/bt/bt_cli.h

@@ -0,0 +1,15 @@
+#pragma once
+
+#include <cli/cli.h>
+
+void bt_cli_init();
+
+void bt_cli_command_info(Cli* cli, string_t args, void* context);
+
+void bt_cli_command_carrier_tx(Cli* cli, string_t args, void* context);
+
+void bt_cli_command_carrier_rx(Cli* cli, string_t args, void* context);
+
+void bt_cli_command_packet_tx(Cli* cli, string_t args, void* context);
+
+void bt_cli_command_packet_rx(Cli* cli, string_t args, void* context);

applications/bt/bt_i.h

@@ -22,7 +22,6 @@ struct Bt {
     BtState state;
     osTimerId_t update_status_timer;
     osTimerId_t hopping_mode_timer;
-    Cli* cli;
     Gui* gui;
     ValueMutex* menu;
     // Status bar
@@ -43,8 +42,6 @@ void bt_draw_statusbar_callback(Canvas* canvas, void* context);
 
 BtTestChannel bt_switch_channel(InputKey key, BtTestChannel inst_chan);
 
-void bt_cli_info(Cli* cli, string_t args, void* context);
-
 void bt_draw_statusbar_callback(Canvas* canvas, void* context);
 
 void bt_menu_test_tone_tx(void* context);

firmware/targets/api-hal-include/api-hal-bt.h

@@ -29,23 +29,32 @@ bool api_hal_bt_lock_flash();
 void api_hal_bt_unlock_flash();
 
 /** Start ble tone tx at given channel and power */
-void api_hal_bt_start_tone_tx(uint8_t tx_channel, uint8_t power);
+void api_hal_bt_start_tone_tx(uint8_t channel, uint8_t power);
 
 /** Stop ble tone tx */
 void api_hal_bt_stop_tone_tx();
 
 /** Start sending ble packets at a given frequency and datarate */
-void api_hal_bt_start_packet_tx(uint8_t frequency, uint8_t datarate);
+void api_hal_bt_start_packet_tx(uint8_t channel, uint8_t pattern, uint8_t datarate);
 
 /** Stop sending ble packets */
-void api_hal_bt_stop_packet_tx();
+uint16_t api_hal_bt_stop_packet_test();
+
+/** Start receiving packets */
+void api_hal_bt_start_packet_rx(uint8_t channel, uint8_t datarate);
 
 /** Set up the RF to listen to a given RF channel */
-void api_hal_bt_start_rx(uint8_t frequency);
+void api_hal_bt_start_rx(uint8_t channel);
 
 /** Stop RF listenning */
 void api_hal_bt_stop_rx();
 
+/** Get RSSI */
+float api_hal_bt_get_rssi();
+
+/** Get number of transmitted packets */
+uint32_t api_hal_bt_get_transmitted_packets();
+
 #ifdef __cplusplus
 }
 #endif

firmware/targets/f5/api-hal/api-hal-bt.c

@@ -82,26 +82,58 @@ void api_hal_bt_unlock_flash() {
     }
 }
 
-void api_hal_bt_start_tone_tx(uint8_t tx_channel, uint8_t power) {
+void api_hal_bt_start_tone_tx(uint8_t channel, uint8_t power) {
     aci_hal_set_tx_power_level(0, power);
-    aci_hal_tone_start(tx_channel, 0);
+    aci_hal_tone_start(channel, 0);
 }
 
 void api_hal_bt_stop_tone_tx() {
     aci_hal_tone_stop();
 }
 
-void api_hal_bt_start_packet_tx(uint8_t frequency, uint8_t datarate) {
-    hci_le_enhanced_transmitter_test(frequency, 0x25, 2, datarate);
+void api_hal_bt_start_packet_tx(uint8_t channel, uint8_t pattern, uint8_t datarate) {
+    hci_le_enhanced_transmitter_test(channel, 0x25, pattern, datarate);
 }
 
-void api_hal_bt_stop_packet_tx() {
+void api_hal_bt_start_packet_rx(uint8_t channel, uint8_t datarate) {
+    hci_le_enhanced_receiver_test(channel, datarate, 0);
+}
+
+uint16_t api_hal_bt_stop_packet_test() {
     uint16_t num_of_packets;
     hci_le_test_end(&num_of_packets);
+    return num_of_packets;
 }
 
-void api_hal_bt_start_rx(uint8_t frequency) {
-    aci_hal_rx_start(frequency);
+void api_hal_bt_start_rx(uint8_t channel) {
+    aci_hal_rx_start(channel);
+}
+
+float api_hal_bt_get_rssi() {
+    float val;
+    uint8_t rssi_raw[3];
+    aci_hal_read_raw_rssi(rssi_raw);
+
+    // Some ST magic with rssi
+    uint8_t agc = rssi_raw[2] & 0xFF;
+    int rssi = (rssi_raw[1] << 8 & 0xFF00) + (rssi_raw[1] & 0xFF);
+    if(rssi == 0 || agc > 11) {
+        val = 127;
+    } else {
+        val = agc * 6.0f - 127.0f;
+        while(rssi > 30) {
+            val += 6.0;
+            rssi >>=1;
+        }
+        val += (417 * rssi + 18080) >> 10;
+    }
+    return val;
+}
+
+uint32_t api_hal_bt_get_transmitted_packets() {
+    uint32_t packets = 0;
+    aci_hal_le_tx_test_packet_number(&packets);
+    return packets;
 }
 
 void api_hal_bt_stop_rx() {

firmware/targets/f6/api-hal/api-hal-bt.c

@@ -82,26 +82,58 @@ void api_hal_bt_unlock_flash() {
     }
 }
 
-void api_hal_bt_start_tone_tx(uint8_t tx_channel, uint8_t power) {
+void api_hal_bt_start_tone_tx(uint8_t channel, uint8_t power) {
     aci_hal_set_tx_power_level(0, power);
-    aci_hal_tone_start(tx_channel, 0);
+    aci_hal_tone_start(channel, 0);
 }
 
 void api_hal_bt_stop_tone_tx() {
     aci_hal_tone_stop();
 }
 
-void api_hal_bt_start_packet_tx(uint8_t frequency, uint8_t datarate) {
-    hci_le_enhanced_transmitter_test(frequency, 0x25, 2, datarate);
+void api_hal_bt_start_packet_tx(uint8_t channel, uint8_t pattern, uint8_t datarate) {
+    hci_le_enhanced_transmitter_test(channel, 0x25, pattern, datarate);
 }
 
-void api_hal_bt_stop_packet_tx() {
+void api_hal_bt_start_packet_rx(uint8_t channel, uint8_t datarate) {
+    hci_le_enhanced_receiver_test(channel, datarate, 0);
+}
+
+uint16_t api_hal_bt_stop_packet_test() {
     uint16_t num_of_packets;
     hci_le_test_end(&num_of_packets);
+    return num_of_packets;
 }
 
-void api_hal_bt_start_rx(uint8_t frequency) {
-    aci_hal_rx_start(frequency);
+void api_hal_bt_start_rx(uint8_t channel) {
+    aci_hal_rx_start(channel);
+}
+
+float api_hal_bt_get_rssi() {
+    float val;
+    uint8_t rssi_raw[3];
+    aci_hal_read_raw_rssi(rssi_raw);
+
+    // Some ST magic with rssi
+    uint8_t agc = rssi_raw[2] & 0xFF;
+    int rssi = (rssi_raw[1] << 8 & 0xFF00) + (rssi_raw[1] & 0xFF);
+    if(rssi == 0 || agc > 11) {
+        val = 127;
+    } else {
+        val = agc * 6.0f - 127.0f;
+        while(rssi > 30) {
+            val += 6.0;
+            rssi >>=1;
+        }
+        val += (417 * rssi + 18080) >> 10;
+    }
+    return val;
+}
+
+uint32_t api_hal_bt_get_transmitted_packets() {
+    uint32_t packets = 0;
+    aci_hal_le_tx_test_packet_number(&packets);
+    return packets;
 }
 
 void api_hal_bt_stop_rx() {