Merge pull request arduino#394 from pennam/gettime-fix

WiFiS3: add WiFi.getTime()

Author: pennam

libraries/WiFiS3/examples/WiFiTime/WiFiTime.ino

@@ -0,0 +1,117 @@
+/*
+  Get the time in seconds since January 1st, 1970.
+
+  The time is retrieved with the WiFi module by fetching the NTP time from an NTP server.
+
+  It requires at least version 0.5.0 of USB Wifi bridge firmware and WiFiS3 library.
+
+  This example is written for a network using WPA encryption. For
+  WEP or WPA, change the WiFi.begin() call accordingly.
+
+  created 21 february 2024
+
+*/
+
+#include "WiFiS3.h"
+#include "arduino_secrets.h"
+#include "RTC.h"
+
+///////please enter your sensitive data in the Secret tab/arduino_secrets.h
+char ssid[] = SECRET_SSID;    // your network SSID (name)
+char pass[] = SECRET_PASS;    // your network password (use for WPA, or use as key for WEP)
+int keyIndex = 0;             // your network key index number (needed only for WEP)
+
+/// set offsets to GMT from local
+#define GMTOffset_hour  1     // # hours difference to GMT
+#define DayLightSaving  0     // 1 = daylight saving is active
+
+int status = WL_IDLE_STATUS;
+
+/* -------------------------------------------------------------------------- */
+void setup() {
+/* -------------------------------------------------------------------------- */
+
+  //Initialize serial and wait for port to open:
+  Serial.begin(115200);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for native USB port only
+  }
+
+  RTC.begin();
+
+   // check for the WiFi module:
+  if (WiFi.status() == WL_NO_MODULE) {
+    Serial.println("Communication with WiFi module failed.");
+    // don't continue
+    while (true);
+  }
+
+  // attempt to connect to WiFi network:
+  while (status != WL_CONNECTED) {
+    Serial.print("Attempting to connect to SSID: ");
+    Serial.println(ssid);
+    // Connect to WPA/WPA2 network. Change this line if using open or WEP network:
+    status = WiFi.begin(ssid, pass);
+
+    // wait 10 seconds for connection:
+    delay(10000);
+  }
+
+  printWifiStatus();
+}
+
+/* -------------------------------------------------------------------------- */
+void loop() {
+/* -------------------------------------------------------------------------- */
+
+  unsigned long EpochTime;
+
+  EpochTime = WiFi.getTime();
+
+  if (EpochTime > 0) {
+    UpdateRTC(EpochTime);
+  }
+  else {
+    Serial.println("Error during reading epoch time.");
+    Serial.println("Make sure your WiFi firmware version is greater than 0.5.0");
+  }
+
+  Serial.println();
+  delay(10000);
+}
+
+/* -------------------------------------------------------------------------- */
+void UpdateRTC(time_t EpochTime) {
+/* -------------------------------------------------------------------------- */
+
+  auto timeZoneOffsetHours = GMTOffset_hour + DayLightSaving;
+  auto unixTime = EpochTime + (timeZoneOffsetHours * 3600);
+  Serial.print("Unix time = ");
+  Serial.println(unixTime);
+  RTCTime timeToSet = RTCTime(unixTime);
+  RTC.setTime(timeToSet);
+
+  // Retrieve the date and time from the RTC and print them
+  RTCTime currentTime;
+  RTC.getTime(currentTime);
+  Serial.println("The RTC was just set to: " + String(currentTime));
+}
+
+/* -------------------------------------------------------------------------- */
+void printWifiStatus() {
+/* -------------------------------------------------------------------------- */
+  // print the SSID of the network you're attached to:
+  Serial.print("SSID: ");
+  Serial.println(WiFi.SSID());
+
+  // print your board's IP address:
+  IPAddress ip = WiFi.localIP();
+  Serial.print("IP Address: ");
+  Serial.println(ip);
+
+  // print the received signal strength:
+  long rssi = WiFi.RSSI();
+  Serial.print("signal strength (RSSI):");
+  Serial.print(rssi);
+  Serial.println(" dBm");
+}

libraries/WiFiS3/examples/WiFiTime/arduino_secrets.h

@@ -0,0 +1,2 @@
+#define SECRET_SSID ""
+#define SECRET_PASS ""

libraries/WiFiS3/src/WiFi.cpp

@@ -542,18 +542,21 @@ int CWifi::hostByName(const char* aHostname, IPAddress& aResult) {
    return 0;
 }
 
-
-
 uint8_t CWifi::reasonCode() {
   return 0;
 }
 
+/* ----------------------------------------------*/
 unsigned long CWifi::getTime() {
-  return 0;
+/* ----------------------------------------------*/
+   modem.begin();
+   string res = "";
+   if(modem.write(string(PROMPT(_GETTIME)),res,"%s\r\n", CMD_WRITE(_GETTIME))) {
+      return strtol(res.c_str(), NULL, 10);
+   }
+   return 0;
 }
 
-
-
 void CWifi::setTimeout(unsigned long timeout) {
    _timeout = timeout;
 }