unleashed-firmware/applications/cli/cli_commands.c

#include "cli_commands.h"
#include <furi_hal.h>
#include <furi_hal_gpio.h>
#include <furi_hal_info.h>
#include <task_control_block.h>
#include <time.h>
#include <notification/notification_messages.h>
#include <loader/loader.h>
#include <stream_buffer.h>

// Close to ISO, `date +'%Y-%m-%d %H:%M:%S %u'`
#define CLI_DATE_FORMAT "%.4d-%.2d-%.2d %.2d:%.2d:%.2d %d"

void cli_command_device_info_callback(const char* key, const char* value, bool last, void* context) {
    UNUSED(context);
    UNUSED(last);
    printf("%-24s: %s\r\n", key, value);
}

/* 
 * Device Info Command
 * This command is intended to be used by humans
 */
void cli_command_device_info(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(args);
    furi_hal_info_get(cli_command_device_info_callback, context);
}

void cli_command_help(Cli* cli, string_t args, void* context) {
    UNUSED(args);
    UNUSED(context);
    printf("Commands we have:");

    // Command count
    const size_t commands_count = CliCommandTree_size(cli->commands);
    const size_t commands_count_mid = commands_count / 2 + commands_count % 2;

    // Use 2 iterators from start and middle to show 2 columns
    CliCommandTree_it_t it_left;
    CliCommandTree_it(it_left, cli->commands);
    CliCommandTree_it_t it_right;
    CliCommandTree_it(it_right, cli->commands);
    for(size_t i = 0; i < commands_count_mid; i++) CliCommandTree_next(it_right);

    // Iterate throw tree
    for(size_t i = 0; i < commands_count_mid; i++) {
        printf("\r\n");
        // Left Column
        if(!CliCommandTree_end_p(it_left)) {
            printf("%-30s", string_get_cstr(*CliCommandTree_ref(it_left)->key_ptr));
            CliCommandTree_next(it_left);
        }
        // Right Column
        if(!CliCommandTree_end_p(it_right)) {
            printf("%s", string_get_cstr(*CliCommandTree_ref(it_right)->key_ptr));
            CliCommandTree_next(it_right);
        }
    };

    if(string_size(args) > 0) {
        cli_nl();
        printf("Also I have no clue what '");
        printf("%s", string_get_cstr(args));
        printf("' is.");
    }
}

void cli_command_date(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(context);

    FuriHalRtcDateTime datetime = {0};

    if(string_size(args) > 0) {
        uint16_t hours, minutes, seconds, month, day, year, weekday;
        int ret = sscanf(
            string_get_cstr(args),
            "%hu-%hu-%hu %hu:%hu:%hu %hu",
            &year,
            &month,
            &day,
            &hours,
            &minutes,
            &seconds,
            &weekday);

        // Some variables are going to discard upper byte
        // There will be some funky behaviour which is not breaking anything
        datetime.hour = hours;
        datetime.minute = minutes;
        datetime.second = seconds;
        datetime.weekday = weekday;
        datetime.month = month;
        datetime.day = day;
        datetime.year = year;

        if(ret != 7) {
            printf(
                "Invalid datetime format, use `%s`. sscanf %d %s",
                "%Y-%m-%d %H:%M:%S %u",
                ret,
                string_get_cstr(args));
            return;
        }

        if(!furi_hal_rtc_validate_datetime(&datetime)) {
            printf("Invalid datetime data");
            return;
        }

        furi_hal_rtc_set_datetime(&datetime);
        // Verification
        furi_hal_rtc_get_datetime(&datetime);
        printf(
            "New datetime is: " CLI_DATE_FORMAT,
            datetime.year,
            datetime.month,
            datetime.day,
            datetime.hour,
            datetime.minute,
            datetime.second,
            datetime.weekday);
    } else {
        furi_hal_rtc_get_datetime(&datetime);
        printf(
            CLI_DATE_FORMAT,
            datetime.year,
            datetime.month,
            datetime.day,
            datetime.hour,
            datetime.minute,
            datetime.second,
            datetime.weekday);
    }
}

#define CLI_COMMAND_LOG_RING_SIZE 2048
#define CLI_COMMAND_LOG_BUFFER_SIZE 64

void cli_command_log_tx_callback(const uint8_t* buffer, size_t size, void* context) {
    xStreamBufferSend(context, buffer, size, 0);
}

void cli_command_log(Cli* cli, string_t args, void* context) {
    UNUSED(args);
    UNUSED(context);
    StreamBufferHandle_t ring = xStreamBufferCreate(CLI_COMMAND_LOG_RING_SIZE, 1);
    uint8_t buffer[CLI_COMMAND_LOG_BUFFER_SIZE];

    furi_hal_console_set_tx_callback(cli_command_log_tx_callback, ring);

    printf("Press CTRL+C to stop...\r\n");
    while(!cli_cmd_interrupt_received(cli)) {
        size_t ret = xStreamBufferReceive(ring, buffer, CLI_COMMAND_LOG_BUFFER_SIZE, 50);
        cli_write(cli, buffer, ret);
    }

    furi_hal_console_set_tx_callback(NULL, NULL);

    vStreamBufferDelete(ring);
}

void cli_command_vibro(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(context);
    if(!string_cmp(args, "0")) {
        NotificationApp* notification = furi_record_open("notification");
        notification_message_block(notification, &sequence_reset_vibro);
        furi_record_close("notification");
    } else if(!string_cmp(args, "1")) {
        NotificationApp* notification = furi_record_open("notification");
        notification_message_block(notification, &sequence_set_vibro_on);
        furi_record_close("notification");
    } else {
        cli_print_usage("vibro", "<1|0>", string_get_cstr(args));
    }
}

void cli_command_debug(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(context);
    if(!string_cmp(args, "0")) {
        furi_hal_rtc_reset_flag(FuriHalRtcFlagDebug);
        loader_update_menu();
        printf("Debug disabled.");
    } else if(!string_cmp(args, "1")) {
        furi_hal_rtc_set_flag(FuriHalRtcFlagDebug);
        loader_update_menu();
        printf("Debug enabled.");
    } else {
        cli_print_usage("debug", "<1|0>", string_get_cstr(args));
    }
}

void cli_command_led(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(context);
    // Get first word as light name
    NotificationMessage notification_led_message;
    string_t light_name;
    string_init(light_name);
    size_t ws = string_search_char(args, ' ');
    if(ws == STRING_FAILURE) {
        cli_print_usage("led", "<r|g|b|bl> <0-255>", string_get_cstr(args));
        string_clear(light_name);
        return;
    } else {
        string_set_n(light_name, args, 0, ws);
        string_right(args, ws);
        string_strim(args);
    }
    // Check light name
    if(!string_cmp(light_name, "r")) {
        notification_led_message.type = NotificationMessageTypeLedRed;
    } else if(!string_cmp(light_name, "g")) {
        notification_led_message.type = NotificationMessageTypeLedGreen;
    } else if(!string_cmp(light_name, "b")) {
        notification_led_message.type = NotificationMessageTypeLedBlue;
    } else if(!string_cmp(light_name, "bl")) {
        notification_led_message.type = NotificationMessageTypeLedDisplayBacklight;
    } else {
        cli_print_usage("led", "<r|g|b|bl> <0-255>", string_get_cstr(args));
        string_clear(light_name);
        return;
    }
    string_clear(light_name);
    // Read light value from the rest of the string
    char* end_ptr;
    uint32_t value = strtoul(string_get_cstr(args), &end_ptr, 0);
    if(!(value < 256 && *end_ptr == '\0')) {
        cli_print_usage("led", "<r|g|b|bl> <0-255>", string_get_cstr(args));
        return;
    }

    // Set led value
    notification_led_message.data.led.value = value;

    // Form notification sequence
    const NotificationSequence notification_sequence = {
        &notification_led_message,
        NULL,
    };

    // Send notification
    NotificationApp* notification = furi_record_open("notification");
    notification_internal_message_block(notification, &notification_sequence);
    furi_record_close("notification");
}

char pin_names[][4] = {
    "PC0",
    "PC1",
    "PC3",
    "PB2",
    "PB3",
    "PA4",
    "PA6",
    "PA7",
#ifdef FURI_DEBUG
    "PA0",
    "PB7",
    "PB8",
    "PB9"
#endif
};
GpioPin gpio[] = {
    {.port = GPIOC, .pin = LL_GPIO_PIN_0},
    {.port = GPIOC, .pin = LL_GPIO_PIN_1},
    {.port = GPIOC, .pin = LL_GPIO_PIN_3},
    {.port = GPIOB, .pin = LL_GPIO_PIN_2},
    {.port = GPIOB, .pin = LL_GPIO_PIN_3},
    {.port = GPIOA, .pin = LL_GPIO_PIN_4},
    {.port = GPIOA, .pin = LL_GPIO_PIN_6},
    {.port = GPIOA, .pin = LL_GPIO_PIN_7},
#ifdef FURI_DEBUG
    {.port = GPIOA, .pin = LL_GPIO_PIN_0}, // IR_RX (PA0)
    {.port = GPIOB, .pin = LL_GPIO_PIN_7}, // UART RX (PB7)
    {.port = GPIOB, .pin = LL_GPIO_PIN_8}, // SPEAKER (PB8)
    {.port = GPIOB, .pin = LL_GPIO_PIN_9}, // IR_TX (PB9)
#endif
};

static bool pin_name_to_int(string_t pin_name, uint8_t* result) {
    uint8_t num = 0;
    bool pin_found = false;

    for(num = 0; num < sizeof(pin_names) / sizeof(char*); num++) {
        if(!string_cmp(pin_name, pin_names[num])) {
            pin_found = true;
            break;
        }
    }

    *result = num;
    return pin_found;
}

static void gpio_print_pins(void) {
    printf("Wrong pin name. Available pins: ");
    for(uint8_t i = 0; i < sizeof(pin_names) / sizeof(char*); i++) {
        printf("%s ", pin_names[i]);
    }
}

typedef enum { OK, ERR_CMD_SYNTAX, ERR_PIN, ERR_VALUE } GpioParseError;

static GpioParseError gpio_command_parse(string_t args, uint8_t* pin_num, uint8_t* value) {
    string_t pin_name;
    string_init(pin_name);

    size_t ws = string_search_char(args, ' ');
    if(ws == STRING_FAILURE) {
        return ERR_CMD_SYNTAX;
    }

    string_set_n(pin_name, args, 0, ws);
    string_right(args, ws);
    string_strim(args);

    if(!pin_name_to_int(pin_name, pin_num)) {
        string_clear(pin_name);
        return ERR_PIN;
    }

    string_clear(pin_name);

    if(!string_cmp(args, "0")) {
        *value = 0;
    } else if(!string_cmp(args, "1")) {
        *value = 1;
    } else {
        return ERR_VALUE;
    }

    return OK;
}

void cli_command_gpio_mode(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(context);

    uint8_t num = 0;
    uint8_t value = 255;

    GpioParseError err = gpio_command_parse(args, &num, &value);

    if(ERR_CMD_SYNTAX == err) {
        cli_print_usage("gpio_mode", "<pin_name> <0|1>", string_get_cstr(args));
        return;
    } else if(ERR_PIN == err) {
        gpio_print_pins();
        return;
    } else if(ERR_VALUE == err) {
        printf("Value is invalid. Enter 1 for input or 0 for output");
        return;
    }

    if(value == 0) { // output
        furi_hal_gpio_init_simple(gpio + num, GpioModeOutputPushPull);
        furi_hal_gpio_write(gpio + num, false);
        printf("Pin %s is now an output (low)", pin_names[num]);
    } else { // input
        furi_hal_gpio_init_simple(gpio + num, GpioModeInput);
        printf("Pin %s is now an input", pin_names[num]);
    }
}

void cli_command_gpio_read(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(context);

    uint8_t num = 0;
    if(!pin_name_to_int(args, &num)) {
        gpio_print_pins();
        return;
    }

    if(LL_GPIO_MODE_INPUT != LL_GPIO_GetPinMode(gpio[num].port, gpio[num].pin)) {
        printf("Err: pin %s is not set as an input.", pin_names[num]);
        return;
    }

    uint8_t val = !!furi_hal_gpio_read(&gpio[num]);

    printf("Pin %s <= %u", pin_names[num], val);
}

void cli_command_gpio_set(Cli* cli, string_t args, void* context) {
    UNUSED(context);

    uint8_t num = 0;
    uint8_t value = 0;
    GpioParseError err = gpio_command_parse(args, &num, &value);

    if(ERR_CMD_SYNTAX == err) {
        cli_print_usage("gpio_set", "<pin_name> <0|1>", string_get_cstr(args));
        return;
    } else if(ERR_PIN == err) {
        gpio_print_pins();
        return;
    } else if(ERR_VALUE == err) {
        printf("Value is invalid. Enter 1 for high or 0 for low");
        return;
    }

    if(LL_GPIO_MODE_OUTPUT != LL_GPIO_GetPinMode(gpio[num].port, gpio[num].pin)) {
        printf("Err: pin %s is not set as an output.", pin_names[num]);
        return;
    }

#ifdef FURI_DEBUG
    if(value && num == 8) { // PA0
        printf(
            "Setting PA0 pin HIGH with TSOP connected can damage IR receiver. Are you sure you want to continue? (y/n)?\r\n");
        char c = cli_getc(cli);
        if(c != 'y' && c != 'Y') {
            printf("Cancelled.\r\n");
            return;
        }
    }
#else
    UNUSED(cli);
#endif

    furi_hal_gpio_write(gpio + num, !!value);
    printf("Pin %s => %u", pin_names[num], !!value);
}

void cli_command_ps(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(args);
    UNUSED(context);

    const uint8_t threads_num_max = 32;
    osThreadId_t threads_id[threads_num_max];
    uint8_t thread_num = osThreadEnumerate(threads_id, threads_num_max);
    printf(
        "%-20s %-14s %-8s %-8s %s\r\n", "Name", "Stack start", "Heap", "Stack", "Stack min free");
    for(uint8_t i = 0; i < thread_num; i++) {
        TaskControlBlock* tcb = (TaskControlBlock*)threads_id[i];
        printf(
            "%-20s 0x%-12lx %-8d %-8ld %-8ld\r\n",
            osThreadGetName(threads_id[i]),
            (uint32_t)tcb->pxStack,
            memmgr_heap_get_thread_memory(threads_id[i]),
            (uint32_t)(tcb->pxEndOfStack - tcb->pxStack + 1) * sizeof(StackType_t),
            osThreadGetStackSpace(threads_id[i]));
    }
    printf("\r\nTotal: %d", thread_num);
}

void cli_command_free(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(args);
    UNUSED(context);

    printf("Free heap size: %d\r\n", memmgr_get_free_heap());
    printf("Total heap size: %d\r\n", memmgr_get_total_heap());
    printf("Minimum heap size: %d\r\n", memmgr_get_minimum_free_heap());
    printf("Maximum heap block: %d\r\n", memmgr_heap_get_max_free_block());
}

void cli_command_free_blocks(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(args);
    UNUSED(context);

    memmgr_heap_printf_free_blocks();
}

void cli_command_i2c(Cli* cli, string_t args, void* context) {
    UNUSED(cli);
    UNUSED(args);
    UNUSED(context);

    furi_hal_i2c_acquire(&furi_hal_i2c_handle_external);
    printf("Scanning external i2c on PC0(SCL)/PC1(SDA)\r\n"
           "Clock: 100khz, 7bit address\r\n"
           "\r\n");
    printf("  | 0 1 2 3 4 5 6 7 8 9 A B C D E F\r\n");
    printf("--+--------------------------------\r\n");
    for(uint8_t row = 0; row < 0x8; row++) {
        printf("%x | ", row);
        for(uint8_t column = 0; column <= 0xF; column++) {
            bool ret = furi_hal_i2c_is_device_ready(
                &furi_hal_i2c_handle_external, ((row << 4) + column) << 1, 2);
            printf("%c ", ret ? '#' : '-');
        }
        printf("\r\n");
    }
    furi_hal_i2c_release(&furi_hal_i2c_handle_external);
}

void cli_commands_init(Cli* cli) {
    cli_add_command(cli, "!", CliCommandFlagParallelSafe, cli_command_device_info, NULL);
    cli_add_command(cli, "device_info", CliCommandFlagParallelSafe, cli_command_device_info, NULL);

    cli_add_command(cli, "?", CliCommandFlagParallelSafe, cli_command_help, NULL);
    cli_add_command(cli, "help", CliCommandFlagParallelSafe, cli_command_help, NULL);

    cli_add_command(cli, "date", CliCommandFlagParallelSafe, cli_command_date, NULL);
    cli_add_command(cli, "log", CliCommandFlagParallelSafe, cli_command_log, NULL);
    cli_add_command(cli, "debug", CliCommandFlagDefault, cli_command_debug, NULL);
    cli_add_command(cli, "ps", CliCommandFlagParallelSafe, cli_command_ps, NULL);
    cli_add_command(cli, "free", CliCommandFlagParallelSafe, cli_command_free, NULL);
    cli_add_command(cli, "free_blocks", CliCommandFlagParallelSafe, cli_command_free_blocks, NULL);

    cli_add_command(cli, "vibro", CliCommandFlagDefault, cli_command_vibro, NULL);
    cli_add_command(cli, "led", CliCommandFlagDefault, cli_command_led, NULL);
    cli_add_command(cli, "gpio_mode", CliCommandFlagDefault, cli_command_gpio_mode, NULL);
    cli_add_command(cli, "gpio_read", CliCommandFlagDefault, cli_command_gpio_read, NULL);
    cli_add_command(cli, "gpio_set", CliCommandFlagDefault, cli_command_gpio_set, NULL);
    cli_add_command(cli, "i2c", CliCommandFlagDefault, cli_command_i2c, NULL);
}