Merge pull request #3107 from kormax/hf-field-timeout

Add 'hf.field.timeout' to prefs
This commit is contained in:
Iceman authored and GitHub committed 2026-04-01 10:06:28 +07:00
commit f8dd296884
13 files changed
+215 -4

No files matched your search

+14 -2
View File
@@ -212,14 +212,26 @@ void CmdsHelp(const command_t Commands[]) {
PrintAndLogEx(NORMAL, "");
int i = 0;
size_t max_name_len = 16; // minimum width for command name column
while (Commands[i].Name) {
if (Commands[i].IsAvailable()) {
size_t name_len = strlen(Commands[i].Name);
if (name_len > max_name_len) {
max_name_len = name_len;
}
}
++i;
}
i = 0;
while (Commands[i].Name) {
if (Commands[i].IsAvailable()) {
uint8_t old_printAndLog = g_printAndLog;
g_printAndLog &= PRINTANDLOG_PRINT;
if (Commands[i].Name[0] == '-' || Commands[i].Name[0] == ' ') {
PrintAndLogEx(NORMAL, "%-16s %s", Commands[i].Name, Commands[i].Help);
PrintAndLogEx(NORMAL, "%-*s %s", (int)max_name_len, Commands[i].Name, Commands[i].Help);
} else {
PrintAndLogEx(NORMAL, _GREEN_("%-16s")" %s", Commands[i].Name, Commands[i].Help);
PrintAndLogEx(NORMAL, _GREEN_("%-*s") " %s", (int)max_name_len, Commands[i].Name, Commands[i].Help);
}
g_printAndLog = old_printAndLog;
}
+31
View File
@@ -846,6 +846,30 @@ bool OpenProxmark(pm3_device_t **dev, const char *port, bool wait_for_port, int
}
}
int SetHfFieldTimeout(uint32_t timeout_sec, bool quiet) {
if (g_session.pm3_present == false) {
return PM3_ENOTTY;
}
uint32_t timeout_ms = timeout_sec * 1000U;
clearCommandBuffer();
SendCommandNG(CMD_SET_HF_FIELD_TIMEOUT, (uint8_t *)&timeout_ms, sizeof(timeout_ms));
PacketResponseNG resp;
if (WaitForResponseTimeoutW(CMD_SET_HF_FIELD_TIMEOUT, &resp, 1000, false) == false) {
if (!quiet) {
PrintAndLogEx(WARNING, "timeout while setting HF field timeout");
}
return PM3_ETIMEOUT;
}
if (resp.status != PM3_SUCCESS && !quiet) {
PrintAndLogEx(WARNING, "HF field timeout command failed (%d)", resp.status);
}
return resp.status;
}
// check if we can communicate with Pm3
int TestProxmark(pm3_device_t *dev) {
@@ -921,6 +945,13 @@ int TestProxmark(pm3_device_t *dev) {
return res;
}
}
if (g_session.hf_field_timeout_sec > 0) {
int timeout_res = SetHfFieldTimeout(g_session.hf_field_timeout_sec, true);
if (timeout_res != PM3_SUCCESS) {
PrintAndLogEx(WARNING, "Failed to apply HF field timeout (" _YELLOW_("%u") " s)", g_session.hf_field_timeout_sec);
}
}
return PM3_SUCCESS;
}
+2
View File
@@ -120,6 +120,8 @@ bool WaitForResponseTimeoutW(uint32_t cmd, PacketResponseNG *response, size_t ms
bool WaitForResponseTimeout(uint32_t cmd, PacketResponseNG *response, size_t ms_timeout);
bool WaitForResponse(uint32_t cmd, PacketResponseNG *response);
int SetHfFieldTimeout(uint32_t timeout_sec, bool quiet);
//bool GetFromDevice(DeviceMemType_t memtype, uint8_t *dest, uint32_t bytes, uint32_t start_index, PacketResponseNG *response, size_t ms_timeout, bool show_warning);
bool GetFromDevice(DeviceMemType_t memtype, uint8_t *dest, uint32_t bytes, uint32_t start_index, uint8_t *data, uint32_t datalen, PacketResponseNG *response, size_t ms_timeout, bool show_warning);
+2
View File
@@ -45,6 +45,7 @@ const static vocabulary_t vocabulary[] = {
{ 1, "prefs get client.debug" },
{ 1, "prefs get client.delay" },
{ 1, "prefs get client.timeout" },
{ 1, "prefs get hf.field.timeout_sec" },
{ 1, "prefs get color" },
{ 1, "prefs get savepaths" },
{ 1, "prefs get emoji" },
@@ -57,6 +58,7 @@ const static vocabulary_t vocabulary[] = {
{ 1, "prefs set client.debug" },
{ 1, "prefs set client.delay" },
{ 1, "prefs set client.timeout" },
{ 1, "prefs set hf.field.timeout_sec" },
{ 1, "prefs set color" },
{ 1, "prefs set emoji" },
{ 1, "prefs set hints" },
+77
View File
@@ -102,6 +102,7 @@ int preferences_load(void) {
g_session.client_debug_level = cdbOFF;
// g_session.device_debug_level = ddbOFF;
g_session.timeout = uart_get_timeouts();
g_session.hf_field_timeout_sec = 0;
g_session.window_changed = false;
g_session.plot.x = 10;
@@ -329,6 +330,7 @@ void preferences_save_callback(json_t *root) {
*/
JsonSaveInt(root, "client.exe.delay", g_session.client_exe_delay);
JsonSaveInt(root, "client.timeout", g_session.timeout);
JsonSaveInt(root, "hf.field.timeout_sec", g_session.hf_field_timeout_sec);
// MQTT
JsonSaveStr(root, "mqtt.server", g_session.mqtt_server);
@@ -440,6 +442,10 @@ void preferences_load_callback(json_t *root) {
if (json_unpack_ex(root, &up_error, 0, "{s:i}", "client.timeout", &i1) == 0)
g_session.timeout = i1;
// persistent HF field timeout (seconds)
if (json_unpack_ex(root, &up_error, 0, "{s:i}", "hf.field.timeout_sec", &i1) == 0)
g_session.hf_field_timeout_sec = (i1 > 0) ? (uint32_t)i1 : 0;
// MQTT server
if (json_unpack_ex(root, &up_error, 0, "{s:s}", "mqtt.server", &s1) == 0)
setDefaultMqttServer(s1);
@@ -671,6 +677,14 @@ static void showClientTimeoutState(void) {
PrintAndLogEx(INFO, " communication timeout... " _GREEN_("%u") " ms", g_session.timeout);
}
static void showFieldTimeoutState(void) {
if (g_session.hf_field_timeout_sec == 0) {
PrintAndLogEx(INFO, " HF field timeout........ " _WHITE_("off"));
} else {
PrintAndLogEx(INFO, " HF field timeout........ " _GREEN_("%u") " s", g_session.hf_field_timeout_sec);
}
}
static void showMqttServer(prefShowOpt_t opt) {
if ((g_session.mqtt_server == NULL) || (strcmp(g_session.mqtt_server, "") == 0)) {
PrintAndLogEx(INFO, " MQTT server.............%s "_WHITE_("not set"), pref_show_status_msg(opt));
@@ -1067,6 +1081,50 @@ static int setCmdClientTimeout(const char *Cmd) {
return PM3_SUCCESS;
}
static int setCmdHfFieldTimeout(const char *Cmd) {
CLIParserContext *ctx;
CLIParserInit(&ctx, "prefs set hf.field.timeout_sec",
"Set persistent preference of PM3 HF field inactivity timeout",
"prefs set hf.field.timeout_sec --sec 0 --> disable HF field auto timeout\n"
"prefs set hf.field.timeout_sec --sec 5 --> turn HF field off after 5 seconds of inactivity\n"
"prefs set hf.field.timeout_sec --sec 300 --> turn HF field off after 5 minutes of inactivity\n"
"prefs set hf.field.timeout_sec --sec 900 --> turn HF field off after 15 minutes of inactivity\n");
void *argtable[] = {
arg_param_begin,
arg_int0("s", "sec", "<sec>", "HF field inactivity timeout in seconds"),
arg_param_end
};
CLIExecWithReturn(ctx, Cmd, argtable, true);
int32_t arg = arg_get_int_def(ctx, 1, -1);
CLIParserFree(ctx);
if (arg < 0) {
showFieldTimeoutState();
return PM3_SUCCESS;
}
uint32_t new_value = (uint32_t)arg;
if (g_session.hf_field_timeout_sec != new_value) {
showFieldTimeoutState();
g_session.hf_field_timeout_sec = new_value;
showFieldTimeoutState();
preferences_save();
} else {
showFieldTimeoutState();
}
if (g_session.pm3_present) {
int res = SetHfFieldTimeout(g_session.hf_field_timeout_sec, false);
if (res != PM3_SUCCESS) {
PrintAndLogEx(WARNING, "Failed to apply HF field timeout to connected PM3");
}
}
return PM3_SUCCESS;
}
static int setCmdHint(const char *Cmd) {
CLIParserContext *ctx;
@@ -1517,6 +1575,22 @@ static int getCmdClientTimeout(const char *Cmd) {
return PM3_SUCCESS;
}
static int getCmdHfFieldTimeout(const char *Cmd) {
CLIParserContext *ctx;
CLIParserInit(&ctx, "prefs get hf.field.timeout_sec",
"Get preference of PM3 HF field inactivity timeout",
"prefs get hf.field.timeout_sec"
);
void *argtable[] = {
arg_param_begin,
arg_param_end
};
CLIExecWithReturn(ctx, Cmd, argtable, true);
CLIParserFree(ctx);
showFieldTimeoutState();
return PM3_SUCCESS;
}
static int getCmdMqtt(const char *Cmd) {
CLIParserContext *ctx;
CLIParserInit(&ctx, "prefs get mqtt",
@@ -1540,6 +1614,7 @@ static command_t CommandTableGet[] = {
{"client.debug", getCmdDebug, AlwaysAvailable, "Get client debug level preference"},
{"client.delay", getCmdExeDelay, AlwaysAvailable, "Get client execution delay preference"},
{"client.timeout", getCmdClientTimeout, AlwaysAvailable, "Get client execution delay preference"},
{"hf.field.timeout_sec", getCmdHfFieldTimeout, AlwaysAvailable, "Get PM3 HF field inactivity timeout preference"},
{"color", getCmdColor, AlwaysAvailable, "Get color support preference"},
{"savepaths", getCmdSavePaths, AlwaysAvailable, "Get file folder "},
// {"devicedebug", getCmdDeviceDebug, AlwaysAvailable, "Get device debug level"},
@@ -1557,6 +1632,7 @@ static command_t CommandTableSet[] = {
{"client.debug", setCmdDebug, AlwaysAvailable, "Set client debug level"},
{"client.delay", setCmdExeDelay, AlwaysAvailable, "Set client execution delay"},
{"client.timeout", setCmdClientTimeout, AlwaysAvailable, "Set client communication timeout"},
{"hf.field.timeout_sec", setCmdHfFieldTimeout, AlwaysAvailable, "Set PM3 HF field inactivity timeout"},
{"color", setCmdColor, AlwaysAvailable, "Set color support"},
{"emoji", setCmdEmoji, AlwaysAvailable, "Set emoji display"},
@@ -1630,6 +1706,7 @@ static int CmdPrefShow(const char *Cmd) {
showClientExeDelayState();
showOutputState(prefShowNone);
showClientTimeoutState();
showFieldTimeoutState();
showMqttServer(prefShowNone);
showMqttPort(prefShowNone);
showMqttTopic(prefShowNone);
+1
View File
@@ -63,6 +63,7 @@ typedef struct {
char *history_path;
pm3_device_t *current_device;
uint32_t timeout;
uint32_t hf_field_timeout_sec;
char *mqtt_server;
char *mqtt_port;
char *mqtt_topic;