cli.h

Go to the documentation of this file.

 
#pragma once
#include <furi.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    CliSymbolAsciiSOH = 0x01,
    CliSymbolAsciiETX = 0x03,
    CliSymbolAsciiEOT = 0x04,
    CliSymbolAsciiBell = 0x07,
    CliSymbolAsciiBackspace = 0x08,
    CliSymbolAsciiTab = 0x09,
    CliSymbolAsciiLF = 0x0A,
    CliSymbolAsciiCR = 0x0D,
    CliSymbolAsciiEsc = 0x1B,
    CliSymbolAsciiUS = 0x1F,
    CliSymbolAsciiSpace = 0x20,
    CliSymbolAsciiDel = 0x7F,
} CliSymbols;
 
typedef enum {
    CliCommandFlagDefault = 0, 
    CliCommandFlagParallelSafe =
        (1 << 0), 
    CliCommandFlagInsomniaSafe = (1 << 1), 
} CliCommandFlag;
 
#define RECORD_CLI "cli"
 
typedef struct Cli Cli;
 
typedef void (*CliCallback)(Cli* cli, FuriString* args, void* context);
 
void cli_add_command(
    Cli* cli,
    const char* name,
    CliCommandFlag flags,
    CliCallback callback,
    void* context);
 
void cli_print_usage(const char* cmd, const char* usage, const char* arg);
 
void cli_delete_command(Cli* cli, const char* name);
 
size_t cli_read(Cli* cli, uint8_t* buffer, size_t size);
 
size_t cli_read_timeout(Cli* cli, uint8_t* buffer, size_t size, uint32_t timeout);
 
bool cli_cmd_interrupt_received(Cli* cli);
 
void cli_write(Cli* cli, const uint8_t* buffer, size_t size);
 
char cli_getc(Cli* cli);
 
void cli_nl(Cli* cli);
 
void cli_session_open(Cli* cli, void* session);
 
void cli_session_close(Cli* cli);
 
bool cli_is_connected(Cli* cli);
 
#ifdef __cplusplus
}
#endif