SSD1309 Command Handlers

Functions
static ERR_te	ssd1309_cmd_start_handler (uint32_t argc, char **argv)
	CLI handler for the "start" command. Starts the SSD1309 subsystem at runtime.
static ERR_te	ssd1309_cmd_stop_handler (uint32_t argc, char **argv)
	CLI handler for the "stop" command. Stops the SSD1309 subsystem at runtime.
static ERR_te	ssd1309_cmd_fillrect_handler (uint32_t argc, char **argv)
	CLI handler for the "fillrect" command. Fills a rectangle and updates the display.
static ERR_te	ssd1309_cmd_clearrect_handler (uint32_t argc, char **argv)
	CLI handler for the "clearrect" command. Clears a rectangle and updates the display.
static ERR_te	ssd1309_cmd_invertrect_handler (uint32_t argc, char **argv)
	CLI handler for the "invertrect" command. Inverts a rectangle and updates the display.
static ERR_te	ssd1309_cmd_drawtext_handler (uint32_t argc, char **argv)
	CLI handler for the "drawtext" command. Draws text on a line and updates the display.
static ERR_te	ssd1309_cmd_clearline_handler (uint32_t argc, char **argv)
	CLI handler for the "clearline" command. Clears a line and updates the display.
static ERR_te	ssd1309_cmd_invertline_handler (uint32_t argc, char **argv)
	CLI handler for the "invertline" command. Inverts a line and updates the display.

Detailed Description

Function Documentation

ssd1309_cmd_start_handler()

ERR_te ssd1309_cmd_start_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "start" command. Starts the SSD1309 subsystem at runtime.

Expected invocation: ssd1309 start

Parameters

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

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 2

Definition at line 1111 of file ssd1309.c.

                                                                    {   
    if(argc != 2) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_start_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    internal_state.started = true;
 
    return ERR_OK;
}

ssd1309_cmd_stop_handler()

ERR_te ssd1309_cmd_stop_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "stop" command. Stops the SSD1309 subsystem at runtime.

Expected invocation: ssd1309 stop

Parameters

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

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 2

Definition at line 1140 of file ssd1309.c.

                                                                   {
    if(argc != 2) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_stop_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    internal_state.started = false;
 
    return ERR_OK;
}

ssd1309_cmd_fillrect_handler()

ERR_te ssd1309_cmd_fillrect_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "fillrect" command. Fills a rectangle and updates the display.

Expected invocation: ssd1309 fillrect <x1> <y1> <x2> <y2>

Coordinates are 1-based. Calls ssd1309_draw_rect with force=true, then ssd1309_update with force=true.

Parameters

[in]	argc	Argument count. Must be exactly 6.
[in]	argv	argv[2]–argv[5] = x1, y1, x2, y2 as decimal strings.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 6 or coordinates are out of range

Definition at line 1172 of file ssd1309.c.

                                                                       {
    ERR_te err;
    
    if(argc != 6) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_fillrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    int x1 = str_to_int(argv[2]);
    int y1 = str_to_int(argv[3]);
    int x2 = str_to_int(argv[4]);
    int y2 = str_to_int(argv[5]);
 
    if(
        (x1 < 1 || x1 > SSD1309_WIDTH) ||
        (y1 < 1 || y1 > SSD1309_HEIGHT) ||
        (x2 < 1 || x2 > SSD1309_WIDTH) ||
        (y2 < 1 || y2 > SSD1309_HEIGHT)
    ) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_fillrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    err = ssd1309_draw_rect(x1, y1, x2, y2, true);
    if(err != ERR_OK) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_fillrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    ssd1309_update(true);
    
    return ERR_OK;
}

Here is the call graph for this function:

ssd1309_cmd_clearrect_handler()

ERR_te ssd1309_cmd_clearrect_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "clearrect" command. Clears a rectangle and updates the display.

Expected invocation: ssd1309 clearrect <x1> <y1> <x2> <y2>

Parameters

[in]	argc	Argument count. Must be exactly 6.
[in]	argv	argv[2]–argv[5] = x1, y1, x2, y2 as decimal strings.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 6 or coordinates are out of range

Definition at line 1234 of file ssd1309.c.

                                                                        {
    ERR_te err;
    
    if(argc != 6) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_clearrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    int x1 = str_to_int(argv[2]);
    int y1 = str_to_int(argv[3]);
    int x2 = str_to_int(argv[4]);
    int y2 = str_to_int(argv[5]);
 
    if(
        (x1 < 1 || x1 > SSD1309_WIDTH) ||
        (y1 < 1 || y1 > SSD1309_HEIGHT) ||
        (x2 < 1 || x2 > SSD1309_WIDTH) ||
        (y2 < 1 || y2 > SSD1309_HEIGHT)
    ) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_clearrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    err = ssd1309_clear_rect(x1, y1, x2, y2, true);
    if(err != ERR_OK) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_clearrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    ssd1309_update(true);
    
    return ERR_OK;
}

Here is the call graph for this function:

ssd1309_cmd_invertrect_handler()

ERR_te ssd1309_cmd_invertrect_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "invertrect" command. Inverts a rectangle and updates the display.

Expected invocation: ssd1309 invertrect <x1> <y1> <x2> <y2>

Parameters

[in]	argc	Argument count. Must be exactly 6.
[in]	argv	argv[2]–argv[5] = x1, y1, x2, y2 as decimal strings.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 6 or coordinates are out of range

Definition at line 1296 of file ssd1309.c.

                                                                         {
    ERR_te err;
    
    if(argc != 6) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_invertrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    int x1 = str_to_int(argv[2]);
    int y1 = str_to_int(argv[3]);
    int x2 = str_to_int(argv[4]);
    int y2 = str_to_int(argv[5]);
 
    if(
        (x1 < 1 || x1 > SSD1309_WIDTH) ||
        (y1 < 1 || y1 > SSD1309_HEIGHT) ||
        (x2 < 1 || x2 > SSD1309_WIDTH) ||
        (y2 < 1 || y2 > SSD1309_HEIGHT)
    ) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_invertrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    err = ssd1309_invert_rect(x1, y1, x2, y2, true);
    if(err != ERR_OK) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_invertrect_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    ssd1309_update(true);
    
    return ERR_OK;
}

Here is the call graph for this function:

ssd1309_cmd_drawtext_handler()

ERR_te ssd1309_cmd_drawtext_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "drawtext" command. Draws text on a line and updates the display.

Expected invocation: ssd1309 drawtext <text> <line>

Parameters

[in]	argc	Argument count. Must be exactly 4.
[in]	argv	argv[2] = text string, argv[3] = line number (1–8) as decimal string.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 4 or line is out of range
• Propagated error from ssd1309_draw_text on failure

Definition at line 1359 of file ssd1309.c.

                                                                       {
    ERR_te err;
 
    if(argc != 4) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_drawtext_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    uint8_t line = str_to_int(argv[3]);
    if(line > SSD1309_MAX_LINES) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_drawtext_handler: invalid arguments"
        );  
 
        return ERR_INVALID_ARGUMENT;
    }
 
    err = ssd1309_draw_text(argv[2], get_str_len(argv[2]), line, true);
    if(err != ERR_OK) {
        return err;
    }
 
    ssd1309_update(true);
 
    return ERR_OK;
}

Here is the call graph for this function:

ssd1309_cmd_clearline_handler()

ERR_te ssd1309_cmd_clearline_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "clearline" command. Clears a line and updates the display.

Expected invocation: ssd1309 clearline <line>

Parameters

[in]	argc	Argument count. Must be exactly 3.
[in]	argv	argv[2] = line number (1–8) as decimal string.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 3 or line is out of range
• Propagated error from ssd1309_clear_line on failure

Definition at line 1407 of file ssd1309.c.

                                                                        {
    ERR_te err;
 
    if(argc != 3) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_clearline_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    uint8_t line = str_to_int(argv[2]);
    if(line > SSD1309_MAX_LINES) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_clearline_handler: invalid arguments"
        );  
 
        return ERR_INVALID_ARGUMENT;
    }
 
    err = ssd1309_clear_line(line, true);
    if(err != ERR_OK) {
        return err;
    }
 
    ssd1309_update(true);
 
    return ERR_OK;
}

Here is the call graph for this function:

ssd1309_cmd_invertline_handler()

ERR_te ssd1309_cmd_invertline_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "invertline" command. Inverts a line and updates the display.

Expected invocation: ssd1309 invertline <line>

Parameters

[in]	argc	Argument count. Must be exactly 3.
[in]	argv	argv[2] = line number (1–8) as decimal string.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 3 or line is out of range
• Propagated error from ssd1309_invert_line on failure

Definition at line 1455 of file ssd1309.c.

                                                                         {
    ERR_te err;
 
    if(argc != 3) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_invertline_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    uint8_t line = str_to_int(argv[2]);
    if(line > SSD1309_MAX_LINES) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "ssd1309_cmd_invertline_handler: invalid arguments"
        );  
 
        return ERR_INVALID_ARGUMENT;
    }
 
    err = ssd1309_invert_line(line, true);
    if(err != ERR_OK) {
        return err;
    }
 
    ssd1309_update(true);
 
    return ERR_OK;
}

Here is the call graph for this function: