diff --git a/examples/AssistNow/AssistNow_Online/Example2_AssistNowOnline_TimeDelay/Example2_AssistNowOnline_TimeDelay.ino b/examples/AssistNow/AssistNow_Online/Example2_AssistNowOnline_TimeDelay/Example2_AssistNowOnline_TimeDelay.ino new file mode 100644 index 0000000..1b8f3fb --- /dev/null +++ b/examples/AssistNow/AssistNow_Online/Example2_AssistNowOnline_TimeDelay/Example2_AssistNowOnline_TimeDelay.ino @@ -0,0 +1,252 @@ +/* + Use ESP32 WiFi to get AssistNow Online data from u-blox Thingstream + By: SparkFun Electronics / Paul Clark + Date: November 24th, 2021 + License: MIT. See license file for more information but you can + basically do whatever you want with this code. + + This example shows how to obtain AssistNow Online data from u-blox Thingstream over WiFi + and push it over I2C to a u-blox module. + + The AssistNow Online data is valid for 2-4 hours, so it can be re-used. + BUT you need to provide the time assistance separately. + This example shows how to do that. + The ESP32's RTC is set from network time. + The RTC time is pushed to the module using setUTCTimeAssistance, + followed by the AssistNow data (without time). + + You will need to have a token to be able to access Thingstream. See the AssistNow README for more details. + + Update secrets.h with your: + - WiFi credentials + - AssistNow token string + + Feel like supporting open source hardware? + Buy a board from SparkFun! + SparkFun Thing Plus - ESP32 WROOM: https://www.sparkfun.com/products/15663 + ZED-F9P RTK2: https://www.sparkfun.com/products/16481 + SparkFun GPS Breakout - ZOE-M8Q (Qwiic): https://www.sparkfun.com/products/15193 + + Hardware Connections: + Plug a Qwiic cable into the GNSS and a ESP32 Thing Plus + If you don't have a platform with a Qwiic connection use the SparkFun Qwiic Breadboard Jumper (https://www.sparkfun.com/products/14425) + Open the serial monitor at 115200 baud to see the output +*/ + +#include +#include +#include "secrets.h" + +const char assistNowServer[] = "https://online-live1.services.u-blox.com"; +//const char assistNowServer[] = "https://online-live2.services.u-blox.com"; // Alternate server + +const char getQuery[] = "GetOnlineData.ashx?"; +const char tokenPrefix[] = "token="; +const char tokenSuffix[] = ";"; +const char getGNSS[] = "gnss=gps,glo;"; // GNSS can be: gps,qzss,glo,bds,gal +const char getDataType[] = "datatype=eph,alm,aux;"; // Data type can be: eph,alm,aux,pos + +//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + +#include //http://librarymanager/All#SparkFun_u-blox_GNSS +SFE_UBLOX_GNSS myGNSS; + +//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + +#include "time.h" + +const char* ntpServer = "pool.ntp.org"; // The Network Time Protocol Server + +//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + +void setup() +{ + delay(1000); + + Serial.begin(115200); + Serial.println(F("AssistNow Example")); + + while (Serial.available()) Serial.read(); // Empty the serial buffer + Serial.println(F("Press any key to begin...")); + while (!Serial.available()); // Wait for a keypress + + //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + // Start I2C. Connect to the GNSS. + + Wire.begin(); //Start I2C + + if (myGNSS.begin() == false) //Connect to the Ublox module using Wire port + { + Serial.println(F("u-blox GPS not detected at default I2C address. Please check wiring. Freezing.")); + while (1); + } + Serial.println(F("u-blox module connected")); + + myGNSS.setI2COutput(COM_TYPE_UBX); //Turn off NMEA noise + + //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + // Connect to WiFi. + + Serial.print(F("Connecting to local WiFi")); + + WiFi.begin(ssid, password); + while (WiFi.status() != WL_CONNECTED) + { + delay(500); + Serial.print(F(".")); + } + Serial.println(); + + Serial.println(F("WiFi connected!")); + + //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + // Set the RTC using network time. (Code taken from the SimpleTime example.) + + // Request the time from the NTP server and use it to set the ESP32's RTC. + configTime(0, 0, ntpServer); // Set the GMT and daylight offsets to zero. We need UTC, not local time. + + struct tm timeinfo; + if(!getLocalTime(&timeinfo)) + { + Serial.println("Failed to obtain time"); + return; + } + Serial.println(&timeinfo, "Time is: %A, %B %d %Y %H:%M:%S"); + + //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + // Use HTTP GET to receive the AssistNow_Online data + + const int URL_BUFFER_SIZE = 256; + char theURL[URL_BUFFER_SIZE]; // This will contain the HTTP URL + int payloadSize = 0; // This will be updated with the length of the data we get from the server + String payload; // This will store the data we get from the server + + // Assemble the URL + // Note the slash after the first %s (assistNowServer) + snprintf(theURL, URL_BUFFER_SIZE, "%s/%s%s%s%s%s%s", + assistNowServer, + getQuery, + tokenPrefix, + myAssistNowToken, + tokenSuffix, + getGNSS, + getDataType); + + Serial.print(F("HTTP URL is: ")); + Serial.println(theURL); + + HTTPClient http; + + http.begin(theURL); + + int httpCode = http.GET(); // HTTP GET + + // httpCode will be negative on error + if(httpCode > 0) + { + // HTTP header has been sent and Server response header has been handled + Serial.printf("[HTTP] GET... code: %d\r\n", httpCode); + + // If the GET was successful, read the data + if(httpCode == HTTP_CODE_OK) // Check for code 200 + { + payloadSize = http.getSize(); + Serial.printf("Server returned %d bytes\r\n", payloadSize); + + payload = http.getString(); // Get the payload + + // Pretty-print the payload as HEX + /* + int i; + for(i = 0; i < payloadSize; i++) + { + if (payload[i] < 0x10) // Print leading zero + Serial.print("0"); + Serial.print(payload[i], HEX); + Serial.print(" "); + if ((i % 16) == 15) + Serial.println(); + } + if ((i % 16) != 15) + Serial.println(); + */ + } + } + else + { + Serial.printf("[HTTP] GET... failed, error: %s\r\n", http.errorToString(httpCode).c_str()); + } + + http.end(); + + //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + // Push the RTC time to the module + + // Uncomment the next line to enable the 'major' debug messages on Serial so you can see what AssistNow data is being sent + //myGNSS.enableDebugging(Serial, true); + + if(getLocalTime(&timeinfo)) + { + // setUTCTimeAssistance uses a default time accuracy of 2 seconds which should be OK here. + // Have a look at the library source code for more details. + myGNSS.setUTCTimeAssistance(timeinfo.tm_year + 1900, timeinfo.tm_mon + 1, timeinfo.tm_mday, + timeinfo.tm_hour, timeinfo.tm_min, timeinfo.tm_sec); + } + else + { + Serial.println("Failed to obtain time. This will not work well. The GNSS needs accurate time to start up quickly."); + } + + //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + // Push the AssistNow data to the module - WITHOUT THE TIME + + if (payloadSize > 0) + { + // Push the AssistNow data. Don't use UBX_MGA_ACK_DATA0's. Use the default delay of 7ms between messages. + // The 'true' parameter tells pushAssistNowData not to push any time data from the payload. + myGNSS.pushAssistNowData(true, payload, (size_t)payloadSize); + } + + //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + // Disconnect the WiFi as it's no longer needed + + WiFi.disconnect(true); + WiFi.mode(WIFI_OFF); + Serial.println(F("WiFi disconnected")); +} + +//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= + +void loop() +{ + // Print the UBX-NAV-PVT data so we can see how quickly the fixType goes to 3D + + long latitude = myGNSS.getLatitude(); + Serial.print(F("Lat: ")); + Serial.print(latitude); + + long longitude = myGNSS.getLongitude(); + Serial.print(F(" Long: ")); + Serial.print(longitude); + Serial.print(F(" (degrees * 10^-7)")); + + long altitude = myGNSS.getAltitude(); + Serial.print(F(" Alt: ")); + Serial.print(altitude); + Serial.print(F(" (mm)")); + + byte SIV = myGNSS.getSIV(); + Serial.print(F(" SIV: ")); + Serial.print(SIV); + + byte fixType = myGNSS.getFixType(); + Serial.print(F(" Fix: ")); + if(fixType == 0) Serial.print(F("No fix")); + else if(fixType == 1) Serial.print(F("Dead reckoning")); + else if(fixType == 2) Serial.print(F("2D")); + else if(fixType == 3) Serial.print(F("3D")); + else if(fixType == 4) Serial.print(F("GNSS + Dead reckoning")); + else if(fixType == 5) Serial.print(F("Time only")); + + Serial.println(); +} diff --git a/examples/AssistNow/AssistNow_Online/Example2_AssistNowOnline_TimeDelay/secrets.h b/examples/AssistNow/AssistNow_Online/Example2_AssistNowOnline_TimeDelay/secrets.h new file mode 100644 index 0000000..4eb7a9c --- /dev/null +++ b/examples/AssistNow/AssistNow_Online/Example2_AssistNowOnline_TimeDelay/secrets.h @@ -0,0 +1,6 @@ +//Your WiFi credentials +const char ssid[] = "TRex"; +const char password[] = "hasBigTeeth"; + +//Your AssistNow token +const char myAssistNowToken[] = "58XXXXXXXXXXXXXXXXXXYQ"; diff --git a/src/SparkFun_u-blox_GNSS_Arduino_Library.cpp b/src/SparkFun_u-blox_GNSS_Arduino_Library.cpp index 0c3ffe6..3b422b1 100644 --- a/src/SparkFun_u-blox_GNSS_Arduino_Library.cpp +++ b/src/SparkFun_u-blox_GNSS_Arduino_Library.cpp @@ -4245,7 +4245,7 @@ bool SFE_UBLOX_GNSS::setUTCTimeAssistance(uint16_t year, uint8_t month, uint8_t } // Return true if the one packet was pushed successfully - return (pushAssistNowDataInternal(true, iniTimeUTC, 32, mgaAck, maxWait) == 1); + return (pushAssistNowDataInternal(false, iniTimeUTC, 32, mgaAck, maxWait) == 1); } // Support for data logging