-
Notifications
You must be signed in to change notification settings - Fork 37
/
Copy pathArduino_ConnectionHandler.h
235 lines (190 loc) · 7.38 KB
/
Arduino_ConnectionHandler.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
/*
This file is part of ArduinoIoTCloud.
Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
This software is released under the GNU General Public License version 3,
which covers the main part of arduino-cli.
The terms of this license can be found at:
https://www.gnu.org/licenses/gpl-3.0.en.html
You can be released from the requirements of the above licenses by purchasing
a commercial license. Buying such a license is mandatory if you want to modify or
otherwise use the software for commercial activities involving the Arduino
software without disclosing the source code of your own applications. To purchase
a commercial license, send an email to [email protected].
*/
#ifndef ARDUINO_CONNECTION_HANDLER_H_
#define ARDUINO_CONNECTION_HANDLER_H_
#ifdef ARDUINO_SAMD_MKR1000
#include <WiFi101.h>
#include <WiFiUdp.h>
#define BOARD_HAS_WIFI
#define NETWORK_HARDWARE_ERROR WL_NO_SHIELD
#define NETWORK_IDLE_STATUS WL_IDLE_STATUS
#define NETWORK_CONNECTED WL_CONNECTED
#define WIFI_FIRMWARE_VERSION_REQUIRED WIFI_FIRMWARE_REQUIRED
#endif
#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT)
#include <WiFiNINA.h>
#include <WiFiUdp.h>
#define BOARD_HAS_WIFI
#define NETWORK_HARDWARE_ERROR WL_NO_MODULE
#define NETWORK_IDLE_STATUS WL_IDLE_STATUS
#define NETWORK_CONNECTED WL_CONNECTED
#define WIFI_FIRMWARE_VERSION_REQUIRED WIFI_FIRMWARE_LATEST_VERSION
#endif
#if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
#include <WiFi.h>
#include <WiFiUdp.h>
#define BOARD_HAS_WIFI
#define NETWORK_HARDWARE_ERROR WL_NO_SHIELD
#define NETWORK_IDLE_STATUS WL_IDLE_STATUS
#define NETWORK_CONNECTED WL_CONNECTED
#endif
#ifdef ARDUINO_SAMD_MKRGSM1400
#include <MKRGSM.h>
#define BOARD_HAS_GSM
#define NETWORK_HARDWARE_ERROR GPRS_PING_ERROR
#define NETWORK_IDLE_STATUS GSM3_NetworkStatus_t::IDLE
#define NETWORK_CONNECTED GSM3_NetworkStatus_t::GPRS_READY
#endif
#ifdef ARDUINO_SAMD_MKRNB1500
#include <MKRNB.h>
#define BOARD_HAS_NB
#define NETWORK_HARDWARE_ERROR
#define NETWORK_IDLE_STATUS NB_NetworkStatus_t::IDLE
#define NETWORK_CONNECTED NB_NetworkStatus_t::GPRS_READY
#endif
#if defined(ARDUINO_SAMD_MKRWAN1300) || defined(ARDUINO_SAMD_MKRWAN1310)
#include <MKRWAN.h>
#define BOARD_HAS_LORA
#endif
#if defined(ARDUINO_ESP8266_ESP12) \
|| defined(ESP8266) \
|| defined(ESP8266_ESP01) \
|| defined(ESP8266_ESP13) \
|| defined(ESP8266_GENERIC) \
|| defined(ESP8266_ESPRESSO_LITE_V1) \
|| defined(ESP8266_ESPRESSO_LITE_V2) \
|| defined(ESP8266_PHOENIX_V1) \
|| defined(ESP8266_PHOENIX_V2) \
|| defined(ESP8266_NODEMCU) \
|| defined(MOD_WIFI_ESP8266) \
|| defined(ESP8266_THING) \
|| defined(ESP8266_THING_DEV) \
|| defined(ESP8266_ESP210) \
|| defined(ESP8266_WEMOS_D1MINI) \
|| defined(ESP8266_WEMOS_D1MINIPRO) \
|| defined(ESP8266_WEMOS_D1MINILITE) \
|| defined(ESP8266_WEMOS_D1R1) \
|| defined(ESP8266_ESP12) \
|| defined(WIFINFO) \
|| defined(ESP8266_ARDUINO) \
|| defined(GEN4_IOD) \
|| defined(ESP8266_OAK) \
|| defined(WIFIDUINO_ESP8266) \
|| defined(AMPERKA_WIFI_SLOT) \
|| defined(ESP8266_WIO_LINK) \
|| defined(ESP8266_ESPECTRO_CORE)
#define BOARD_ESP8266
#endif
#if defined(BOARD_ESP8266)
#include <ESP8266WiFi.h>
#include <WiFiUdp.h>
#define BOARD_HAS_WIFI
#define NETWORK_HARDWARE_ERROR WL_NO_SHIELD
#define NETWORK_IDLE_STATUS WL_IDLE_STATUS
#define NETWORK_CONNECTED WL_CONNECTED
#define WIFI_FIRMWARE_VERSION_REQUIRED WIFI_FIRMWARE_REQUIRED
#endif
//#define ARDUINO_ETHERNET_SHIELD /* Uncomment this line if you want to use a ethernet shield via e.g. MKR ETH Shield */
#if defined(ARDUINO_ETHERNET_SHIELD)
#include <SPI.h>
#include <Ethernet.h>
#define BOARD_HAS_ETHERNET
#endif
/******************************************************************************
INCLUDES
******************************************************************************/
#include <Arduino_DebugUtils.h>
/******************************************************************************
TYPEDEFS
******************************************************************************/
enum class NetworkConnectionState : unsigned int {
INIT = 0,
CONNECTING = 1,
CONNECTED = 2,
DISCONNECTING = 3,
DISCONNECTED = 4,
CLOSED = 5,
ERROR = 6
};
enum class NetworkConnectionEvent {
CONNECTED,
DISCONNECTED,
ERROR
};
typedef void (*OnNetworkEventCallback)();
/******************************************************************************
CONSTANTS
******************************************************************************/
static unsigned int const CHECK_INTERVAL_TABLE[] =
{
/* INIT */ 100,
/* CONNECTING */ 500,
/* CONNECTED */ 10000,
/* DISCONNECTING */ 100,
/* DISCONNECTED */ 1000,
/* CLOSED */ 1000,
/* ERROR */ 1000
};
/******************************************************************************
CLASS DECLARATION
******************************************************************************/
class ConnectionHandler {
public:
ConnectionHandler(bool const keep_alive);
NetworkConnectionState check();
#if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET)
virtual unsigned long getTime() = 0;
virtual Client &getClient() = 0;
virtual UDP &getUDP() = 0;
#endif
#if defined(BOARD_HAS_LORA)
virtual int write(const uint8_t *buf, size_t size) = 0;
virtual int read() = 0;
virtual bool available() = 0;
#endif
NetworkConnectionState getStatus() __attribute__((deprecated)) {
return _current_net_connection_state;
}
void connect();
void disconnect();
void addCallback(NetworkConnectionEvent const event, OnNetworkEventCallback callback);
void addConnectCallback(OnNetworkEventCallback callback) __attribute__((deprecated));
void addDisconnectCallback(OnNetworkEventCallback callback) __attribute__((deprecated));
void addErrorCallback(OnNetworkEventCallback callback) __attribute__((deprecated));
protected:
bool _keep_alive;
virtual NetworkConnectionState update_handleInit () = 0;
virtual NetworkConnectionState update_handleConnecting () = 0;
virtual NetworkConnectionState update_handleConnected () = 0;
virtual NetworkConnectionState update_handleDisconnecting() = 0;
virtual NetworkConnectionState update_handleDisconnected () = 0;
private:
unsigned long _lastConnectionTickTime;
NetworkConnectionState _current_net_connection_state;
OnNetworkEventCallback _on_connect_event_callback = NULL,
_on_disconnect_event_callback = NULL,
_on_error_event_callback = NULL;
};
#if defined(BOARD_HAS_ETHERNET)
#include "Arduino_EthernetConnectionHandler.h"
#elif defined(BOARD_HAS_WIFI)
#include "Arduino_WiFiConnectionHandler.h"
#elif defined(BOARD_HAS_GSM)
#include "Arduino_GSMConnectionHandler.h"
#elif defined(BOARD_HAS_NB)
#include "Arduino_NBConnectionHandler.h"
#elif defined(BOARD_HAS_LORA)
#include "Arduino_LoRaConnectionHandler.h"
#endif
#endif /* CONNECTION_HANDLER_H_ */