-
Notifications
You must be signed in to change notification settings - Fork 777
/
esp_at.h
553 lines (492 loc) · 18.1 KB
/
esp_at.h
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
/*
* ESPRESSIF MIT License
*
* Copyright (c) 2017 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
*
* Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP32 only, in which case,
* it is free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the Software is furnished
* to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or
* substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#ifndef __ESP_AT_H__
#define __ESP_AT_H__
#include <stdint.h>
#include <stdbool.h>
#include "esp_partition.h"
#include "esp_wifi.h"
/**
* @brief esp_at_cmd_struct
* used for define at command
*
*/
typedef struct {
char *at_cmdName; /*!< at command name */
uint8_t (*at_testCmd)(uint8_t *cmd_name); /*!< Test Command function pointer */
uint8_t (*at_queryCmd)(uint8_t *cmd_name); /*!< Query Command function pointer */
uint8_t (*at_setupCmd)(uint8_t para_num); /*!< Setup Command function pointer */
uint8_t (*at_exeCmd)(uint8_t *cmd_name); /*!< Execute Command function pointer */
} esp_at_cmd_struct;
/**
* @brief esp_at_device_ops_struct
* device operate functions struct for AT
*
*/
typedef struct {
int32_t (*read_data) (uint8_t *data, int32_t len); /*!< read data from device */
int32_t (*write_data)(uint8_t *data, int32_t len); /*!< write data into device */
int32_t (*get_data_length)(void); /*!< get the length of data received */
bool (*wait_write_complete)(int32_t timeout_msec); /*!< wait write finish */
} esp_at_device_ops_struct;
/**
* @brief esp_at_custom_net_ops_struct
* custom socket callback for AT
*/
typedef struct {
int32_t (*recv_data)(uint8_t*data,int32_t len); /*!< callback when socket received data */
void (*connect_cb)(void); /*!< callback when socket connection is built */
void (*disconnect_cb)(void); /*!< callback when socket connection is disconnected */
} esp_at_custom_net_ops_struct;
/**
* @brief esp_at_custom_ble_ops_struct
* custom ble callback for AT
*
*/
typedef struct {
int32_t (*recv_data)(uint8_t*data,int32_t len); /*!< callback when ble received data */
void (*connect_cb)(void); /*!< callback when ble connection is built */
void (*disconnect_cb)(void); /*!< callback when ble connection is disconnected */
} esp_at_custom_ble_ops_struct;
/**
* @brief esp_at_status
* some custom function interacting with AT
*
*/
typedef enum {
ESP_AT_STATUS_NORMAL = 0x0, /*!< Normal mode.Now mcu can send AT command */
ESP_AT_STATUS_TRANSMIT, /*!< Transparent Transmition mode */
} esp_at_status_type;
/**
* @brief esp_at_ops_struct
* some custom function interacting with AT
*
*/
typedef struct {
void (*status_callback) (esp_at_status_type status); /*!< callback when AT status changes */
void (*pre_deepsleep_callback) (void); /*!< callback before enter deep sleep */
void (*pre_restart_callback) (void); /*!< callback before restart */
} esp_at_custom_ops_struct;
/**
* @brief AT specific callback type
*
*/
typedef void (*esp_at_port_specific_callback_t) (void);
// error number
/**
* @brief module number,Now just AT module
*
*/
typedef enum {
ESP_AT_MODULE_NUM = 0x01 /*!< AT module */
} esp_at_module;
/**
* @brief subcategory number
*
*/
typedef enum {
ESP_AT_SUB_OK = 0x00, /*!< OK */
ESP_AT_SUB_COMMON_ERROR = 0x01, /*!< reserved */
ESP_AT_SUB_NO_TERMINATOR = 0x02, /*!< terminator character not found ("\r\n" expected) */
ESP_AT_SUB_NO_AT = 0x03, /*!< Starting "AT" not found (or at, At or aT entered) */
ESP_AT_SUB_PARA_LENGTH_MISMATCH = 0x04, /*!< parameter length mismatch */
ESP_AT_SUB_PARA_TYPE_MISMATCH = 0x05, /*!< parameter type mismatch */
ESP_AT_SUB_PARA_NUM_MISMATCH = 0x06, /*!< parameter number mismatch */
ESP_AT_SUB_PARA_INVALID = 0x07, /*!< the parameter is invalid */
ESP_AT_SUB_PARA_PARSE_FAIL = 0x08, /*!< parse parameter fail */
ESP_AT_SUB_UNSUPPORT_CMD = 0x09, /*!< the command is not supported */
ESP_AT_SUB_CMD_EXEC_FAIL = 0x0A, /*!< the command execution failed */
ESP_AT_SUB_CMD_PROCESSING = 0x0B, /*!< processing of previous command is in progress */
ESP_AT_SUB_CMD_OP_ERROR = 0x0C, /*!< the command operation type is error */
} esp_at_error_code;
#define ESP_AT_ERROR_NO(subcategory,extension) \
((ESP_AT_MODULE_NUM << 24) | ((subcategory) << 16) | (extension))
#define ESP_AT_CMD_ERROR_OK ESP_AT_ERROR_NO(ESP_AT_SUB_OK,0x00) /*!< No Error */
#define ESP_AT_CMD_ERROR_NON_FINISH ESP_AT_ERROR_NO(ESP_AT_SUB_NO_TERMINATOR,0x00) /*!< terminator character not found ("\r\n" expected) */
#define ESP_AT_CMD_ERROR_NOT_FOUND_AT ESP_AT_ERROR_NO(ESP_AT_SUB_NO_AT,0x00) /*!< Starting "AT" not found (or at, At or aT entered) */
#define ESP_AT_CMD_ERROR_PARA_LENGTH(which_para) ESP_AT_ERROR_NO(ESP_AT_SUB_PARA_LENGTH_MISMATCH,which_para) /*!< parameter length mismatch */
#define ESP_AT_CMD_ERROR_PARA_TYPE(which_para) ESP_AT_ERROR_NO(ESP_AT_SUB_PARA_TYPE_MISMATCH,which_para) /*!< parameter type mismatch */
#define ESP_AT_CMD_ERROR_PARA_NUM(need,given) ESP_AT_ERROR_NO(ESP_AT_SUB_PARA_NUM_MISMATCH,(((need) << 8) | (given))) /*!< parameter number mismatch */
#define ESP_AT_CMD_ERROR_PARA_INVALID(which_para) ESP_AT_ERROR_NO(ESP_AT_SUB_PARA_INVALID,which_para) /*!< the parameter is invalid */
#define ESP_AT_CMD_ERROR_PARA_PARSE_FAIL(which_para) ESP_AT_ERROR_NO(ESP_AT_SUB_PARA_PARSE_FAIL,which_para) /*!< parse parameter fail */
#define ESP_AT_CMD_ERROR_CMD_UNSUPPORT ESP_AT_ERROR_NO(ESP_AT_SUB_UNSUPPORT_CMD,0x00) /*!< the command is not supported */
#define ESP_AT_CMD_ERROR_CMD_EXEC_FAIL(result) ESP_AT_ERROR_NO(ESP_AT_SUB_CMD_EXEC_FAIL,result) /*!< the command execution failed */
#define ESP_AT_CMD_ERROR_CMD_PROCESSING ESP_AT_ERROR_NO(ESP_AT_SUB_CMD_PROCESSING,0x00) /*!< processing of previous command is in progress */
#define ESP_AT_CMD_ERROR_CMD_OP_ERROR ESP_AT_ERROR_NO(ESP_AT_SUB_CMD_OP_ERROR,0x00) /*!< the command operation type is error */
/**
* @brief the result of AT parse
*
*/
typedef enum {
ESP_AT_PARA_PARSE_RESULT_FAIL = -1, /*!< parse fail,Maybe the type of parameter is mismatched,or out of range */
ESP_AT_PARA_PARSE_RESULT_OK = 0, /*!< Successful */
ESP_AT_PARA_PARSE_RESULT_OMITTED, /*!< the parameter is OMITTED. */
} esp_at_para_parse_result_type;
/**
* @brief the result code of AT command processing
*
*/
typedef enum {
ESP_AT_RESULT_CODE_OK = 0x00, /*!< "OK" */
ESP_AT_RESULT_CODE_ERROR = 0x01, /*!< "ERROR" */
ESP_AT_RESULT_CODE_FAIL = 0x02, /*!< "ERROR" */
ESP_AT_RESULT_CODE_SEND_OK = 0x03, /*!< "SEND OK" */
ESP_AT_RESULT_CODE_SEND_FAIL = 0x04, /*!< "SEND FAIL" */
ESP_AT_RESULT_CODE_IGNORE = 0x05, /*!< response nothing, just change internal status */
ESP_AT_RESULT_CODE_PROCESS_DONE = 0x06, /*!< response nothing, just change internal status */
ESP_AT_RESULT_CODE_MAX
} esp_at_result_code_string_index;
/**
* @brief This function should be called only once, before any other AT functions are called.
*
* @param netconn_max the maximum number of the link in the at module
* @param custom_version version information by custom
*/
void esp_at_module_init(uint32_t netconn_max, const uint8_t *custom_version);
/**
* @brief Parse digit parameter from command string.
*
* @param para_index the index of parameter
* @param value the value parsed
*
* @return
* - ESP_AT_PARA_PARSE_RESULT_OK : succeed
* - ESP_AT_PARA_PARSE_RESULT_FAIL : fail
* - ESP_AT_PARA_PARSE_RESULT_OMITTED : this parameter is OMITTED
*/
esp_at_para_parse_result_type esp_at_get_para_as_digit(int32_t para_index, int32_t *value);
/**
* @brief Parse string parameter from command string.
*
* @param para_index the index of parameter
* @param result the pointer that point to the result.
*
* @return
* - ESP_AT_PARA_PARSE_RESULT_OK : succeed
* - ESP_AT_PARA_PARSE_RESULT_FAIL : fail
* - ESP_AT_PARA_PARSE_RESULT_OMITTED : this parameter is OMITTED
*/
esp_at_para_parse_result_type esp_at_get_para_as_str(int32_t para_index, uint8_t **result);
/**
* @brief Calling the esp_at_port_recv_data_notify_from_isr to notify at module that at port received data.
* When received this notice,at task will get data by calling get_data_length and read_data in esp_at_device_ops.
* This function MUST be used in isr.
*
* @param len data length
*
*/
void esp_at_port_recv_data_notify_from_isr(int32_t len);
/**
* @brief Calling the esp_at_port_recv_data_notify to notify at module that at port received data.
* When received this notice,at task will get data by calling get_data_length and read_data in esp_at_device_ops.
* This function MUST NOT be used in isr.
*
* @param len data length
* @param msec timeout time,The unit is millisecond. It waits forever,if msec is portMAX_DELAY.
*
* @return
* - true : succeed
* - false : fail
*/
bool esp_at_port_recv_data_notify(int32_t len, uint32_t msec);
/**
* @brief terminal transparent transmit mode,This function MUST be used in isr.
*
*/
void esp_at_transmit_terminal_from_isr(void);
/**
* @brief terminal transparent transmit mode,This function MUST NOT be used in isr.
*
*/
void esp_at_transmit_terminal(void);
/**
* @brief regist at command set, which defined by custom,
*
* @param custom_at_cmd_array at command set
* @param cmd_num command number
*
*/
bool esp_at_custom_cmd_array_regist(const esp_at_cmd_struct *custom_at_cmd_array, uint32_t cmd_num);
/**
* @brief regist device operate functions set,
*
* @param ops device operate functions set
*
*/
void esp_at_device_ops_regist(esp_at_device_ops_struct* ops);
/*
* @brief regist custom callback about socket status,
*
* @param link_id the link id
* @param ops custom operate functions set
*
* Note: Make sure this API call after esp_at_module_init.
*/
bool esp_at_custom_net_ops_regist (int32_t link_id,esp_at_custom_net_ops_struct* ops);
/*
* @brief regist custom callback about ble status,
*
* @param ops custom operate functions set
*
* Note: Make sure this API call after esp_at_module_init.
*/
bool esp_at_custom_ble_ops_regist(int32_t conn_index, esp_at_custom_ble_ops_struct* ops);
/**
* @brief regist custom operate functions set interacting with AT,
*
* @param ops custom operate functions set
*
*/
void esp_at_custom_ops_regist(esp_at_custom_ops_struct* ops);
/**
* @brief get at module version number,
*
* @return at version bit31~bit24: at main version
* bit23~bit16: at sub version
* bit15~bit8 : at test version
* bit7~bit0 : at custom version
*/
uint32_t esp_at_get_version(void);
/**
* @brief response AT process result,
*
* @param result_code see esp_at_result_code_string_index
*
*/
void esp_at_response_result(uint8_t result_code);
/**
* @brief write data into device,
*
* @param data data buffer to be written
* @param len data length
*
* @return
* - >= 0 : the real length of the data written
* - others : fail.
*/
int32_t esp_at_port_write_data(uint8_t *data, int32_t len);
/**
* @brief read data from device,
*
* @param data data buffer
* @param len data length
*
* @return
* - >= 0 : the real length of the data read from device
* - others : fail
*/
int32_t esp_at_port_read_data(uint8_t*data,int32_t len);
/**
* @brief wait for transmitting data completely to peer device,
*
* @param timeout_msec timeout time,The unit is millisecond.
*
* @return
* - true : succeed,transmit data completely
* - false : fail
*/
bool esp_at_port_wait_write_complete(int32_t timeout_msec);
/**
* @brief get the length of the data received,
*
* @return
* - >= 0 : the length of the data received
* - others : fail
*/
int32_t esp_at_port_get_data_length(void);
/**
* @brief regist at base command set. If not,you can not use AT base command
*
*/
bool esp_at_base_cmd_regist(void);
/**
* @brief regist at wifi command set. If not,you can not use AT wifi command
*
*/
bool esp_at_wifi_cmd_regist(void);
/**
* @brief regist at net command set. If not,you can not use AT net command
*
*/
bool esp_at_net_cmd_regist(void);
/**
* @brief regist at mdns command set. If not,you can not use AT mdns command
*
*/
bool esp_at_mdns_cmd_regist(void);
/**
* @brief regist at driver command set. If not,you can not use AT driver command
*
*/
bool esp_at_driver_cmd_regist(void);
/**
* @brief regist at wps command set. If not,you can not use AT wps command
*
*/
bool esp_at_wps_cmd_regist(void);
/**
* @brief regist at smartconfig command set. If not,you can not use AT smartconfig command
*
*/
bool esp_at_smartconfig_cmd_regist(void);
/**
* @brief regist at ping command set. If not,you can not use AT ping command
*
*/
bool esp_at_ping_cmd_regist(void);
/**
* @brief regist at http command set. If not,you can not use AT http command
*
*/
bool esp_at_http_cmd_regist(void);
/**
* @brief regist at mqtt command set. If not,you can not use AT mqtt command
*
*/
bool esp_at_mqtt_cmd_regist(void);
/**
* @brief regist at ble command set. If not,you can not use AT ble command
*
*/
bool esp_at_ble_cmd_regist(void);
/**
* @brief regist at ble hid command set. If not,you can not use AT ble hid command
*
*/
bool esp_at_ble_hid_cmd_regist(void);
/**
* @brief regist at blufi command set. If not,you can not use AT blufi command
*
*/
bool esp_at_blufi_cmd_regist(void);
/**
* @brief regist at bt command set. If not,you can not use AT bt command
*
*/
bool esp_at_bt_cmd_regist(void);
/**
* @brief regist at bt spp command set. If not,you can not use AT bt spp command
*
*/
bool esp_at_bt_spp_cmd_regist(void);
/**
* @brief regist at bt a2dp command set. If not,you can not use AT bt a2dp command
*
*/
bool esp_at_bt_a2dp_cmd_regist(void);
/**
* @brief regist at fs command set. If not,you can not use AT fs command
*
*
*/
bool esp_at_fs_cmd_regist(void);
/**
* @brief regist at WPA2 Enterprise AP command set. If not,you can not use AT EAP command
*
*/
bool esp_at_eap_cmd_regist(void);
/**
* @brief regist at ethernet command set. If not,you can not use AT ethernet command
*
*/
bool esp_at_eth_cmd_regist(void);
/**
* @brief Set AT command terminator, by default, the terminator is "\r\n"
* You can change it by calling this function, but it just supports one character now.
* @param terminator: the line terminator
*
* @return
* - true : succeed,transmit data completely
* - false : fail
*/
bool esp_at_custom_cmd_line_terminator_set(uint8_t* terminator);
/**
* @brief Get AT command line terminator,by default, the return string is "\r\n"
*
* @return the command line terminator
*/
uint8_t* esp_at_custom_cmd_line_terminator_get(void);
/**
* @brief Find the partition which is defined in at_customize.csv
* @param type: the type of the partition
* @param subtype: the subtype of the partition
* @param label: Partition label
*
* @return pointer to esp_partition_t structure, or NULL if no partition is found.
* This pointer is valid for the lifetime of the application
*/
const esp_partition_t* esp_at_custom_partition_find(esp_partition_type_t type, esp_partition_subtype_t subtype, const char* label);
/**
* @brief regist at ethernet command set. If not,you can not use AT ethernet command
*
*
*/
bool esp_at_eth_cmd_regist(void);
/**
* @brief Set AT core as specific status, it will call callback if receiving data.
* for example:
*
* @code{c}
* static void wait_data_callback (void)
* {
* xSemaphoreGive(sync_sema);
* }
*
* void process_task(void* para)
* {
* vSemaphoreCreateBinary(sync_sema);
* xSemaphoreTake(sync_sema,portMAX_DELAY);
* esp_at_port_write_data((uint8_t *)">",strlen(">"));
* esp_at_port_enter_specific(wait_data_callback);
* while(xSemaphoreTake(sync_sema,portMAX_DELAY)) {
* len = esp_at_port_read_data(data, data_len);
* // TODO:
* }
* }
* @endcode
* @param callback: which will be called when received data from AT port
*
*/
void esp_at_port_enter_specific(esp_at_port_specific_callback_t callback);
/**
* @brief Exit AT core as specific status.
*
*/
void esp_at_port_exit_specific(void);
/**
* @brief Get current AT command name.
*
*/
const uint8_t* esp_at_get_current_cmd_name(void);
/**
* @brief Wi-Fi event handler callback, which used in AT core.
* @param ctx reserved for user
* @param event event type defined in this file
*
* @return
* - ESP_OK: succeed
* - others: fail
*/
esp_err_t esp_at_wifi_event_handler(void *ctx, system_event_t *event);
#endif