Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Unclear how to exit settings menu #1423

Closed
wolfpackmars2 opened this issue Oct 3, 2022 · 0 comments · Fixed by #1459
Closed

Documentation: Unclear how to exit settings menu #1423

wolfpackmars2 opened this issue Oct 3, 2022 · 0 comments · Fixed by #1459
Assignees
Labels
Bug Serious issue or problem. Enhancement New feature or additional function.

Comments

@wolfpackmars2
Copy link

Describe the bug
Documentation doesn't describe how to exit the config menu (or it's unclear to me)

Note: I haven't actually used the device yet so this is reported as a user who has just read the manual and is getting ready to power on for the first time. I'll come back and clean this post up after I use the device.

To Reproduce

  1. Go to https://ralim.github.io/IronOS/Menu/#settings-mode
  2. Read Settings mode section
  3. Be confused about how to exit settings mode

Expected behavior
Documentation states e.g.:
"To exit menu, long press B button. Pressing A + B will also exit the settings menu. Cycling through all the configuration items in the current menu will return to the parent menu/screen."

Details of your device:

  • Device: Pinecil V2
  • Release: 2.18
  • Power adapter being used: Anker 737

Additional context
Just received new Pinecil V2 and RTFM the docs and realize that it is unclear how to exit the settings menu. Can menu be exited with long press of B-?

This should be documented here: https://ralim.github.io/IronOS/Menu/#settings-mode
Source link:

## Settings mode
This mode allows you to cycle through all the options and set custom values.
The menu is arranged so that the most often used settings are first.
- The rear button (`-/B`) cycles through the main options.
- The front button (`+/A`) changes the selected option.
- Note that settings are not saved until you exit the menu.
- If you idle on a setting (i.e., don't press any buttons), after 3 seconds, the screen scrolls a brief description (mini help guide).
- Enter submenus using the front button (`+/A`) if you are going to change it or wish to view it.
- Scrolling through the all options of a submenu will return you back to its entry location.

Reference #53 where pressing A + B will exit menu.

If menu is viewed as a tree, what action is required to move up to the parent menu? What action is required to exit (and save) current settings from any position in the menu? Is there a way to exit the menu without saving OTHER THAN unplugging the device before exiting the menu?

Thoughtbarf: Prior to using the iron for the first time, my thought would be that Long Press of B- Moves up the menu tree all the way up to exiting the settings subsystem altogether. Settings are saved to EEPROM only when exiting the settings subsystem completely (I think this is current behavior). Pressing A + B can either: Exit settings subsystem and write to EEPROM from ANY position in the settings menu tree (OR, less likely but still a thought - pressing A + B moves up the tree but CANCELS any change to the current setting -- at the top of the settings tree, pressing A + B would exit the settings subsystem WITHOUT writing to EEPROM - maybe with a warning / confirmation display to the user prior to exiting the settings subsystem without write).

Additional aside: a "Documentation" label for issues

@Ralim Ralim added Bug Serious issue or problem. Enhancement New feature or additional function. labels Oct 3, 2022
Ralim added a commit that referenced this issue Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Serious issue or problem. Enhancement New feature or additional function.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants