Implement support for new M291 message box modes

[mfs12]

Description

Description

Refer to

• https://docs.duet3d.com/en/User_manual/Reference/Gcodes#m291-display-message-and-optionally-wait-for-response
• https://github.com/Duet3D/RepRapFirmware/wiki/Object-Model-Documentation-Beta-&-RC#statemessagebox

implement new message box modes and parameters.

new message box modes

• S4 / choices - Display a number of choices. The names of the choices are given by the K parameter as an array of strings.
• S5 / integer value
  • L - is the minimum accepted value (default 0),
  • H - is the maximum accepted value (default unlimited), and
  • F - is the default value
• S6 / float value
  • L - is the minimum accepted value (default 0),
  • H - is the maximum accepted value (default unlimited), and
  • F - is the default value
• S7 / string value
  • L - is the minimum accepted length (default 0),
  • H - is the maximum accepted length (default unlimited), and
  • F - is the default value

new message box parameters

• cancelButton, message box mode 2 / 3
• choices - string
• default - integer, float or string
• max - integer, float or string
• min - integer, float or string
• seq - integer

[mfs12]

definition of the messageBox object in the object model:

{ "axisControls", OBJECT_MODEL_FUNC_IF(self->mode == 2 || self->mode == 3, (int32_t)self->controls.GetRaw()),   ObjectModelEntryFlags::important },
{ "cancelButton", OBJECT_MODEL_FUNC(self->limits.canCancel), ObjectModelEntryFlags::important },
{ "choices", OBJECT_MODEL_FUNC_IF(self->mode == 4, self->limits.choices),   ObjectModelEntryFlags::important },
{ "default", OBJECT_MODEL_FUNC_IF(self->mode >= 4, self->limits.defaultVal),    ObjectModelEntryFlags::important },
{ "max", OBJECT_MODEL_FUNC_IF(self->mode >= 5, self->limits.maxVal), ObjectModelEntryFlags::important },
{ "message", OBJECT_MODEL_FUNC(self->message.c_str()), ObjectModelEntryFlags::important },
{ "min", OBJECT_MODEL_FUNC_IF(self->mode >= 5, self->limits.minVal), ObjectModelEntryFlags::important },
{ "mode", OBJECT_MODEL_FUNC((int32_t)self->mode), ObjectModelEntryFlags::important },
{ "seq", OBJECT_MODEL_FUNC((int32_t)self->seq), ObjectModelEntryFlags::important },
{ "timeout", OBJECT_MODEL_FUNC((int32_t)self->timeout), ObjectModelEntryFlags::important },
{ "title", OBJECT_MODEL_FUNC(self->title.c_str()), ObjectModelEntryFlags::important }

@dc42 wrote:

The cancelButton, choices, default, min and max fields are new in 3.5. The mode field can take new values in 3.5. See M291 in the GCodes wiki for the new mode values and the values of the new fields.

[mfs12]

@dc42 what is the max number of choices? which string length shall each have?

[mfs12]

@dc42 is there a max length of strings to enter? if so what is it?

[dc42]

The only limits currently are:

1. Maximum length of any GCode command, including M291 commands. This is currently 256 bytes. However, a command that uses variable substitution could exceed this limit.
2. Currently, indiividual strings can't exceed 100 characters each. However, this is about to be increased to 256.

I suggest you define and we document a maximum length of each string and a maximum number of choices that can be displayed on PanelDue. This number could be lower on the 4.3" display than on the 5" and 7". Longer strings should be truncated, which the text writing functions on PanelDue do anyway.

[mfs12]

well just wondering... with all the statically allocated memory perhaps i should check overall memory consumption. In general i would suggest a limit of 32 including terminating 0 as decent limit for choices.

[dc42]

That sounds reasonable. What length text will fit on the 800x480 screen of the 5" and 7" displays?