Microchip® Advanced Software Framework

lcd.h File Reference
#include "compiler.h"
#include "FreeRTOS.h"
#include "shell.h"
#include "datalog.h"

Functions

bool b_lcd_get_value (xLogDef *pxLog)
 Get the lcd current value. More...
 
eExecStatus e_lcd_set_value (eModId xModId, int ac, signed portCHAR *av[], signed portCHAR **ppcStringReply)
 Set the user msg area of the lcd. Takes up to four parameters the first parameter is the usrmsg parameter, the second parameter is its value, the third is the time parameter(optional), the fourth is the time value(optional). Format: set_actuator_value actuator=lcd usrmsg=msg [time=date]. More...
 

bool b_lcd_get_value ( xLogDef pxLog)

Get the lcd current value.

Parameters
pxLoga Log structure.
Returns
true upon success, false if error.

References CRLF, NULL, LogDef::pcStringLog, LogDef::pfFreeStringLog, and SHELL_EXECSTATUS_OK_NO_FREE.

eExecStatus e_lcd_set_value ( eModId  xModId,
int  ac,
signed portCHAR *  av[],
signed portCHAR **  ppcStringReply 
)

Set the user msg area of the lcd. Takes up to four parameters the first parameter is the usrmsg parameter, the second parameter is its value, the third is the time parameter(optional), the fourth is the time value(optional). Format: set_actuator_value actuator=lcd usrmsg=msg [time=date].

Parameters
xModIdInput. The module that is calling this function.
acInput. The argument counter. For this command, should be at least 2, at most 4.
avInput. The argument vector.
ppcStringReplyInput/Output. The response string. If Input is NULL, no response string will be output. If the action is successful, no response string is output. If the action failed, a response string is output.
Returns
the status of the command execution.

References ACTUATOR_ERRMSG_SETVAL_SYNTAXERROR, CPTIME_SCHEDCMDID_SETLCDVAL, e_actuator_ScheduleCmdSet(), SHELL_EXECSTATUS_KO, SHELL_EXECSTATUS_OK, SHELL_EXECSTATUS_OK_NO_FREE, and vMMI_UserMessDisplay().

Referenced by vExecScheduledSet().