at.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 Kaspar Schleiser <kaspar@schleiser.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include <unistd.h>
#include <stdbool.h>
 
#include "isrpipe.h"
#include "periph/uart.h"
#include "clist.h"
#include "kernel_defines.h"
 
#include "event.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#if IS_ACTIVE(CONFIG_AT_SEND_EOL_WINDOWS)
#define CONFIG_AT_SEND_EOL   "\r\n"
#elif IS_ACTIVE(CONFIG_AT_SEND_EOL_UNIX)
#define CONFIG_AT_SEND_EOL   "\n"
#elif IS_ACTIVE(CONFIG_AT_SEND_EOL_MAC)
#define CONFIG_AT_SEND_EOL   "\r"
#endif
 
#ifndef CONFIG_AT_SEND_EOL
#define CONFIG_AT_SEND_EOL "\r"
#endif

#ifdef DOXYGEN
#define CONFIG_AT_SEND_SKIP_ECHO
#endif

#ifndef AT_RECV_EOL_1
#define AT_RECV_EOL_1   "\r"
#endif

#ifndef AT_RECV_EOL_2
#define AT_RECV_EOL_2   "\n"
#endif

#define AT_RECV_EOL AT_RECV_EOL_1 AT_RECV_EOL_2

#ifndef CONFIG_AT_RECV_OK
#define CONFIG_AT_RECV_OK "OK"
#endif

#ifndef CONFIG_AT_RECV_ERROR
#define CONFIG_AT_RECV_ERROR "ERROR"
#endif
 
#if defined(MODULE_AT_URC) || DOXYGEN
typedef void (*at_urc_cb_t)(void *arg, const char *code);

typedef struct {
    clist_node_t list_node; 
    at_urc_cb_t cb;         
    const char *code;       
    void *arg;              
} at_urc_t;
 
#endif /* MODULE_AT_URC */

#define AT_ERR_EXTENDED 200

#define AT_SEND_EOL_LEN  (sizeof(CONFIG_AT_SEND_EOL) - 1)

typedef struct {
    isrpipe_t isrpipe;      
    uart_t uart;            
    char *rp_buf;           
    size_t rp_buf_size;     
#ifdef MODULE_AT_URC
    clist_node_t urc_list;  
#ifdef MODULE_AT_URC_ISR
    bool awaiting_response; 
    event_t event;          
#endif
#endif
} at_dev_t;

typedef struct {
    uart_t uart;            
    uint32_t baudrate;      
    char *rx_buf;           
    size_t rx_buf_size;     
    char *rp_buf;
    size_t rp_buf_size;     
} at_dev_init_t;

static inline char const *at_get_err_info(at_dev_t const *dev)
{
    return dev->rp_buf;
}

int at_dev_init(at_dev_t *dev, at_dev_init_t const *init);

int at_send_cmd_wait_ok(at_dev_t *dev, const char *command, uint32_t timeout);

int at_send_cmd_wait_prompt(at_dev_t *dev, const char *command, uint32_t timeout);

int at_wait_prompt(at_dev_t *dev, uint32_t timeout);
ssize_t at_send_cmd_get_resp(at_dev_t *dev, const char *command, char *resp_buf,
                             size_t len, uint32_t timeout);
ssize_t at_get_resp_with_prefix(at_dev_t *dev, const char *resp_prefix,
                                char *resp_buf, size_t len, uint32_t timeout);
ssize_t at_send_cmd_get_resp_wait_ok(at_dev_t *dev, const char *command, const char *resp_prefix,
                                     char *resp_buf, size_t len, uint32_t timeout);

ssize_t at_send_cmd_get_lines(at_dev_t *dev, const char *command, char *resp_buf,
                              size_t len, uint32_t timeout);

int at_expect_bytes(at_dev_t *dev, const char *bytes, uint32_t timeout);

int at_wait_bytes(at_dev_t *dev, const char *bytes, uint32_t timeout);

int at_recv_bytes_until_string(at_dev_t *dev, const char *string,
                               char *bytes, size_t *bytes_len,
                               uint32_t timeout);

void at_send_bytes(at_dev_t *dev, const char *bytes, size_t len);

ssize_t at_recv_bytes(at_dev_t *dev, char *bytes, size_t len, uint32_t timeout);

int at_send_cmd(at_dev_t *dev, const char *command, uint32_t timeout);

int at_parse_resp(at_dev_t *dev, char const *resp);

ssize_t at_readline(at_dev_t *dev, char *resp_buf, size_t len, bool keep_eol, uint32_t timeout);

ssize_t at_readline_skip_empty(at_dev_t *dev, char *resp_buf, size_t len,
                               bool keep_eol, uint32_t timeout);

int at_wait_ok(at_dev_t *dev, uint32_t timeout);

void at_drain(at_dev_t *dev);

void at_dev_poweron(at_dev_t *dev);

void at_dev_poweroff(at_dev_t *dev);
 
#if defined(MODULE_AT_URC) || DOXYGEN
void at_add_urc(at_dev_t *dev, at_urc_t *urc);

void at_remove_urc(at_dev_t *dev, at_urc_t *urc);

void at_process_urc(at_dev_t *dev, uint32_t timeout);

void at_postprocess_urc(at_dev_t *dev, char *buf);
void at_postprocess_urc_all(at_dev_t *dev, char *buf);
#endif
 
#ifdef __cplusplus
}
#endif