CTS-SAT-1-OBC-Firmware
Loading...
Searching...
No Matches
lfs_telecommand_defs.h
Go to the documentation of this file.
1
2#ifndef INCLUDE_GUARD__LFS_TELECOMMAND_DEFS_H__
3#define INCLUDE_GUARD__LFS_TELECOMMAND_DEFS_H__
4
5#include <stdint.h>
6
7uint8_t TCMDEXEC_fs_format_storage(const char *args_str,
8 char *response_output_buf, uint16_t response_output_buf_len);
9
10uint8_t TCMDEXEC_fs_mount(const char *args_str,
11 char *response_output_buf, uint16_t response_output_buf_len);
12
13uint8_t TCMDEXEC_fs_unmount(const char *args_str,
14 char *response_output_buf, uint16_t response_output_buf_len);
15
16uint8_t TCMDEXEC_fs_list_directory(const char *args_str,
17 char *response_output_buf, uint16_t response_output_buf_len);
18
19uint8_t TCMDEXEC_fs_list_directory_json(
20 const char *args_str,
21 char *response_output_buf, uint16_t response_output_buf_len
22);
23
24uint8_t TCMDEXEC_fs_make_directory(const char *args_str,
25 char *response_output_buf, uint16_t response_output_buf_len);
26
27uint8_t TCMDEXEC_fs_write_file_str(const char *args_str,
28 char *response_output_buf, uint16_t response_output_buf_len);
29
30uint8_t TCMDEXEC_fs_write_file_hex(const char *args_str,
31 char *response_output_buf, uint16_t response_output_buf_len);
32
33uint8_t TCMDEXEC_fs_delete_file(const char *args_str,
34 char *response_output_buf, uint16_t response_output_buf_len);
35
36uint8_t TCMDEXEC_fs_delete_dir(const char *args_str,
37 char *response_output_buf, uint16_t response_output_buf_len);
38
39uint8_t TCMDEXEC_fs_read_file_hex(const char *args_str,
40 char *response_output_buf, uint16_t response_output_buf_len);
41
42uint8_t TCMDEXEC_fs_read_text_file(const char *args_str,
43 char *response_output_buf, uint16_t response_output_buf_len);
44
45uint8_t TCMDEXEC_fs_read_file_sha256_hash_json(
46 const char *args_str,
47 char *response_output_buf, uint16_t response_output_buf_len
48);
49
50uint8_t TCMDEXEC_fs_demo_write_then_read(const char *args_str,
51 char *response_output_buf, uint16_t response_output_buf_len);
52
53uint8_t TCMDEXEC_fs_demo_write_random_data(
54 const char *args_str,
55 char *response_output_buf, uint16_t response_output_buf_len
56);
57
58uint8_t TCMDEXEC_fs_benchmark_write_read(const char *args_str,
59 char *response_output_buf, uint16_t response_output_buf_len);
60
61uint8_t TCMDEXEC_fs_get_filesystem_stats_json(
62 const char *args_str,
63 char *response_output_buf, uint16_t response_output_buf_len
64);
65
66uint8_t TCMDEXEC_fs_compress_file_with_heatshrink(
67 const char *args_str,
68 char *response_output_buf, uint16_t response_output_buf_len
69);
70
71#endif /* INCLUDE_GUARD__LFS_TELECOMMAND_DEFS_H__ */
TCMDEXEC_fs_mount
uint8_t TCMDEXEC_fs_mount(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Definition lfs_telecommand_defs.c:48
TCMDEXEC_fs_list_directory
uint8_t TCMDEXEC_fs_list_directory(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Telecommand: List all the files and directories within a given directory.
Definition lfs_telecommand_defs.c:77
TCMDEXEC_fs_demo_write_random_data
uint8_t TCMDEXEC_fs_demo_write_random_data(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Write a file with pseudorandom data to LittleFS.
Definition lfs_telecommand_defs.c:640
TCMDEXEC_fs_write_file_hex
uint8_t TCMDEXEC_fs_write_file_hex(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Telecommand: Write hex data to a file in LittleFS with offset support.
Definition lfs_telecommand_defs.c:277
TCMDEXEC_fs_demo_write_then_read
uint8_t TCMDEXEC_fs_demo_write_then_read(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Writes a file to LittleFS, then reads it back.
Definition lfs_telecommand_defs.c:599
TCMDEXEC_fs_benchmark_write_read
uint8_t TCMDEXEC_fs_benchmark_write_read(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Telecommand: Benchmark LittleFS write and read operations.
Definition lfs_telecommand_defs.c:763
TCMDEXEC_fs_read_file_hex
uint8_t TCMDEXEC_fs_read_file_hex(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Reads a file from LittleFS, and responds with its contents as 2-digit hex bytes (no spaces).
Definition lfs_telecommand_defs.c:441
TCMDEXEC_fs_read_file_sha256_hash_json
uint8_t TCMDEXEC_fs_read_file_sha256_hash_json(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Calculates the SHA256 hash of a file in LittleFS and returns it as a little-endian hex string.
Definition lfs_telecommand_defs.c:535
TCMDEXEC_fs_make_directory
uint8_t TCMDEXEC_fs_make_directory(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Telecommand: Create a directory.
Definition lfs_telecommand_defs.c:200
TCMDEXEC_fs_list_directory_json
uint8_t TCMDEXEC_fs_list_directory_json(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Telecommand: List all the files and directories within a given directory, as a JSON dict (key are pat...
Definition lfs_telecommand_defs.c:139
TCMDEXEC_fs_write_file_str
uint8_t TCMDEXEC_fs_write_file_str(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Telecommand: Write data to a file in LittleFS.
Definition lfs_telecommand_defs.c:236
TCMDEXEC_fs_delete_dir
uint8_t TCMDEXEC_fs_delete_dir(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Telecommand: Deletes a specified directory, including all subfolders/subfiles.
Definition lfs_telecommand_defs.c:364
TCMDEXEC_fs_delete_file
uint8_t TCMDEXEC_fs_delete_file(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Telecommand: Deletes a specified file in LittleFS.
Definition lfs_telecommand_defs.c:337
TCMDEXEC_fs_compress_file_with_heatshrink
uint8_t TCMDEXEC_fs_compress_file_with_heatshrink(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Compress a file using heatshrink.
Definition lfs_telecommand_defs.c:826
TCMDEXEC_fs_get_filesystem_stats_json
uint8_t TCMDEXEC_fs_get_filesystem_stats_json(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Generate a JSON string containing filesystem stats and debugging info.
Definition lfs_telecommand_defs.c:797
TCMDEXEC_fs_unmount
uint8_t TCMDEXEC_fs_unmount(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Definition lfs_telecommand_defs.c:60
TCMDEXEC_fs_format_storage
uint8_t TCMDEXEC_fs_format_storage(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Format the LittleFS storage. ERASES ALL FILES. Unmounts the filesystem if necessary.
Definition lfs_telecommand_defs.c:24
TCMDEXEC_fs_read_text_file
uint8_t TCMDEXEC_fs_read_text_file(const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
Reads a file from LittleFS, and responds with its contents as a string.
Definition lfs_telecommand_defs.c:486
Generated by doxygen 1.16.1