Skip to content

Latest commit

 

History

History
150 lines (119 loc) · 7.16 KB

ESP_AT_Factory_Parameter_Bin.md

File metadata and controls

150 lines (119 loc) · 7.16 KB

Overview

In order to adapt the AT firmware to different requirements, for example, different development board, different country code, different RF restriction, we make a table to configure those parameters.

Factory param type

The origin table is components/customized_partitions/raw_data/factory_param/factory_param_type.csv, and the factory parameter type is as the following table:

param_name offset type size
module_name -1 String 0
magic_flag 0 integer 2
version 2 integer 1
module_id 3 integer 1
tx_max_power 4 integer 1
start_channel 6 integer 1
channel_num 7 integer 1
country_code 8 String 4
uart_baudrate 12 integer 4
uart_tx_pin 16 integer 1
uart_rx_pin 17 integer 1
uart_cts_pin 18 integer 1
uart_rts_pin 19 integer 1
tx_control_pin 20 integer 1
rx_control_pin 21 integer 1

  • version:

    • the version of factory param mangement

  • module_id

    • the index of development boards, it MUST be unique.
      • 1 - WROOM32
      • 2 - WROVER32
      • 3 - PICO-D4
      • 4 - SOLO

  • tx_max_power

    • Wi-Fi maximum tx power

  • start_chanel

    • Wi-Fi start channel

  • channel_num

    • the total channel number of Wi-Fi

  • country_code

    • Country code

  • uart_baudrate

    • uart baudrate

  • uart_tx_pin

    • uart tx pin

  • uart_rx_pin

    • uart rx pin

  • uart_cts_pin

    • uart cts pin, it can be configured -1, if the pin is not used

  • uart_rts_pin

    • uart rts pin, it can be configured -1, if the pin is not used

  • tx_control_pin

    • for some board, tx pin need to be separated from mcu when power on. It can be configured -1, if the pin is not used

  • rx_control_pin

    • for some board, rx pin need to be separated from mcu when power on. It can be configured -1, if the pin is not used

Factory param data

The origin table is components/customized_partitions/raw_data/factory_param/factory_param_data.csv, and the information each row contains is about one module. The factory parameter data is as the following table:

platform module_name magic_flag version module_id tx_max_power start_channel channel_num country_code uart_baudrate uart_tx_pin uart_rx_pin uart_cts_pin uart_rts_pin tx_control_pin rx_control_pin
PLATFORM_ESP32 WROOM-32 0xfcfc 1 1 1 1 13 CN 115200 17 16 15 14 -1 -1
PLATFORM_ESP32 WROVER-32 0xfcfc 1 2 1 1 13 CN 115200 22 19 15 14 -1 -1
PLATFORM_ESP32 PICO-D4 0xfcfc 1 3 1 1 13 CN 115200 22 19 15 14 -1 -1
PLATFORM_ESP32 SOLO-1 0xfcfc 1 4 1 1 13 CN 115200 17 16 15 14 -1 -1
PLATFORM_ESP8266 WROOM-02 0xfcfc 1 4 1 1 13 CN 115200 15 13 3 1 5 -1

Add customized module

if you want to add a module named as "MY_MODULE", of which country code is JP, and Wi-Fi channel is from 1 to 14, the table should be as the following one:

platform module_name magic_flag version module_id tx_max_power start_channel channel_num country_code uart_baudrate uart_tx_pin uart_rx_pin uart_cts_pin uart_rts_pin tx_control_pin rx_control_pin
PLATFORM_ESP32 WROOM-32 0xfcfc 1 1 1 1 13 CN 115200 17 16 15 14 -1 -1
PLATFORM_ESP32 WROVER-32 0xfcfc 1 2 1 1 13 CN 115200 22 19 15 14 -1 -1
PLATFORM_ESP32 PICO-D4 0xfcfc 1 3 1 1 13 CN 115200 22 19 15 14 -1 -1
PLATFORM_ESP32 SOLO-1 0xfcfc 1 4 1 1 13 CN 115200 17 16 15 14 -1 -1
PLATFORM_ESP8266 WROOM-02 0xfcfc 1 4 1 1 13 CN 115200 15 13 3 1 5 -1
MY_PLATFORM MY_MODULE 0xfcfc 1 5 1 1 14 JP 115200 17 16 15 14 -1 -1

Then add module information in esp_at_module_info in at_default_config.c, like

static const esp_at_module_info_t esp_at_module_info[] = {
#if defined(CONFIG_IDF_TARGET_ESP32)
    {"WROOM-32",        CONFIG_ESP_AT_OTA_TOKEN_WROOM32,       CONFIG_ESP_AT_OTA_SSL_TOKEN_WROOM32 },        // default:ESP32-WROOM-32
    {"WROOM-32",        CONFIG_ESP_AT_OTA_TOKEN_WROOM32,       CONFIG_ESP_AT_OTA_SSL_TOKEN_WROOM32 },        // ESP32-WROOM-32
    {"WROVER-32",       CONFIG_ESP_AT_OTA_TOKEN_WROVER32,      CONFIG_ESP_AT_OTA_SSL_TOKEN_WROVER32 },       // ESP32-WROVER
    {"PICO-D4",         CONFIG_ESP_AT_OTA_TOKEN_ESP32_PICO_D4, CONFIG_ESP_AT_OTA_SSL_TOKEN_ESP32_PICO_D4},   // ESP32-PICO-D4
    {"SOLO-1",          CONFIG_ESP_AT_OTA_TOKEN_ESP32_SOLO_1,  CONFIG_ESP_AT_OTA_SSL_TOKEN_ESP32_SOLO_1 },   // ESP32-SOLO-1
#endif

#if defined(CONFIG_IDF_TARGET_ESP8266)
    {"WROOM-02",        CONFIG_ESP_AT_OTA_TOKEN_WROOM_02,       CONFIG_ESP_AT_OTA_SSL_TOKEN_WROOM_02 },
    {"WROOM-S2",        CONFIG_ESP_AT_OTA_TOKEN_WROOM_S2,       CONFIG_ESP_AT_OTA_SSL_TOKEN_WROOM_S2 },
#endif
};

Add customized data

If you want to add more parameter, for example, add a string "20181225" as the date, you need to add the type of date in the factory_param_type.csv, as the following table.

param_name offset type size
platform -1 String 0
module_name -1 String 0
magic_flag 0 integer 2
version 2 integer 1
module_id 3 integer 1
tx_max_power 4 integer 1
start_channel 6 integer 1
channel_num 7 integer 1
country_code 8 String 4
uart_baudrate 12 integer 4
uart_tx_pin 16 integer 1
uart_rx_pin 17 integer 1
uart_cts_pin 18 integer 1
uart_rts_pin 19 integer 1
tx_control_pin 20 integer 1
rx_control_pin 21 integer 1
date 22 String 8

Edit factory_param_data.csv with reference to Add customized module, and add the date into the last column, as the following table,

platform module_name magic_flag version module_id tx_max_power start_channel channel_num country_code uart_baudrate uart_tx_pin uart_rx_pin uart_cts_pin uart_rts_pin tx_control_pin rx_control_pin data
PLATFORM_ESP32 WROOM-32 0xfcfc 1 1 1 1 13 CN 115200 17 16 15 14 -1 -1
PLATFORM_ESP32 WROVER-32 0xfcfc 1 2 1 1 13 CN 115200 22 19 15 14 -1 -1
PLATFORM_ESP32 PICO-D4 0xfcfc 1 3 1 1 13 CN 115200 22 19 15 14 -1 -1
PLATFORM_ESP32 SOLO-1 0xfcfc 1 4 1 1 13 CN 115200 17 16 15 14 -1 -1
PLATFORM_ESP8266 WROOM-02 0xfcfc 1 4 1 1 13 CN 115200 15 13 3 1 5 -1
MY_PLATFORM MY_MODULE 0xfcfc 1 5 1 1 14 JP 115200 17 16 15 14 -1 -1 20181225

Then, you can add code to parse date in esp_at_factory_parameter_init or other api.