Skip to content

Commit bbbb043

Browse files
andreagilardoniandreagilardoni
committed
Refactoring debug messages into macro defined calls
1 parent 4893200 commit bbbb043

9 files changed

+158
-140
lines changed

‎src/CatM1ConnectionHandler.cpp

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ NetworkConnectionState CatM1ConnectionHandler::update_handleInit()
8181
_settings.catm1.band,
8282
_reset))
8383
{
84-
Debug.print(DBG_ERROR, F("The board was not able to register to the network..."));
84+
DEBUG_ERROR(F("The board was not able to register to the network..."));
8585
_reset = true;
8686
return NetworkConnectionState::DISCONNECTED;
8787
}
@@ -93,26 +93,26 @@ NetworkConnectionState CatM1ConnectionHandler::update_handleConnecting()
9393
{
9494
if (!GSM.isConnected())
9595
{
96-
Debug.print(DBG_ERROR, F("GSM connection not alive... disconnecting"));
96+
DEBUG_ERROR(F("GSM connection not alive... disconnecting"));
9797
return NetworkConnectionState::DISCONNECTED;
9898
}
9999

100100
if(!_check_internet_availability){
101101
return NetworkConnectionState::CONNECTED;
102102
}
103103

104-
Debug.print(DBG_INFO, F("Sending PING to outer space..."));
104+
DEBUG_INFO(F("Sending PING to outer space..."));
105105
int const ping_result = GSM.ping("time.arduino.cc");
106-
Debug.print(DBG_INFO, F("GSM.ping(): %d"), ping_result);
106+
DEBUG_INFO(F("GSM.ping(): %d"), ping_result);
107107
if (ping_result < 0)
108108
{
109-
Debug.print(DBG_ERROR, F("Internet check failed"));
110-
Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), 2 * CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
109+
DEBUG_ERROR(F("Internet check failed"));
110+
DEBUG_INFO(F("Retrying in \"%d\" milliseconds"), 2 * CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
111111
return NetworkConnectionState::CONNECTING;
112112
}
113113
else
114114
{
115-
Debug.print(DBG_INFO, F("Connected to Internet"));
115+
DEBUG_INFO(F("Connected to Internet"));
116116
return NetworkConnectionState::CONNECTED;
117117
}
118118
}
@@ -122,7 +122,7 @@ NetworkConnectionState CatM1ConnectionHandler::update_handleConnected()
122122
int const is_gsm_access_alive = GSM.isConnected();
123123
if (is_gsm_access_alive != 1)
124124
{
125-
Debug.print(DBG_ERROR, F("GSM connection not alive... disconnecting"));
125+
DEBUG_ERROR(F("GSM connection not alive... disconnecting"));
126126
return NetworkConnectionState::DISCONNECTED;
127127
}
128128
return NetworkConnectionState::CONNECTED;

‎src/CellularConnectionHandler.cpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ unsigned long CellularConnectionHandler::getTime()
4646

4747
UDP & CellularConnectionHandler::getUDP()
4848
{
49-
Debug.print(DBG_ERROR, F("CellularConnectionHandler has no UDP support"));
49+
DEBUG_ERROR(F("CellularConnectionHandler has no UDP support"));
5050
while(1) {};
5151
}
5252

@@ -59,15 +59,15 @@ NetworkConnectionState CellularConnectionHandler::update_handleInit()
5959
_cellular.begin();
6060
_cellular.setDebugStream(Serial);
6161
if (strlen(_settings.cell.pin) > 0 && !_cellular.unlockSIM(_settings.cell.pin)) {
62-
Debug.print(DBG_ERROR, F("SIM not present or wrong PIN"));
62+
DEBUG_ERROR(F("SIM not present or wrong PIN"));
6363
return NetworkConnectionState::ERROR;
6464
}
6565

6666
if (!_cellular.connect(String(_settings.cell.apn), String(_settings.cell.login), String(_settings.cell.pass))) {
67-
Debug.print(DBG_ERROR, F("The board was not able to register to the network..."));
67+
DEBUG_ERROR(F("The board was not able to register to the network..."));
6868
return NetworkConnectionState::ERROR;
6969
}
70-
Debug.print(DBG_INFO, F("Connected to Network"));
70+
DEBUG_INFO(F("Connected to Network"));
7171
return NetworkConnectionState::CONNECTING;
7272
}
7373

@@ -82,8 +82,8 @@ NetworkConnectionState CellularConnectionHandler::update_handleConnecting()
8282
}
8383

8484
if(getTime() == 0){
85-
Debug.print(DBG_ERROR, F("Internet check failed"));
86-
Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
85+
DEBUG_ERROR(F("Internet check failed"));
86+
DEBUG_INFO(F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
8787
return NetworkConnectionState::CONNECTING;
8888
}
8989

‎src/EthernetConnectionHandler.cpp

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ EthernetConnectionHandler::EthernetConnectionHandler(
6969
NetworkConnectionState EthernetConnectionHandler::update_handleInit()
7070
{
7171
if (Ethernet.hardwareStatus() == EthernetNoHardware) {
72-
Debug.print(DBG_ERROR, F("Error, ethernet shield was not found."));
72+
DEBUG_ERROR(F("Error, ethernet shield was not found."));
7373
return NetworkConnectionState::ERROR;
7474
}
7575
IPAddress ip(_settings.eth.ip.type, _settings.eth.ip.bytes);
@@ -83,16 +83,16 @@ NetworkConnectionState EthernetConnectionHandler::update_handleInit()
8383
_settings.eth.timeout,
8484
_settings.eth.response_timeout) == 0) {
8585

86-
Debug.print(DBG_ERROR, F("Failed to configure Ethernet, check cable connection"));
87-
Debug.print(DBG_VERBOSE, "timeout: %d, response timeout: %d",
86+
DEBUG_ERROR(F("Failed to configure Ethernet, check cable connection"));
87+
DEBUG_VERBOSE("timeout: %d, response timeout: %d",
8888
_settings.eth.timeout, _settings.eth.response_timeout);
8989
return NetworkConnectionState::INIT;
9090
}
9191
// An ip address is not provided -> dhcp configuration
9292
} else {
9393
if (Ethernet.begin(nullptr, _settings.eth.timeout, _settings.eth.response_timeout) == 0) {
94-
Debug.print(DBG_ERROR, F("Waiting Ethernet configuration from DHCP server, check cable connection"));
95-
Debug.print(DBG_VERBOSE, "timeout: %d, response timeout: %d",
94+
DEBUG_ERROR(F("Waiting Ethernet configuration from DHCP server, check cable connection"));
95+
DEBUG_VERBOSE("timeout: %d, response timeout: %d",
9696
_settings.eth.timeout, _settings.eth.response_timeout);
9797

9898
return NetworkConnectionState::INIT;
@@ -113,16 +113,16 @@ NetworkConnectionState EthernetConnectionHandler::update_handleConnecting()
113113
}
114114

115115
int ping_result = Ethernet.ping("time.arduino.cc");
116-
Debug.print(DBG_INFO, F("Ethernet.ping(): %d"), ping_result);
116+
DEBUG_INFO(F("Ethernet.ping(): %d"), ping_result);
117117
if (ping_result < 0)
118118
{
119-
Debug.print(DBG_ERROR, F("Internet check failed"));
120-
Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
119+
DEBUG_ERROR(F("Internet check failed"));
120+
DEBUG_INFO(F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
121121
return NetworkConnectionState::CONNECTING;
122122
}
123123
else
124124
{
125-
Debug.print(DBG_INFO, F("Connected to Internet"));
125+
DEBUG_INFO(F("Connected to Internet"));
126126
return NetworkConnectionState::CONNECTED;
127127
}
128128

@@ -131,10 +131,10 @@ NetworkConnectionState EthernetConnectionHandler::update_handleConnecting()
131131
NetworkConnectionState EthernetConnectionHandler::update_handleConnected()
132132
{
133133
if (Ethernet.linkStatus() == LinkOFF) {
134-
Debug.print(DBG_ERROR, F("Ethernet link OFF, connection lost."));
134+
DEBUG_ERROR(F("Ethernet link OFF, connection lost."));
135135
if (_keep_alive)
136136
{
137-
Debug.print(DBG_ERROR, F("Attempting reconnection"));
137+
DEBUG_ERROR(F("Attempting reconnection"));
138138
}
139139
return NetworkConnectionState::DISCONNECTED;
140140
}

‎src/GSMConnectionHandler.cpp

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -80,25 +80,25 @@ NetworkConnectionState GSMConnectionHandler::update_handleInit()
8080

8181
if (_gsm.begin(_settings.gsm.pin) != GSM_READY)
8282
{
83-
Debug.print(DBG_ERROR, F("SIM not present or wrong PIN"));
83+
DEBUG_ERROR(F("SIM not present or wrong PIN"));
8484
return NetworkConnectionState::ERROR;
8585
}
8686

8787
mkr_gsm_feed_watchdog();
8888

89-
Debug.print(DBG_INFO, F("SIM card ok"));
89+
DEBUG_INFO(F("SIM card ok"));
9090
_gsm.setTimeout(GSM_TIMEOUT);
9191
_gprs.setTimeout(GPRS_TIMEOUT);
9292

9393
mkr_gsm_feed_watchdog();
9494

9595
GSM3_NetworkStatus_t const network_status = _gprs.attachGPRS(
9696
_settings.gsm.apn, _settings.gsm.login, _settings.gsm.pass, true);
97-
Debug.print(DBG_DEBUG, F("GPRS.attachGPRS(): %d"), network_status);
97+
DEBUG_DEBUG(F("GPRS.attachGPRS(): %d"), network_status);
9898
if (network_status == GSM3_NetworkStatus_t::ERROR)
9999
{
100-
Debug.print(DBG_ERROR, F("GPRS attach failed"));
101-
Debug.print(DBG_ERROR, F("Make sure the antenna is connected and reset your board."));
100+
DEBUG_ERROR(F("GPRS attach failed"));
101+
DEBUG_ERROR(F("Make sure the antenna is connected and reset your board."));
102102
return NetworkConnectionState::ERROR;
103103
}
104104

@@ -111,18 +111,18 @@ NetworkConnectionState GSMConnectionHandler::update_handleConnecting()
111111
return NetworkConnectionState::CONNECTED;
112112
}
113113

114-
Debug.print(DBG_INFO, F("Sending PING to outer space..."));
114+
DEBUG_INFO(F("Sending PING to outer space..."));
115115
int const ping_result = _gprs.ping("time.arduino.cc");
116-
Debug.print(DBG_INFO, F("GPRS.ping(): %d"), ping_result);
116+
DEBUG_INFO(F("GPRS.ping(): %d"), ping_result);
117117
if (ping_result < 0)
118118
{
119-
Debug.print(DBG_ERROR, F("PING failed"));
120-
Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
119+
DEBUG_ERROR(F("PING failed"));
120+
DEBUG_INFO(F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
121121
return NetworkConnectionState::CONNECTING;
122122
}
123123
else
124124
{
125-
Debug.print(DBG_INFO, F("Connected to GPRS Network"));
125+
DEBUG_INFO(F("Connected to GPRS Network"));
126126
return NetworkConnectionState::CONNECTED;
127127
}
128128
}

‎src/GenericConnectionHandler.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ static inline ConnectionHandler* instantiate_handler(NetworkAdapter adapter) {
146146
#endif
147147

148148
default:
149-
Debug.print(DBG_ERROR, "Network adapter not supported by this platform: %d", adapter);
149+
DEBUG_ERROR("Network adapter not supported by this platform: %d", adapter);
150150
return nullptr;
151151
}
152152
}

‎src/LoRaConnectionHandler.cpp

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,38 @@ int LoRaConnectionHandler::write(const uint8_t * buf, size_t size)
6969
{
7070
switch (err)
7171
{
72-
case LoRaCommunicationError::LORA_ERROR_ACK_NOT_RECEIVED: Debug.print(DBG_ERROR, F("Message ack was not received, the message could not be delivered")); break;
73-
case LoRaCommunicationError::LORA_ERROR_GENERIC: Debug.print(DBG_ERROR, F("LoRa generic error (LORA_ERROR)")); break;
74-
case LoRaCommunicationError::LORA_ERROR_WRONG_PARAM: Debug.print(DBG_ERROR, F("LoRa malformed param error (LORA_ERROR_PARAM")); break;
75-
case LoRaCommunicationError::LORA_ERROR_COMMUNICATION_BUSY: Debug.print(DBG_ERROR, F("LoRa chip is busy (LORA_ERROR_BUSY)")); break;
76-
case LoRaCommunicationError::LORA_ERROR_MESSAGE_OVERFLOW: Debug.print(DBG_ERROR, F("LoRa chip overflow error (LORA_ERROR_OVERFLOW)")); break;
77-
case LoRaCommunicationError::LORA_ERROR_NO_NETWORK_AVAILABLE: Debug.print(DBG_ERROR, F("LoRa no network error (LORA_ERROR_NO_NETWORK)")); break;
78-
case LoRaCommunicationError::LORA_ERROR_RX_PACKET: Debug.print(DBG_ERROR, F("LoRa rx error (LORA_ERROR_RX)")); break;
79-
case LoRaCommunicationError::LORA_ERROR_REASON_UNKNOWN: Debug.print(DBG_ERROR, F("LoRa unknown error (LORA_ERROR_UNKNOWN)")); break;
80-
case LoRaCommunicationError::LORA_ERROR_MAX_PACKET_SIZE: Debug.print(DBG_ERROR, F("Message length is bigger than max LoRa packet!")); break;
72+
case LoRaCommunicationError::LORA_ERROR_ACK_NOT_RECEIVED:
73+
DEBUG_ERROR(F("Message ack was not received, the message could not be delivered"));
74+
break;
75+
case LoRaCommunicationError::LORA_ERROR_GENERIC:
76+
DEBUG_ERROR(F("LoRa generic error (LORA_ERROR)"));
77+
break;
78+
case LoRaCommunicationError::LORA_ERROR_WRONG_PARAM:
79+
DEBUG_ERROR(F("LoRa malformed param error (LORA_ERROR_PARAM"));
80+
break;
81+
case LoRaCommunicationError::LORA_ERROR_COMMUNICATION_BUSY:
82+
DEBUG_ERROR(F("LoRa chip is busy (LORA_ERROR_BUSY)"));
83+
break;
84+
case LoRaCommunicationError::LORA_ERROR_MESSAGE_OVERFLOW:
85+
DEBUG_ERROR(F("LoRa chip overflow error (LORA_ERROR_OVERFLOW)"));
86+
break;
87+
case LoRaCommunicationError::LORA_ERROR_NO_NETWORK_AVAILABLE:
88+
DEBUG_ERROR(F("LoRa no network error (LORA_ERROR_NO_NETWORK)"));
89+
break;
90+
case LoRaCommunicationError::LORA_ERROR_RX_PACKET:
91+
DEBUG_ERROR(F("LoRa rx error (LORA_ERROR_RX)"));
92+
break;
93+
case LoRaCommunicationError::LORA_ERROR_REASON_UNKNOWN:
94+
DEBUG_ERROR(F("LoRa unknown error (LORA_ERROR_UNKNOWN)"));
95+
break;
96+
case LoRaCommunicationError::LORA_ERROR_MAX_PACKET_SIZE:
97+
DEBUG_ERROR(F("Message length is bigger than max LoRa packet!"));
98+
break;
8199
}
82100
}
83101
else
84102
{
85-
Debug.print(DBG_INFO, F("Message sent correctly!"));
103+
DEBUG_INFO(F("Message sent correctly!"));
86104
}
87105
return err;
88106
}
@@ -105,7 +123,7 @@ NetworkConnectionState LoRaConnectionHandler::update_handleInit()
105123
{
106124
if (!_modem.begin((_lora_band)_settings.lora.band))
107125
{
108-
Debug.print(DBG_ERROR, F("Something went wrong; are you indoor? Move near a window, then reset and retry."));
126+
DEBUG_ERROR(F("Something went wrong; are you indoor? Move near a window, then reset and retry."));
109127
return NetworkConnectionState::ERROR;
110128
}
111129
// Set channelmask based on configuration
@@ -116,7 +134,7 @@ NetworkConnectionState LoRaConnectionHandler::update_handleInit()
116134
delay(100);
117135
_modem.configureClass((_lora_class)_settings.lora.deviceClass);
118136
delay(100);
119-
Debug.print(DBG_INFO, F("Connecting to the network"));
137+
DEBUG_INFO(F("Connecting to the network"));
120138
return NetworkConnectionState::CONNECTING;
121139
}
122140

@@ -125,13 +143,13 @@ NetworkConnectionState LoRaConnectionHandler::update_handleConnecting()
125143
bool const network_status = _modem.joinOTAA(_settings.lora.appeui, _settings.lora.appkey);
126144
if (network_status != true)
127145
{
128-
Debug.print(DBG_ERROR, F("Connection to the network failed"));
129-
Debug.print(DBG_INFO, F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
146+
DEBUG_ERROR(F("Connection to the network failed"));
147+
DEBUG_INFO(F("Retrying in \"%d\" milliseconds"), CHECK_INTERVAL_TABLE[static_cast<unsigned int>(NetworkConnectionState::CONNECTING)]);
130148
return NetworkConnectionState::INIT;
131149
}
132150
else
133151
{
134-
Debug.print(DBG_INFO, F("Connected to the network"));
152+
DEBUG_INFO(F("Connected to the network"));
135153
return NetworkConnectionState::CONNECTED;
136154
}
137155
}
@@ -141,10 +159,10 @@ NetworkConnectionState LoRaConnectionHandler::update_handleConnected()
141159
bool const network_status = _modem.connected();
142160
if (network_status != true)
143161
{
144-
Debug.print(DBG_ERROR, F("Connection to the network lost."));
162+
DEBUG_ERROR(F("Connection to the network lost."));
145163
if (_keep_alive)
146164
{
147-
Debug.print(DBG_ERROR, F("Attempting reconnection"));
165+
DEBUG_ERROR(F("Attempting reconnection"));
148166
}
149167
return NetworkConnectionState::DISCONNECTED;
150168
}
@@ -153,10 +171,10 @@ NetworkConnectionState LoRaConnectionHandler::update_handleConnected()
153171

154172
NetworkConnectionState LoRaConnectionHandler::update_handleDisconnecting()
155173
{
156-
Debug.print(DBG_ERROR, F("Connection to the network lost."));
174+
DEBUG_ERROR(F("Connection to the network lost."));
157175
if (_keep_alive)
158176
{
159-
Debug.print(DBG_ERROR, F("Attempting reconnection"));
177+
DEBUG_ERROR(F("Attempting reconnection"));
160178
}
161179
return NetworkConnectionState::DISCONNECTED;
162180
}

‎src/NBConnectionHandler.cpp

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,52 +93,52 @@ NetworkConnectionState NBConnectionHandler::update_handleInit()
9393
_settings.nb.login,
9494
_settings.nb.pass) == NB_READY)
9595
{
96-
Debug.print(DBG_INFO, F("SIM card ok"));
96+
DEBUG_INFO(F("SIM card ok"));
9797
_nb.setTimeout(NB_TIMEOUT);
9898
return NetworkConnectionState::CONNECTING;
9999
}
100100
else
101101
{
102-
Debug.print(DBG_ERROR, F("SIM not present or wrong PIN"));
102+
DEBUG_ERROR(F("SIM not present or wrong PIN"));
103103
return NetworkConnectionState::ERROR;
104104
}
105105
}
106106

107107
NetworkConnectionState NBConnectionHandler::update_handleConnecting()
108108
{
109109
NB_NetworkStatus_t const network_status = _nb_gprs.attachGPRS(true);
110-
Debug.print(DBG_DEBUG, F("GPRS.attachGPRS(): %d"), network_status);
110+
DEBUG_DEBUG(F("GPRS.attachGPRS(): %d"), network_status);
111111
if (network_status == NB_NetworkStatus_t::NB_ERROR)
112112
{
113-
Debug.print(DBG_ERROR, F("GPRS.attachGPRS() failed"));
113+
DEBUG_ERROR(F("GPRS.attachGPRS() failed"));
114114
return NetworkConnectionState::ERROR;
115115
}
116116
else
117117
{
118-
Debug.print(DBG_INFO, F("Connected to GPRS Network"));
118+
DEBUG_INFO(F("Connected to GPRS Network"));
119119
return NetworkConnectionState::CONNECTED;
120120
}
121121
}
122122

123123
NetworkConnectionState NBConnectionHandler::update_handleConnected()
124124
{
125125
int const nb_is_access_alive = _nb.isAccessAlive();
126-
Debug.print(DBG_VERBOSE, F("GPRS.isAccessAlive(): %d"), nb_is_access_alive);
126+
DEBUG_VERBOSE(F("GPRS.isAccessAlive(): %d"), nb_is_access_alive);
127127
if (nb_is_access_alive != 1)
128128
{
129-
Debug.print(DBG_INFO, F("Disconnected from cellular network"));
129+
DEBUG_INFO(F("Disconnected from cellular network"));
130130
return NetworkConnectionState::DISCONNECTED;
131131
}
132132
else
133133
{
134-
Debug.print(DBG_VERBOSE, F("Connected to Cellular Network"));
134+
DEBUG_VERBOSE(F("Connected to Cellular Network"));
135135
return NetworkConnectionState::CONNECTED;
136136
}
137137
}
138138

139139
NetworkConnectionState NBConnectionHandler::update_handleDisconnecting()
140140
{
141-
Debug.print(DBG_VERBOSE, F("Disconnecting from Cellular Network"));
141+
DEBUG_VERBOSE(F("Disconnecting from Cellular Network"));
142142
_nb.shutdown();
143143
return NetworkConnectionState::DISCONNECTED;
144144
}

0 commit comments

Comments
 (0)