Skip to content

Latest commit

 

History

History
executable file
·
260 lines (170 loc) · 15.7 KB

faq.rst

File metadata and controls

executable file
·
260 lines (170 loc) · 15.7 KB
Raw

AT FAQ

:link_to_translation:`zh_CN:[中文]`

AT Firmware

There is no released firmware for my module. Where can I get the firmware for it?

If there is no released fimware for your module in the :doc:`AT_Binary_Lists/index` chapter, please consider the following options:

How to get the source code of AT firmware?

ESP-AT firmware is partially open-source. See esp-at for the open-source repository.

How to download the AT firmware on Espressif's official website?

How to combine all the bin files compiled by ESP-AT?

You can use the combine button of the Flash Download Tools.
.. only:: esp32

  Why is the error "flash read err,1000" printed on the serial port after powering up the newly purchased ESP32-WROVE-E module? How to use AT commands for this module?
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    - The ESP32-WROVER-E module is shipped without AT firmware, so the error "flash read err" appears.
    - If you want to use the AT command function of ESP32-WROVER-E, please refer to the following links to get the firmware and flash it.

      - :ref:`Download firmware <firmware-esp32-wrover-32-series>`;
      - :ref:`Connect hardware <hw-connection-esp32-wrover-series>`;
      - :ref:`Flash firmware <flash-at-firmware-into-your-device>`.

Does the AT firmware shipped in modules support flow control?

AT Commands and Responses

What is the reason why AT prompts busy?

  • The "busy" prompt indicates that the previous command is being executed, and the system cannot respond to the current input. The processing mechanism of the AT commands is serial, i.e. one command at a time.
  • Any input through serial ports is considered to be a command input, so the system will also prompt "busy" or "ERROR" when there is any extra invisible character input.
    • Serial input AT+GMR (change character CR LF) (space character), because AT+GMR (change character CR LF) is already a complete AT command, the system will execute the command. At this time, if the system has not completed the AT+GMR operation, it has received the following space character, which will be regarded as a new command input, and the system will prompt "busy". But if the system has completed the AT+GMR operation, and then receives the following space character, the space character will be regarded as an error command, and the system will prompt "ERROR".
    • After the MCU sends AT+CIPSEND and receives the busy p.. response, the MCU needs to resend the data. Because busy p.. represents the previous command is being executed, the current input is invalid. It is recommended to wait for the response of the last AT command before the MCU sends a new command again.

Why does the ESP-AT firmware always return the following message after the I powered up the device and sent the first command?

ERR CODE:0x010b0000
busy p...
  • This message means that the previous command is being executed.
  • Normally only "busy p..." is displayed. The ERR CODE is displayed because the error code prompt is enabled.
  • If you receive this message after sending the first command on power-up, the possible reasons are: the command is followed by the unnecessary newline/space/other symbols; or two or more AT commands are sent in succession.

What commands are supported by the default ESP-AT firmware on different modules, and from which version are they supported?

When the host MCU sends an AT command to the {IDF_TARGET_NAME} device, there is no response. What is the reason?

A terminator ("ATrn") must be added after an AT command when the host MCU sending AT commands to an {IDF_TARGET_NAME} device. Please see :ref:`check-whether-at-works`.

Do AT commands support ESP-WIFI-MESH?

Currently, AT commands do not support ESP-WIFI-MESH.

Does AT support websocket commands?

Can AT command set Bluetooth LE transmit power?

Yes, the :ref:`AT+RFPOWER <cmd-RFPOWER>` command can set Bluetooth LE transmit power. {IDF_TARGET_NAME} Wi-Fi and Bluetooth LE share the same antenna.
.. only:: esp32

  Is it possible to set the ESP32-WROOM-32 module to HID keyboard mode with AT commands?
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Yes, please refer to :doc:`Bluetooth LE AT Commands <AT_Command_Set/BLE_AT_Commands>`.

How to support commands that are not supported by the default firmware but can be supported after configuring and compiling the ESP-AT project?

For example, if you need to support the WPA2 Enterprise function on the {IDF_TARGET_NAME} series, configure and compile the firmware by yourself. Open the WPA2 Enterprise function in menuconfig when compiling: ./build.py menuconfig > Component config > AT > [*]AT WPA2 Enterprise command support.

How to handle special characters in AT commands?

Please refer to the escape character syntax described in the :ref:`at-command-types` section.

Can the serial port baudrate be modified in AT Commands? (Default: 115200)

Yes, you can use either of the two ways below to modify it:

After {IDF_TARGET_NAME} enters the passthrough mode using AT commands, can {IDF_TARGET_NAME} give a message if the connected hotspot is disconnected?

  • Yes, you can configure it with :ref:`AT+SYSMSG <cmd-SYSMSG>`, i.e., set AT+SYSMSG=4. In this way, the serial port will report "WIFI DISCONNECTrn" when the connected hotspot is disconnected.
  • Note that this command is added after AT v2.1.0. It is not available for v2.1.0 and earlier versions.
.. only:: esp32

  How to set ADV broadcast parameters after it exceeds 31 bytes?
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    The :ref:`AT+BLEADVDATA <cmd-BADVD>` command supports up to 31 bytes of ADV broadcast parameters. If you need to set a bigger parameter, please use command :ref:`AT+BLESCANRSPDATA <cmd-BSCANR>`.

Hardware

How big is the chip flash required for ESP-AT firmware on different modules?

.. only:: esp32

  How does the {IDF_TARGET_NAME} AT communicate through the UART0 port?
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    The default AT firmware communicates through the UART1 port. If you want to communicate through UART0, please download and compile the ESP-AT project.

    - Refer to :doc:`Compile_and_Develop/How_to_clone_project_and_compile_it` to set up the compiling environment;
    - Modify the module's UART pins in your :component_file:`factory_param_data.csv <customized_partitions/raw_data/factory_param/factory_param_data.csv>`, i.e. change uart_tx_pin to GPIO1, and uart_tx_pin to GPIO3;
    - Configure your esp-at project: ./build.py menuconfig > Component config > Common ESP-related > UART for console output(Custom) > Uart peripheral to use for console output(0-1)(UART1) > (1)UART TX on GPIO# (NEW) > (3)UART TX on GPIO# (NEW).

How to view the error log of AT firmware?

.. list::

  :esp32: - For {IDF_TARGET_NAME}, the error log is output through the download port. By default, UART0 is GPIO1 and GPIO3.
  :esp32c2 or esp32c3: - For {IDF_TARGET_NAME}, the error log is output through the download port. By default, UART0 is GPIO21 and GPIO20.
  - See :doc:`Get_Started/Hardware_connection` for more details.

The UART1 communication pin used by ESP-AT on the {IDF_TARGET_NAME} module is inconsistent with the default UART1 pin described in the {IDF_TARGET_NAME} module's datasheet?

Performance

How long does it take for the AT to connect to Wi-Fi?

  • In an office scenario, the connection time is 5 seconds. However, in actual practice, Wi-Fi connection time depends on the router performance, network environment, module antenna performance, etc.
  • The maximum timeout time can be set by the <jap_timeout> parameter of :ref:`AT+CWJAP <cmd-JAP>`.

Is it possible to change the TCP send window size in AT firmware?

  • Currently, it cannot be changed by AT commands, but you can configure and compile the ESP-AT project to generate a new firmware.
  • You can configure the menuconfig parameter: Component config > LWIP > TCP > Default send buffer size.

How to test and optimize the throughput of {IDF_TARGET_NAME} AT?

  • Many factors are affecting the AT throughput test. It is recommended to use the iperf example in esp-idf for testing. While testing, please use the passthrough mode, adjust the data length to 1460 bytes, and send data continuously.
  • If the test rate does not meet your requirements, please refer to :doc:`Compile_and_Develop/How_to_optimize_throughput`.
.. only:: esp32

  What is the maximum rate of {IDF_TARGET_NAME} AT default firmware Bluetooth LE UART transparent transmission?
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    In an open office environment, when the serial port baud rate is 2000000, the average transmission rate of ESP-AT Bluetooth is 0.56 Mbps, and the average transmission rate of ESP-AT Bluetooth LE is 0.101 Mbps.

Other

What interfaces of {IDF_TARGET_NAME} chips can be used to transmit AT commands?

.. list::

  :esp32: - {IDF_TARGET_NAME} can transmit AT commands through UART and SDIO.
  :esp32c2: - {IDF_TARGET_NAME} can transmit AT commands through UART.
  :esp32c3: - {IDF_TARGET_NAME} can transmit AT commands through UART and SPI.
  - The default firmware uses UART for transmission. If you need SDIO or SPI interface to transmit AT commands, you can configure it through ``./build.py menuconfig -> Component config -> AT`` when compiling the ESP-AT project by yourself.
  - See :project_file:`AT through SDIO <main/interface/sdio/README.md>`, :project_file:`AT through SPI <main/interface/hspi/README.md>`, or :project_file:`AT through socket <main/interface/socket/README.md>` for more details.


.. only:: esp32

  How to use the Ethernet function of the {IDF_TARGET_NAME} AT?
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    The Ethernet function is disable in AT default firmware, if you need to enable the Ethernet function, please refer to :doc:`How to Enable ESP-AT Ethernet <Compile_and_Develop/How_to_enable_ESP_AT_Ethernet>`.

How does ESP-AT conduct BQB certification?

Please contact Espressif for solutions.

How do I specify the TLS protocol version for {IDF_TARGET_NAME} AT?

When compiling the esp-at project, you can disable the unwanted versions in the ./build.py menuconfig -> Component config -> mbedTLS.

How to modify the number of TCP connections in AT?

  • At present, the maximum number of TCP connections of the AT default firmware is 5.
  • The {IDF_TARGET_NAME} AT supports a maximum of 16 TCP connections, which can be configured in menuconfig as follows:
    • ./build.py menuconfig---> Component config---> AT---> (16)AT socket maximum connection number
    • ./build.py menuconfig---> LWIP---> (16)Max number of open sockets