Wrong order of buttons in input_key_com_user_id.h ? (AUD-4586)

[Gaai]

----------------------------- Delete below -----------------------------

Reminder: If your issue is a general question, start similar to "How do I..". If it is related to 3rd party development kits/libs, please discuss this on our community forum at https://esp32.com instead.

INSTRUCTIONS

Before submitting a new issue, please follow the checklist and try to find the answer.

• [x] I have read the documentation Espressif Audio Development Guide and the issue is not addressed there.
• [x] I have updated my ADF and IDF branch (master or release) to the latest version and checked that the issue is present there.
• [x] I have searched the issue tracker for a similar issue and not found a similar issue.

If the issue cannot be solved after the steps above, please follow these instructions so we can get the needed information to help you quickly and effectively.

1. Fill in all the fields under Environment marked with [ ] by picking the correct option for you in each case and deleting the others.
2. Describe your issues.
3. Include debug logs from the "monitor" tool, or coredumps.
4. Providing as much information as possible under Other Items If Possible will help us locate and fix the problem.
5. Use Markdown (see formatting buttons above) and the Preview tab to check what the issue will look like.
6. Delete these instructions from the above to the below marker lines before submitting this issue.

IMPORTANT: Please follow the above instructions and provide as many details as possible. It will save a lot of communication time and improve the efficiency of problem solving. The more details you provide, the faster we may be able to reproduce and resolve the issue. Thanks!

----------------------------- Delete above -----------------------------

Environment

• Audio development kit: [ESP32-LyraT|ESP32-LyraT-Mini|ESP32-LyraTD-MSC|ESP32-S2-Kaluga-1|ESP32-Korvo-DU1906|ESP32-S3-Korvo-2|ESP32-S3-Korvo-2-LCD|none]
• Audio kit version (for ESP32-LyraT/ESP32-LyraT-Mini/ESP32-S3-Korvo-2): [v1|v2|v3|v4]
• [Required] Module or chip used: [ESP32-WROOM-32E|ESP32-WROVER-E|ESP32-S2-WROVER|ESP32-S3-WROOM-1]
• [Required] IDF version (run git describe --tags in $IDF_PATH folder to find it): // v4.4-191-g83daa6dabb
• [Required] ADF version (run git describe --tags in $ADF_PATH folder to find it): // v2.3-171-gaac5912
• Build system: [Make|CMake|idf.py]
• [Required] Running log: All logs from power-on to problem recurrence
• Compiler version (run xtensa-esp32-elf-gcc --version in your project folder to find it): // 1.22.0-80-g6c4433a
• Operating system: [Windows|Linux|macOS]
• (Windows only) Environment type: [MSYS2 mingw32|ESP Command Prompt|Plain Command Prompt|PowerShell]
• Using an IDE?: [No|Yes (please give details)]
• Power supply: [USB|external 5V|external 3.3V|Battery]

Problem Description

// Detailed problem description goes here. Am I missing something or are these in the wrong order? Think it needs to be REC, MODE, PLAY, SET, VOLDOWN, VOLUP. Haven't yet come across a board with different layout. Let me know if I should do a pull request.

Expected Behavior

typedef enum {
    INPUT_KEY_USER_ID_UNKNOWN                   = -1,   /*!< unknown user id */
    INPUT_KEY_USER_ID_REC                       = 0x01, /*!< user id for recording */
    INPUT_KEY_USER_ID_MODE                      = 0x02, /*!< user id for settings */
    INPUT_KEY_USER_ID_PLAY                      = 0x03, /*!< user id for playing */
    INPUT_KEY_USER_ID_SET                       = 0x04, /*!< user id for mode */
    INPUT_KEY_USER_ID_VOLDOWN                   = 0x05, /*!< user id for volume down */
    INPUT_KEY_USER_ID_VOLUP                     = 0x06, /*!< user id for volume up */
    INPUT_KEY_USER_ID_MUTE                      = 0x07, /*!< user id for mute */
    INPUT_KEY_USER_ID_CAPTURE                   = 0x08, /*!< user id for capture photo */
    INPUT_KEY_USER_ID_MSG                       = 0x09, /*!< user id for message */
    INPUT_KEY_USER_ID_BATTERY_CHARGING          = 0x0A, /*!< user id for battery charging */
    INPUT_KEY_USER_ID_WAKEUP                    = 0x0B, /*!< user id for GPIO wakeup */
    INPUT_KEY_USER_ID_COLOR                     = 0x0C, /*!< user id for color */

    INPUT_KEY_USER_ID_MAX                       = 0x101,
} input_key_user_id_t;

Actual Behavior

typedef enum {
    INPUT_KEY_USER_ID_UNKNOWN                   = -1,   /*!< unknown user id */
    INPUT_KEY_USER_ID_REC                       = 0x01, /*!< user id for recording */
    INPUT_KEY_USER_ID_SET                       = 0x02, /*!< user id for settings */
    INPUT_KEY_USER_ID_PLAY                      = 0x03, /*!< user id for playing */
    INPUT_KEY_USER_ID_MODE                      = 0x04, /*!< user id for mode */
    INPUT_KEY_USER_ID_VOLDOWN                   = 0x05, /*!< user id for volume down */
    INPUT_KEY_USER_ID_VOLUP                     = 0x06, /*!< user id for volume up */
    INPUT_KEY_USER_ID_MUTE                      = 0x07, /*!< user id for mute */
    INPUT_KEY_USER_ID_CAPTURE                   = 0x08, /*!< user id for capture photo */
    INPUT_KEY_USER_ID_MSG                       = 0x09, /*!< user id for message */
    INPUT_KEY_USER_ID_BATTERY_CHARGING          = 0x0A, /*!< user id for battery charging */
    INPUT_KEY_USER_ID_WAKEUP                    = 0x0B, /*!< user id for GPIO wakeup */
    INPUT_KEY_USER_ID_COLOR                     = 0x0C, /*!< user id for color */

    INPUT_KEY_USER_ID_MAX                       = 0x101,
} input_key_user_id_t;

Steps to Reproduce

1. Examples use this enum like this: if (evt->type == INPUT_KEY_SERVICE_ACTION_CLICK_RELEASE) { ESP_LOGD(TAG, "[ * ] input key id is %d", (int)evt->data); switch ((int)evt->data) { case INPUT_KEY_USER_ID_MODE:

// If possible, attach a picture of your setup/wiring here.

Code to Reproduce This Issue

// the code should be wrapped in the ```cpp tag so that it will be displayed better.
#include "esp_log.h"

void app_main()
{

}

// If your code is longer than 30 lines, GIST is preferred.

Debug Logs

Debug log goes here. It should contain the backtrace, as well as the reset source if it is a crash.
Please copy the plaintext here for us to search the error log. Or attach the complete logs and leave the main part here if the log is *too* long.

Other Items If Possible

• [x] sdkconfig file (Attach the sdkconfig file from your project folder)
• [x] elf file in the build folder (Note this may contain all the code details and symbols of your project.)
• [x] coredump (This provides stacks of tasks.)

[TempoTian]

The definition for common used id is just a ID and have no relation with the key layout. The actual key map is defined in custom board. It will use the key map to search the key pressed is actually which ID.

[Gaai]

Yes I did find this out. But still. It only works now because the layout/order is wrong everywhere.

[Gaai]

Wrong for the proposed boards at least. LyraT 3.4, the Mini I think. And all clones. Not sure about the others. More logical to follow the order they appear on the board imho. Saves someone from confusing results in the future I'm sure.

[Gaai]

Or does the order really make no difference? I remember having to change the order to get my board working. Else play and set would be wrong way around. Is the order in board definition supposed to reflect the order in the input_key_com_user_id.h?

If I remember correctly I changed the order in board file first for my own reading convenience and then had to change it in input_key_com_user_id.h else it wasn't working. Maybe I remember wrong.

[jason-mao]

This topic has become inactive so I'm going to close the issue. Please reopen this if you have any questions or need any further assistance.