Class hal::esp8266::at

ClassList > hal > esp8266 > at

AT Command network driver for the esp8266 .More...

• #include <at.hpp>

Classes

Type	Name
struct	read_t
struct	socket_config
struct	write_t

Public Types

Type	Name
typedef hal::function_ref< hal::timeout_function >	deadline
enum std::uint8_t	socket_type

Public Functions

Type	Name
hal::status	connect_to_ap (std::string_view p_ssid, std::string_view p_password, deadline p_timeout)
hal::status	connect_to_server (socket_config p_config, deadline p_timeout)
hal::status	disconnect_from_ap (deadline p_timeout)
hal::status	disconnect_from_server (deadline p_timeout)
hal::result< bool >	is_connected_to_ap (deadline p_timeout)
hal::result< bool >	is_connected_to_server (deadline p_timeout)
hal::status	reset (deadline p_timeout)
hal::result< read_t >	server_read (std::span< hal::byte > p_data)
hal::result< write_t >	server_write (std::span< const hal::byte > p_data, deadline p_timeout)
hal::status	set_ip_address (std::string_view p_ip, deadline p_timeout)

Public Static Functions

Type	Name
result< at >	create (hal::serial & p_serial, deadline p_timeout)
result< at & >	initialize (hal::serial & p_serial, deadline p_timeout)

Detailed Description

The esp8266::at driver can be used to connect to a WiFi access points (AP) and sending network traffic using TCP and UDP over IP.

Public Types Documentation

typedef deadline

using hal::esp8266::at::deadline =  hal::function_ref<hal::timeout_function>;

enum socket_type

enum hal::esp8266::at::socket_type {
    tcp,
    udp
};

Public Functions Documentation

function connect_to_ap

hal::status hal::esp8266::at::connect_to_ap (
    std::string_view p_ssid,
    std::string_view p_password,
    deadline p_timeout
) 

function connect_to_server

hal::status hal::esp8266::at::connect_to_server (
    socket_config p_config,
    deadline p_timeout
) 

function disconnect_from_ap

hal::status hal::esp8266::at::disconnect_from_ap (
    deadline p_timeout
) 

function disconnect_from_server

hal::status hal::esp8266::at::disconnect_from_server (
    deadline p_timeout
) 

function is_connected_to_ap

hal::result< bool > hal::esp8266::at::is_connected_to_ap (
    deadline p_timeout
) 

function is_connected_to_server

hal::result< bool > hal::esp8266::at::is_connected_to_server (
    deadline p_timeout
) 

function reset

hal::status hal::esp8266::at::reset (
    deadline p_timeout
) 

function server_read

hal::result< read_t > hal::esp8266::at::server_read (
    std::span< hal::byte > p_data
) 

function server_write

hal::result< write_t > hal::esp8266::at::server_write (
    std::span< const hal::byte > p_data,
    deadline p_timeout
) 

function set_ip_address

hal::status hal::esp8266::at::set_ip_address (
    std::string_view p_ip,
    deadline p_timeout
) 

Public Static Functions Documentation

function create

static result< at > hal::esp8266::at::create (
    hal::serial & p_serial,
    deadline p_timeout
) 

function initialize

template<unsigned id>
static result< at & > hal::esp8266::at::initialize (
    hal::serial & p_serial,
    deadline p_timeout
) 

---

The documentation for this class was generated from the following file libraries/include/libhal-esp8266/at.hpp