mui.gotoForm(), initial_cursor_position - how to work with this?

[ViacheslavK9]

Happy new year!

So, this method has two params - the formId and the initial_cursor_position.
FormId is clear and it works as expected, but how to work with the second param?

I tried giving different "straight" values to it (1,2,3, etc.) - but no effect.

Can you please suggest how to work with this?

Important Update: I am trying to jump to the form which only has one element: Scrollable Jump Table (dynamic).

Thanks!

[ViacheslavK9]

I think i find root of my confusion - gotoForm works well with the initial_cursor_position if i do this in a loop section like this:

  if ( mui.isFormActive() ) {
   ...
  }
  else {
      //mui.gotoForm(1, GetCacheFormPosition(mui.getMUI(), 1));
  }

but it does not work well if i use it like a code in a function on MUIF_RO with MUI_AUX element.

In both cases i link additional form which either has mui_u8g2_btn_exit_wm_fi button (first case --works) either MUIF_RO with MUI_AUX (not working).

[ViacheslavK9]

below is the full code for the not working case (if go back - it jumps either on first element either on second = weird logic):

#include <Arduino.h>
#include <U8g2lib.h>
#include <MUIU8g2.h>
#include <LoRa.h>
#include <Versatile_RotaryEncoder.h>

// Set here your encoder reading pins
#define clk A2
#define dt A3
#define sw A4

// Create encoder object
Versatile_RotaryEncoder versatile_encoder(clk, dt, sw);  //1%

//20%
U8G2_SSD1306_128X64_NONAME_1_HW_I2C u8g2(U8G2_R2, /* reset=*/U8X8_PIN_NONE, /* clock=*/16, /* data=*/17);  // ESP32 Thing, HW I2C with pin remapping

MUIU8G2 mui;

const PROGMEM long Frequency = 915E6;

//адреса устройств
const byte EndDeviceAddress[6] = { 0xB1, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6 };
const PROGMEM byte ControlDevice = 0xFF;

uint16_t SelectedDevice, SelectedTestMode;

uint8_t is_redraw = 1;
uint8_t rotate_event = 0;      // 0 = not turning, 1 = CW, 2 = CCW
uint8_t press_event = 0;       // 0 = not pushed, 1 = pushed
uint8_t long_press_event = 0;  // 0 = not pushed, 1 = pushed

// Functions prototyping to be handled on each Encoder Event
void handleRotate(int8_t rotation) {
  if (rotation > 0)
    rotate_event = 2;  // CW
  else
    rotate_event = 1;  // CCW
}

void handlePressRelease() {
  press_event = 1;
}

void handleLongPressRelease() {
  long_press_event = 1;
}

const char *menu_devices_get_str(void *data, uint16_t index) {
  static const char *menu[] = {
    MUI_11 "Device 1",
    MUI_11 "Device 2",
    MUI_11 "Device 3",
    MUI_11 "Device 4",
    MUI_11 "Device 5",
    MUI_11 "Device 6"
  };
  return menu[index];
}

uint16_t menu_devices_get_cnt(void *data) {
  return 6; /* number of main menu entries */
}

const char *menu_action_get_str(void *data, uint16_t index) {
  static const char *menu[] = {
    MUI_21 "Test connect",
    MUI_22 "Battery",
    MUI_23 "Timer",
    MUI_25 "Back..",
  };
  return menu[index];
}

uint16_t menu_action_get_cnt(void *data) {
  return 4; /* number of menu entries */
}

uint8_t mui_hrule(mui_t *ui, uint8_t msg) {
  if (msg == MUIF_MSG_DRAW) {
    u8g2.drawHLine(0, mui_get_y(ui), u8g2.getDisplayWidth());

    //Serial.println(String(selection2));
  }
  return 0;
}

void ByteToChar(byte FromByte, char DeviceCode[])
{
  byte nib1 = (FromByte >> 4) & 0x0F;
  byte nib2 = (FromByte >> 0) & 0x0F;

  DeviceCode[0] = nib1  < 0xA ? '0' + nib1  : 'A' + nib1  - 0xA;
  DeviceCode[1] = nib2  < 0xA ? '0' + nib2  : 'A' + nib2  - 0xA;

  DeviceCode[2] = '\0';
}

uint8_t mui_draw_current_device(mui_t *ui, uint8_t msg) {
  char ForMessage[30] = "Device #";
  char LocDeviceNo[2];
  char LocDeviceCode[3];
  byte LocByte;
  if (msg == MUIF_MSG_DRAW) {
    u8g2.setCursor(mui_get_x(ui), mui_get_y(ui));

    itoa(SelectedDevice + 1, LocDeviceNo, 10);
    
    strcat(ForMessage, LocDeviceNo);

      if (mui_GetCurrentFormId(ui) == 11) {

        LocByte = EndDeviceAddress[SelectedDevice];

         ByteToChar(LocByte, LocDeviceCode);
         strcat(ForMessage, "         code:");
         strcat(ForMessage, LocDeviceCode);
        
         u8g2.print(ForMessage);

     } else u8g2.print(ForMessage);
  }
  //Serial.println(ForMessage);
  return 0;
}

void clearFormPositionCache(mui_t *mui, uint8_t form_id) {
  uint8_t i;
  for (i = 0; i < MUI_MENU_CACHE_CNT; i++)
    if (mui->menu_form_id[i] == form_id)
      mui->menu_form_cursor_focus_position[i] = 0;
}

uint8_t GetCacheFormPosition(mui_t *mui, uint8_t form_id) {
  uint8_t i;
  for (i = 0; i < MUI_MENU_CACHE_CNT; i++) {
    Serial.println(String(mui->menu_form_id[i]) + "|mui_go_main_menu " + mui->menu_form_cursor_focus_position[i]);

    if (mui->menu_form_id[i] == form_id)
      return (mui->menu_form_cursor_focus_position[i]);
  }
}

void ClearTestVars() {
  //DiodeResult = false;
  //MainDiodeResult = false;
  //SentPacketTime = 0;
}

uint8_t mui_go_device_menu(mui_t *ui, uint8_t msg) {
 // char SelectedTestModeLoc[2];
 // char DebugMessage[30] = "mui_go_device_menu: ";

  if (msg == MUIF_MSG_FORM_START) {

    clearFormPositionCache(mui.getMUI(), 11);  // always reset the position for "form" 11

    
    // itoa(SelectedTestMode + 1, SelectedTestModeLoc, 10);
    // strcat(DebugMessage, SelectedTestModeLoc);

    // Serial.println(DebugMessage);

    mui.gotoForm(1, GetCacheFormPosition(mui.getMUI(), 1)); //DIFF!
    
    //mui.gotoForm(1, 2);
    //mui.sendSelectWithExecuteOnSelectFieldSearch();//DIFF!
  }
  return 0;
}

muif_t muif_list[] = {
  MUIF_U8G2_FONT_STYLE(1, u8g2_font_helvR08_tr),
  MUIF_RO("HR", mui_hrule),
  MUIF_U8G2_LABEL(),
  MUIF_U8G2_U16_LIST("ID", &SelectedDevice, NULL, menu_devices_get_str, menu_devices_get_cnt, mui_u8g2_u16_list_goto_w1_pi),
  MUIF_U8G2_U16_LIST("AC", &SelectedTestMode, NULL, menu_action_get_str, menu_action_get_cnt, mui_u8g2_u16_list_goto_w1_pi),

  MUIF_RO("DD", mui_draw_current_device),

  MUIF_RO("GG", mui_go_device_menu),
  //MUIF_EXECUTE_ON_SELECT_BUTTON("ST", mui_u8g2_btn_exit_wm_fi), //DIFF!

  MUIF_RO("00", ClearTestVars),
};

fds_t fds_data[] =
  //-------------main menu
  MUI_FORM(1)
  MUI_STYLE(1)

  MUI_LABEL(5, 8, "Choose:")
  MUI_XY("HR", 0, 11)

  MUI_XYA("ID", 5, 24, 0)
  MUI_XYA("ID", 5, 36, 1)
  MUI_XYA("ID", 5, 48, 2)
  MUI_XYA("ID", 5, 60, 3)

  //--------------device actions
  MUI_FORM(11)
  MUI_STYLE(1)

  MUI_XY("HR", 0, 11)
  MUI_XY("DD", 5, 8)

  //clear vars
  MUI_AUX("00")

  MUI_XYA("AC", 5, 24, 0)
  MUI_XYA("AC", 5, 36, 1)
  MUI_XYA("AC", 5, 48, 2)
  MUI_XYA("AC", 5, 60, 3)

  //additional jump form
  MUI_FORM(25)
  MUI_STYLE(1)
  MUI_AUX("GG")
  //MUI_XYAT("ST", 5, 24, 1, "Exit")//DIFF!
  
  ;

void setup() {
  Serial.begin(9600);  // initialize serial
  while (!Serial);

  // Load to the encoder all nedded handle functions here (up to 9 functions)
  versatile_encoder.setHandleRotate(handleRotate);
  versatile_encoder.setHandlePressRelease(handlePressRelease);
  versatile_encoder.setHandleLongPressRelease(handleLongPressRelease);

  u8g2.begin();  //2%
  u8g2.enableUTF8Print();

  mui.begin(u8g2, fds_data, muif_list, sizeof(muif_list) / sizeof(muif_t));
  mui.gotoForm(/* form_id= */ 1, /* initial_cursor_position= */ 0);
}

void handle_events(void) {
  // 0 = not pushed, 1 = pushed
  if (press_event == 1) {
    mui.sendSelect();
    is_redraw = 1;
    press_event = 0;
  }

  // 0 = not pushed, 1 = pushed
  if (long_press_event == 1) {
    mui.sendSelectWithExecuteOnSelectFieldSearch();
    is_redraw = 1;
    long_press_event = 0;
  }

  // 0 = not turning, 1 = CW, 2 = CCW
  if (rotate_event == 1) {
    mui.nextField();
    is_redraw = 1;
    rotate_event = 0;
  }

  if (rotate_event == 2) {
    mui.prevField();
    is_redraw = 1;
    rotate_event = 0;
  }
}


void loop() {
  if ( mui.isFormActive() ) {
    if (is_redraw) {
      u8g2.firstPage();
      do {
        versatile_encoder.ReadEncoder();  // Do the encoder reading and processing
        mui.draw();
        versatile_encoder.ReadEncoder();  // Do the encoder reading and processing
      } while (u8g2.nextPage());
      is_redraw = 0; /* clear the redraw flag */
    }
  }
  else {
      /* the menu should never become inactive, but if so, then restart the menu system */
      //mui.gotoForm(1, GetCacheFormPosition(mui.getMUI(), 1)); //DIFF!
  }

  versatile_encoder.ReadEncoder();  // Do the encoder reading and processing
  handle_events();
}

[ViacheslavK9]

and here is the full code for working case (just a little difference comparing to the example above)
Differences marked with comment DIFF! = only five lines comment/uncomment difference.

#include <Arduino.h>
#include <U8g2lib.h>
#include <MUIU8g2.h>
#include <LoRa.h>
#include <Versatile_RotaryEncoder.h>

// Set here your encoder reading pins
#define clk A2
#define dt A3
#define sw A4

// Create encoder object
Versatile_RotaryEncoder versatile_encoder(clk, dt, sw);  //1%

//20%
U8G2_SSD1306_128X64_NONAME_1_HW_I2C u8g2(U8G2_R2, /* reset=*/U8X8_PIN_NONE, /* clock=*/16, /* data=*/17);  // ESP32 Thing, HW I2C with pin remapping

MUIU8G2 mui;

const PROGMEM long Frequency = 915E6;

//адреса устройств
const byte EndDeviceAddress[6] = { 0xB1, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6 };
const PROGMEM byte ControlDevice = 0xFF;

uint16_t SelectedDevice, SelectedTestMode;

uint8_t is_redraw = 1;
uint8_t rotate_event = 0;      // 0 = not turning, 1 = CW, 2 = CCW
uint8_t press_event = 0;       // 0 = not pushed, 1 = pushed
uint8_t long_press_event = 0;  // 0 = not pushed, 1 = pushed

// Functions prototyping to be handled on each Encoder Event
void handleRotate(int8_t rotation) {
  if (rotation > 0)
    rotate_event = 2;  // CW
  else
    rotate_event = 1;  // CCW
}

void handlePressRelease() {
  press_event = 1;
}

void handleLongPressRelease() {
  long_press_event = 1;
}

const char *menu_devices_get_str(void *data, uint16_t index) {
  static const char *menu[] = {
    MUI_11 "Device 1",
    MUI_11 "Device 2",
    MUI_11 "Device 3",
    MUI_11 "Device 4",
    MUI_11 "Device 5",
    MUI_11 "Device 6"
  };
  return menu[index];
}

uint16_t menu_devices_get_cnt(void *data) {
  return 6; /* number of main menu entries */
}

const char *menu_action_get_str(void *data, uint16_t index) {
  static const char *menu[] = {
    MUI_21 "Test connect",
    MUI_22 "Battery",
    MUI_23 "Timer",
    MUI_25 "Back..",
  };
  return menu[index];
}

uint16_t menu_action_get_cnt(void *data) {
  return 4; /* number of menu entries */
}

uint8_t mui_hrule(mui_t *ui, uint8_t msg) {
  if (msg == MUIF_MSG_DRAW) {
    u8g2.drawHLine(0, mui_get_y(ui), u8g2.getDisplayWidth());

    //Serial.println(String(selection2));
  }
  return 0;
}

void ByteToChar(byte FromByte, char DeviceCode[])
{
  byte nib1 = (FromByte >> 4) & 0x0F;
  byte nib2 = (FromByte >> 0) & 0x0F;

  DeviceCode[0] = nib1  < 0xA ? '0' + nib1  : 'A' + nib1  - 0xA;
  DeviceCode[1] = nib2  < 0xA ? '0' + nib2  : 'A' + nib2  - 0xA;

  DeviceCode[2] = '\0';
}

uint8_t mui_draw_current_device(mui_t *ui, uint8_t msg) {
  char ForMessage[30] = "Device #";
  char LocDeviceNo[2];
  char LocDeviceCode[3];
  byte LocByte;
  if (msg == MUIF_MSG_DRAW) {
    u8g2.setCursor(mui_get_x(ui), mui_get_y(ui));

    itoa(SelectedDevice + 1, LocDeviceNo, 10);
    
    strcat(ForMessage, LocDeviceNo);

      if (mui_GetCurrentFormId(ui) == 11) {

        LocByte = EndDeviceAddress[SelectedDevice];

         ByteToChar(LocByte, LocDeviceCode);
         strcat(ForMessage, "         code:");
         strcat(ForMessage, LocDeviceCode);
        
         u8g2.print(ForMessage);

     } else u8g2.print(ForMessage);
  }
  //Serial.println(ForMessage);
  return 0;
}

void clearFormPositionCache(mui_t *mui, uint8_t form_id) {
  uint8_t i;
  for (i = 0; i < MUI_MENU_CACHE_CNT; i++)
    if (mui->menu_form_id[i] == form_id)
      mui->menu_form_cursor_focus_position[i] = 0;
}

uint8_t GetCacheFormPosition(mui_t *mui, uint8_t form_id) {
  uint8_t i;
  for (i = 0; i < MUI_MENU_CACHE_CNT; i++) {
    Serial.println(String(mui->menu_form_id[i]) + "|mui_go_main_menu " + mui->menu_form_cursor_focus_position[i]);

    if (mui->menu_form_id[i] == form_id)
      return (mui->menu_form_cursor_focus_position[i]);
  }
}

void ClearTestVars() {
  //DiodeResult = false;
  //MainDiodeResult = false;
  //SentPacketTime = 0;
}

uint8_t mui_go_device_menu(mui_t *ui, uint8_t msg) {
 // char SelectedTestModeLoc[2];
 // char DebugMessage[30] = "mui_go_device_menu: ";

  if (msg == MUIF_MSG_FORM_START) {

    clearFormPositionCache(mui.getMUI(), 11);  // always reset the position for "form" 11

    
    // itoa(SelectedTestMode + 1, SelectedTestModeLoc, 10);
    // strcat(DebugMessage, SelectedTestModeLoc);

    // Serial.println(DebugMessage);

    //mui.gotoForm(1, GetCacheFormPosition(mui.getMUI(), 1)); //DIFF!
    
    //mui.gotoForm(1, 2);
    mui.sendSelectWithExecuteOnSelectFieldSearch();//DIFF!
  }
  return 0;
}

muif_t muif_list[] = {
  MUIF_U8G2_FONT_STYLE(1, u8g2_font_helvR08_tr),
  MUIF_RO("HR", mui_hrule),
  MUIF_U8G2_LABEL(),
  MUIF_U8G2_U16_LIST("ID", &SelectedDevice, NULL, menu_devices_get_str, menu_devices_get_cnt, mui_u8g2_u16_list_goto_w1_pi),
  MUIF_U8G2_U16_LIST("AC", &SelectedTestMode, NULL, menu_action_get_str, menu_action_get_cnt, mui_u8g2_u16_list_goto_w1_pi),

  MUIF_RO("DD", mui_draw_current_device),

  MUIF_RO("GG", mui_go_device_menu),
  MUIF_EXECUTE_ON_SELECT_BUTTON("ST", mui_u8g2_btn_exit_wm_fi), //DIFF!

  MUIF_RO("00", ClearTestVars),
};

fds_t fds_data[] =
  //-------------main menu
  MUI_FORM(1)
  MUI_STYLE(1)

  MUI_LABEL(5, 8, "Choose:")
  MUI_XY("HR", 0, 11)

  MUI_XYA("ID", 5, 24, 0)
  MUI_XYA("ID", 5, 36, 1)
  MUI_XYA("ID", 5, 48, 2)
  MUI_XYA("ID", 5, 60, 3)

  //--------------device actions
  MUI_FORM(11)
  MUI_STYLE(1)

  MUI_XY("HR", 0, 11)
  MUI_XY("DD", 5, 8)

  //clear vars
  MUI_AUX("00")

  MUI_XYA("AC", 5, 24, 0)
  MUI_XYA("AC", 5, 36, 1)
  MUI_XYA("AC", 5, 48, 2)
  MUI_XYA("AC", 5, 60, 3)

  //additional jump form
  MUI_FORM(25)
  MUI_STYLE(1)
  MUI_AUX("GG")
  MUI_XYAT("ST", 5, 24, 1, "Exit")//DIFF!
  
  ;

void setup() {
  Serial.begin(9600);  // initialize serial
  while (!Serial);

  // Load to the encoder all nedded handle functions here (up to 9 functions)
  versatile_encoder.setHandleRotate(handleRotate);
  versatile_encoder.setHandlePressRelease(handlePressRelease);
  versatile_encoder.setHandleLongPressRelease(handleLongPressRelease);

  u8g2.begin();  //2%
  u8g2.enableUTF8Print();

  mui.begin(u8g2, fds_data, muif_list, sizeof(muif_list) / sizeof(muif_t));
  mui.gotoForm(/* form_id= */ 1, /* initial_cursor_position= */ 0);
}

void handle_events(void) {
  // 0 = not pushed, 1 = pushed
  if (press_event == 1) {
    mui.sendSelect();
    is_redraw = 1;
    press_event = 0;
  }

  // 0 = not pushed, 1 = pushed
  if (long_press_event == 1) {
    mui.sendSelectWithExecuteOnSelectFieldSearch();
    is_redraw = 1;
    long_press_event = 0;
  }

  // 0 = not turning, 1 = CW, 2 = CCW
  if (rotate_event == 1) {
    mui.nextField();
    is_redraw = 1;
    rotate_event = 0;
  }

  if (rotate_event == 2) {
    mui.prevField();
    is_redraw = 1;
    rotate_event = 0;
  }
}


void loop() {
  if ( mui.isFormActive() ) {
    if (is_redraw) {
      u8g2.firstPage();
      do {
        versatile_encoder.ReadEncoder();  // Do the encoder reading and processing
        mui.draw();
        versatile_encoder.ReadEncoder();  // Do the encoder reading and processing
      } while (u8g2.nextPage());
      is_redraw = 0; /* clear the redraw flag */
    }
  }
  else {
      /* the menu should never become inactive, but if so, then restart the menu system */
      mui.gotoForm(1, GetCacheFormPosition(mui.getMUI(), 1)); //DIFF!
  }

  versatile_encoder.ReadEncoder();  // Do the encoder reading and processing
  handle_events();
}

[olikraus]

The idea of the "initial_cursor_position" should make the specified editable field active. But it is not tested much.

[ViacheslavK9]

thanks..