summaryrefslogtreecommitdiff
path: root/src/wifi_module.hpp
blob: 5a4148c94118bf74e8ef6a33312a586e20719060 (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
#pragma once

#include <SoftwareSerial.h>
#include <stddef.h>
#include <stdint.h>

constexpr auto MAX_NETWORK_MODULE_RESPONSE_LENGTH = 128U;

enum WifiMode
{
	Station = 1,
	SoftAP = 2,
	SoftAPAndStation = 3
};

enum ResponseStatus
{
	OK,
	FAIL,
	ERROR,
	TIMEOUT
};

class WiFiModule
{
public:
	WiFiModule(uint8_t receive_pin, uint8_t transmit_pin) noexcept;

	void begin(size_t baudrate) noexcept;

	int get_available() noexcept;

	void reset() noexcept;

	/**
	 * Connects to a wifi network.
	 *
	 * @param ssid The service set identifier of a wifi network.
	 * @param password The wifi network password.
	 *
	 * @returns Whether or not it succeeded.
	 */
	bool connect(const char *ssid, const char *password) noexcept;

	void set_wifi_mode(WifiMode wifi_mode) noexcept;

	void set_multiple_connections_enabled(bool is_enabled) noexcept;

	void set_echo_enabled(bool is_enabled) noexcept;

	void create_tcp_server(size_t port) noexcept;

	/**
	 * Tests the connection to the wifi module.
	 *
	 * @returns Whether or not the test succeeded.
	 */
	bool test() noexcept;

	/**
	 * Gets local IP address of the wifi module.
	 *
	 * @param local_ip_out Local IP output buffer.
	 *
	 * @returns A pointer to the local IP output buffer.
	 */
	const char *get_local_ip(char *local_ip_out) noexcept;

private:
	SoftwareSerial _serial;

	/**
	 * Sends a command to the wifi module.
	 *
	 * @param command A command without the "AT+" in the beginning.
	 *
	 * @returns Whether or not it succeeded.
	 */
	bool _send_serial(const char *command) noexcept;

	/**
	 * Reads from the wifi module until it responds with a status.
	 *
	 * @param timeout Timeout in milliseconds.
	 * @param response_out Response output buffer.
	 *
	 * @returns The response status.
	 *
	 */
	ResponseStatus _read(uint64_t timeout, char *response_out) noexcept;

	char _read_byte() noexcept;
};