display_models#

class display_models.DisplayModels[source]#

Bases: object

display models and tooltips

Args:

object (object): base object specialization

argument_table_tooltip_dict = {'CHAR': '8-bit char', 'FLOAT': '32-bit float', 'INT16_T': '16-bit signed integer', 'NOTYPE': 'no type validation', 'NO_ARGS': 'no arguments expected', 'START_STOP': 'array of 8-bit char', 'UINT16_T': '16-bit unsigned integer', 'UINT32_T': '32-bit unsigned integer', 'UINT8_T': '8-bit unsigned integer'}#
command_table_tooltip_dict = {'commandArgumentHandling': 'commandArgumentHandling is the main indicator of how this command will handle incoming arguments.', 'commandArguments': 'commandArguments is the array of argument types this command expects.', 'commandDepth': "commandDepth is this command's depth in the command tree.", 'commandHasWildcards': 'commandHasWildcards is a boolean indicator of whether or not this command has wildcard characters in it.', 'commandId': "commandId is this command's ID.", 'commandLength': 'commandLength is the total number of characters in the command.', 'commandMaxArgs': 'commandMaxArgs is the MAXIMUM number of arguments you can send this command before it will stop triggering.', 'commandMinArgs': 'commandMinArgs is the MINIMUM number of arguments you can send this command to trigger it.', 'commandString': 'commandString is the string of characters that triggers the execution of designated command when received and processed.', 'commandSubcommands': 'commandSubcommands is the number of subcommands this command will have, regardless of their depth in the command tree.', 'functionName': "functionName is the name of the function internal to the cli, it is a combination of your command string and this function's unique id.", 'parentId': "parentId is this command's parent ID.", 'returnFunctionName': 'returnFunctionName is blank unless your command has arguments; it is the name of the function that you copy into your code to do things with the arguments you collect for that function.'}#