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 error for AT+CWLAPOPT command #875

Open
3 tasks done
JavierReyes945 opened this issue Sep 24, 2024 · 1 comment
Open
3 tasks done

Documentation error for AT+CWLAPOPT command #875

JavierReyes945 opened this issue Sep 24, 2024 · 1 comment

Comments

@JavierReyes945
Copy link

Answers checklist.

  • I have read the documentation ESP-AT Programming Guide and the issue is not addressed there.
  • I have used the latest released firmware or have updated my ESP-AT branch (master or release) to the latest version and checked that the issue is present there.
  • I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

The ESP-AT documentation for the command AT+CWLAPOPT (https://docs.espressif.com/projects/esp-at/en/latest/esp32c6/AT_Command_Set/Wi-Fi_AT_Commands.html#at-cwlapopt-set-the-configuration-for-the-command-at-cwlap) describes 4 parameters:

  • reserved
  • print mask
  • rssi filter (optional)
  • authmode mask (optional)

But the example confusingly states in the example:

// The first parameter is 1, meaning that the result of the command AT+CWLAP will be ordered according to RSSI;
// The second parameter is 31, namely 0x1F, meaning that the corresponding bits of <print mask> are set to 1. All parameters will be shown in the result of AT+CWLAP.
AT+CWLAPOPT=1,31
AT+CWLAP

If only 2 parameters are given to the command, according to the documentation, they are the reserved and print mask parameter, making the comment about filtering the RSSI inconsistent and confusing. If the reserved parameter is not supposed to be passed, it is still wrong as the order of parameters would mean that the print mask should be before the rssi filter. So in the example, the command AT+CWLAPOPT=1,31 is not defining any RSSI filter, despite the comment indicating the contrary.

Checked for different HW versions (ESP32-C6, ESP32-C3, ESP32-S2 on both release and master).

A clarification / correction of the documentation would be helpful.

Thanks in advance

@ustccw
Copy link
Collaborator

ustccw commented Oct 10, 2024

@JavierReyes945 thanks for your feedback, we should remove the first comment.

The first parameter is 1, meaning that the result of the command AT+CWLAP will be ordered according to RSSI;

In fact, the items in the response is always sorted by rssi, the first parameter is unnecessary now.

About filtering the RSSI, it is the third parameter (<rssi filter>) in AT+CWLAPOPT command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants