Button Command Handlers

Functions
static ERR_te	button_getpushed_handler (uint32_t argc, char **argv)
	CLI handler for the "getpushed" command. Reports the debounced pushed state of a button.
static ERR_te	button_getheld_handler (uint32_t argc, char **argv)
	CLI handler for the "getheld" command. Reports the held state of a button.
static ERR_te	button_cmd_info_handler (uint32_t argc, char **argv)
	CLI handler for the "info" command. Logs the names of all registered buttons.

Detailed Description

Function Documentation

button_getpushed_handler()

ERR_te button_getpushed_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "getpushed" command. Reports the debounced pushed state of a button.

Expected invocation: button getpushed <name>

Searches the registered button pool for a handle whose name matches argv[2], then calls button_get_pushed_state and logs the result.

Parameters

[in]	argc	Argument count. Must be exactly 3.
[in]	argv	Argument list: argv[0] = "button", argv[1] = "getpushed", argv[2] = button name.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 3 or no button with the given name exists
• Propagated error from button_get_pushed_state on failure

Definition at line 574 of file button.c.

                                                                   {
    if(argc != 3) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "button_getpushed_handler: invalid arguments"
        );
        return ERR_INVALID_ARGUMENT;
    }
 
    for(uint32_t i = 0; i < CONFIG_BUTTON_MAX_OBJECTS; i++) {
        if(str_cmp(argv[2], internal_state.buttons[i].name) == true) {
            bool pushed_state;
            ERR_te err = button_get_pushed_state(&internal_state.buttons[i], &pushed_state);
            if(err != ERR_OK) {
                return err;
            }
 
            LOG_INFO(
                internal_state.subsys,
                internal_state.log_level,
                "button_getpushed_handler: %s pushed state: %d",
                internal_state.buttons[i].name,
                pushed_state
            );
 
            return ERR_OK;
        }
 
        if(i == internal_state.button_num - 1) {
            LOG_ERROR(
                internal_state.subsys,
                internal_state.log_level, 
                "button_getpushed_handler: invalid arguments"
            );
            return ERR_INVALID_ARGUMENT;
        }
    }
 
    return ERR_OK;
}

Here is the call graph for this function:

button_getheld_handler()

ERR_te button_getheld_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "getheld" command. Reports the held state of a button.

Expected invocation: button getheld <name>

Searches the registered button pool for a handle whose name matches argv[2], then calls button_get_held_state and logs the result.

Parameters

[in]	argc	Argument count. Must be exactly 3.
[in]	argv	Argument list: argv[0] = "button", argv[1] = "getheld", argv[2] = button name.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 3 or no button with the given name exists
• Propagated error from button_get_held_state on failure

Definition at line 634 of file button.c.

                                                                 {
    if(argc != 3) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "button_getheld_handler: invalid arguments"
        );
        return ERR_INVALID_ARGUMENT;
    }
 
    for(uint32_t i = 0; i < CONFIG_BUTTON_MAX_OBJECTS; i++) {
        if(str_cmp(argv[2], internal_state.buttons[i].name) == true) {
            bool held_state;
            ERR_te err = button_get_held_state(&internal_state.buttons[i], &held_state);
            if(err != ERR_OK) {
                return err;
            }
 
            LOG_INFO(
                internal_state.subsys,
                internal_state.log_level,
                "button_getheld_handler: %s held state: %d",
                internal_state.buttons[i].name,
                held_state
            );
 
            return ERR_OK;
        }
 
        if(i == internal_state.button_num - 1) {
            LOG_ERROR(
                internal_state.subsys,
                internal_state.log_level, 
                "button_getheld_handler: invalid arguments"
            );
            return ERR_INVALID_ARGUMENT;
        }
    }
 
    return ERR_OK;
}

Here is the call graph for this function:

button_cmd_info_handler()

ERR_te button_cmd_info_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "info" command. Logs the names of all registered buttons.

Expected invocation: button info

Iterates over the internal button pool and logs the name of every slot that is currently in use.

Parameters

[in]	argc	Argument count. Must be exactly 2.
[in]	argv	Argument list: argv[0] = "button", argv[1] = "info".

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 2

Definition at line 692 of file button.c.

                                                                  {
    if(argc != 2) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "button_cmd_info_handler: invalid arguments"
        );
        return ERR_INVALID_ARGUMENT;        
    }
 
    LOG_INFO(internal_state.subsys, internal_state.log_level, "Printing button information:");
 
    for(uint32_t i = 0; i < CONFIG_BUTTON_MAX_OBJECTS; i++) {
        if(internal_state.buttons[i].in_use == true) {
            LOG_INFO(
                internal_state.subsys, 
                internal_state.log_level,
                "name: %s", 
                internal_state.buttons[i].name
            );
        }
    }
 
    return ERR_OK;
}