summaryrefslogtreecommitdiff
path: root/components/net/at/Kconfig
blob: 52edfc8781394ce48b795f62031d4fe688cd8cda (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
menuconfig RT_USING_AT
    bool "Enable AT commands"
    default n
    help
        RT_USING_AT is the master switch for the "AT command framework" in the RT-Thread system.
        The AT command component provides a standardized framework for AT command parsing, registration, and response, adapting to various peripherals that support AT commands.
       
        It is disabled by default.

if RT_USING_AT

    config AT_DEBUG
        bool "Enable debug log output"
        default n
        help
            AT_DEBUG is a switch that enables debug logging output for the AT command framework.
            When enabled, it prints logs of AT commands, including "sent/received content," "parsing process," "response result," and "error reason."

            It is disabled by default.

    config AT_USING_SERVER
        bool "Enable AT commands server"
        default n
        help
            AT_USING_SERVER is the AT server function switch.
            Its core function is to expand the AT command framework from "local serial port interaction mode" to "network/multi-channel service mode."
            When enabled, AT commands are no longer limited to local serial port transmission and reception.
            They can also receive and respond to AT commands through network channels such as TCP/UDP/virtual serial ports, enabling "remote AT debugging/control."

            It is disabled by default.

    if AT_USING_SERVER

        config AT_SERVER_DEVICE
            string "Server device name"
            default "uart3"
            help
                The core function of AT_SERVER_DEVICE is to specify the "underlying data transceiver device name" of the AT server.
                The command interaction of the AT server ultimately needs to be bound to a physical/virtual device as a data channel (such as a serial port or network device).

                By default, it is "uart3".

        config AT_SERVER_RECV_BUFF_LEN
            int "The maximum length of server data accepted"
            default 256
            help    
                The core function of AT_SERVER_RECV_BUFF_LEN is to define the "maximum buffer length" for the AT server to receive a single AT command.
                When receiving remote/serial AT commands, the AT server first stores the data in this buffer, and then parses it after the command is fully received.

                The default value is 256.

        config AT_SERVER_SEND_BUFF_LEN
            int "The maximum length of server commands buffer"
            default 256
            help
                The core function of AT_SERVER_SEND_BUFF_LEN is to define the "maximum buffer length" for the AT server to send AT command responses/issue commands.
                When the AT server returns command responses to a remote terminal/serial port or issues AT commands to a module, it first stores the data in this buffer before sending it in batches.

                The default value is 256.

    endif

    config AT_USING_CLIENT
        bool "Enable AT commands client"
        default n
        help
            The core function of AT_USING_CLIENT is to switch the AT framework from a "passive command response mode" to an "active command initiation mode."
            When enabled, the AT framework can act as an "AT client," actively sending AT commands to external AT devices and waiting for/parsing responses.

            It is disabled by default.

    if AT_USING_CLIENT

        config AT_CLIENT_NUM_MAX
            int "The maximum number of supported clients"
            default 1
            range 1 65535
            help
                The core function of AT_CLIENT_NUM_MAX is to define the maximum number of AT client instances that can be created simultaneously within the AT framework.

                By default, the value range is 1-65535.

        config AT_USING_SOCKET
            bool "Enable BSD Socket API support by AT commnads"
            select RT_USING_SAL
            select SAL_USING_AT
            default n
            help
                AT_USING_SOCKET is an AT socket adaptation switch within the AT command framework. Its core function is to enable the AT framework to provide a "BSD Socket standard API wrapper."
                When enabled, network modules adapted to AT commands can directly call the standard BSD Socket API without needing to concern themselves with the underlying AT command details.

                It is disabled by default; enabling it will also enable RT_USING_SAL and SAL_USING_AT.

        if AT_USING_SOCKET

            config AT_USING_SOCKET_SERVER
                bool "Enable BSD Socket API support about AT server"
                default n
                help
                    AT_USING_SOCKET_SERVER is used to enable the AT socket server function within the AT command framework.
                    When enabled, the AT server can be accessed through BSD Socket API.

                    It is disabled by default.

        endif

    endif

    if AT_USING_SERVER || AT_USING_CLIENT

        config AT_USING_CLI
            bool "Enable CLI(Command-Line Interface) for AT commands"
            default y
            depends on RT_USING_FINSH
            help    
                AT_USING_CLI is the AT command-line interaction switch within the AT framework.
                Its core function is to integrate AT commands into the RT-Thread FinSH command-line console.
                When enabled, AT commands can be entered directly in the FinSH terminal without requiring an additional serial port/network channel.

                It is enabled by default, but RT_USING_FINSH must be enabled.

       config AT_PRINT_RAW_CMD
            bool "Enable print RAW format AT command communication data"
            default n
            help    
                AT_PRINT_RAW_CMD is a switch for printing raw AT data within the AT command framework.
                Its core function is to print the raw binary/character data during AT command interaction.
                When enabled, it outputs unfiltered, unformatted AT transmit and receive data.

                It is disabled by default.

    endif

    config AT_SW_VERSION_NUM
        hex
        default 0x10301
        help
            software module version number

endif