ra8_modem_at.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint8_t {
  k_ra8_modem_at_max_unsolicited = 8U, 
  k_ra8_modem_at_max_prefix_len =
    16U, 
} ra8_modem_at_limits_t;

typedef enum : uint16_t {
  k_ra8_modem_at_default_timeout_ms = 1000U, 
} ra8_modem_at_timeouts_t;

typedef struct {
  ra8_err_t (*tx_byte)(void* ctx, uint8_t byte);

  ra8_err_t (*rx_byte)(void* ctx, uint8_t* out_byte);

  uint32_t (*now_ms)(void* ctx);

  void* ctx;
} ra8_modem_at_io_t;

typedef struct {
  ra8_modem_at_io_t io;                 
  uint8_t*          line_buf;           
  uint16_t          line_buf_len;       
  uint16_t          default_timeout_ms; 
} ra8_modem_at_cfg_t;

typedef void (*ra8_modem_at_urc_fn_t)(const char* line, void* ctx);

[[nodiscard]] ra8_err_t ra8_modem_at_init(const ra8_modem_at_cfg_t* cfg);

[[nodiscard]] ra8_err_t
ra8_modem_at_send_cmd(const char* cmd, const char* expected_response, uint16_t timeout_ms);

[[nodiscard]] ra8_err_t
ra8_modem_at_send_cmd_capture(const char* cmd, char* out_buf, size_t buf_len, uint16_t timeout_ms);

[[nodiscard]] ra8_err_t
ra8_modem_at_register_unsolicited_handler(const char* prefix, ra8_modem_at_urc_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t ra8_modem_at_poll(void);
 
#ifdef __cplusplus
}
#endif