LILYGO T-SIM7000G ESP32: Get GPS Data (Latitude, Longitude, Altitude, and more)

16 thoughts on “LILYGO T-SIM7000G ESP32: Get GPS Data (Latitude, Longitude, Altitude, and more)”

1. Very timely. I had just been looking at this Lilygo board because of the LTE feature. I’ll order one now.

   Reply

2. Cool one!
   I am enjoying all tutorial on this board.
   I think what remains now is the use of the on-board SD-card and then to wrap things up by making a BME weather station with capability to locally datalog as well as send the data to cloud.
   Great job

   Reply

3. Hello.
   Great work. Can you make a tutorial for how to send the data collected using the SIM7000G LTE modem to a webserver using REST method (GET or POST)?. For example, a webserver who has a php file as a receiver. Greetings.

   Reply

4. Olá Sara !
   Espero que tudo esteja bem aí com vcs!!
   Por favor, se eu quisesse fazer um logger GPS ou quisesse transmitir em tempo real, qual seria o intervalo mínimo entre amostragens? Obrigado!!!

   Reply

5. Thanks,Great tutorial. Is GPS antenna mandatory? Part number or make advisor link for it?

   Reply

   • Hi.
     The GPS antenna comes with the package when you buy the board.
     Regards,
     Sara

     Reply

6. Is it possible to send sms (text) to the Lilygo, to trigger a response?
   can Lilygo attach a file to a text (data from SD
   card)?

   Reply

7. Very nice tutorial !

   For my part i’ve an issue, every time i used

   modem.sendAT(“+SGPIO=0,4,1,1″);
   if (modem.waitResponse(10000L) != 1) {
   SerialMon.println(” SGPIO=0,4,1,1 false “);
   }

   It’s fall in the println :/

   You have an idea why ?

   Kr,

   Reply

8. Awesome Project! I just picked up a board and am wondering if anyone has an App or an interface where I can see my GPS from a web server?

   Reply

   • Hi.
     We have many web server examples that you can modify to display GPS data.
     For example: https://randomnerdtutorials.com/esp32-dht11-dht22-temperature-humidity-web-server-arduino-ide/
     Regards,
     Sara

     Reply

9. Achei o exemplo excelente!!! me ajudou muito… porém, gostaria de saber como fazer com a biblioteca TinyGPS++ dividindo em OS_GPS.cpp , Ops.h e MeuTesteGps.ino?
   isso é tudo que sei Digamos que você tenha um Arduino conectado a um dispositivo GPS comum e queira exibir sua altitude. Você simplesmente criaria uma instância do TinyGPS++ assim:
   #include “TinyGPS++.h”
   TinyGPSPlus gps;
   Alimente repetidamente os caracteres do seu dispositivo GPS:

   while (ss.available() > 0)
   gps.encode(ss.read());
   Em seguida, consulte-o para obter as informações desejadas:

   if (gps.altitude.isUpdated())
   Serial.println(gps.altitude.meters());
   referência: http://arduiniana.org/libraries/tinygpsplus/
   Se alguém puder me ajudar eu agradeço…

   Reply

10. Hello Sarah, this is a great tutorial. However, I am having a little problem with your example code, my longitude results are preceded by a “-” which is different from my actual position. I’m curious how I should get rid of this “-“

    Reply

11. This is great tutorial but I am having a serious problem using it. I have a “-” in front of my latitude, which puts me badly out of position. How do I fix this please?

    Sincerely
    Chen

    Reply

12. Thank you very much for the great tutorial that worked perfectly for me!
    In the output of AT+CGNSINF, fractional seconds are always “000” I guess there is no way to request sub-second time precision from this board? Is there another board that you can recommend that has that?

    Reply

13. This program publishes CAT-M or NB-IoT RSSI values with the GNSS location at which they were measured to the Adafruit IO MQTT broker. You can set up a free Adafruit IO account, and set up a feed and a dashboard to test it out.

    
/*
This is a program to demonstrate the use of SIM7000 MQTT commands to send
data to Adafruit IO. You can set up a free Adafruit IO account to test it.

    The SIM7000 MQTT commands are documented in the following SIMCom application note:
    https://simcom.ee/documents/SIM7000x/SIM7000%20Series_MQTT_Application%20Note_V1.00.pdf

    They are not documented in the SIM7000 AT command manual at:
    https://simcom.ee/documents/SIM7000x/SIM7000%20Series_AT%20Command%20Manual_V1.04.pdf

    I strongly recommend you have a copy of the above two documents close at hand when
    reading this program.

    For the full set of SIM7000 documentation see:
    https://simcom.ee/documents/?dir=SIM7000x

    I used the TinyGSM library code as a starting point for this program. But the only functions
    from that library that this program uses are the GPS-related functions. I used a
    trial-and-error process to figure out what AT commands are necessary to bring the SIM7000
    online on an LTE CAT-M or NB-IoT network. I then referred to the SIMCom SIM7000 MQTT
    application note to figure out how to connect the SIM7000 to the Adafruit IO MQTT broker
    and publish data to the broker.

    This program is currently set up to work with a Hologram SIM. It seems to work on the
    T-Mobile and AT&T networks in the USA, or at least in Prescott and Sedona, Arizona.

    This version of the program is set up to report the cellular network received signal strength
    indicator (RSSI) on the Adafruit IO feed.

    Copyright 2024 Robert F. Fleming, III

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software
    and associated documentation files (the “Software”), to deal in the Software without restriction,
    including without limitation the rights to use, copy, modify, merge, publish, distribute,
    sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
    is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice must be included in all copies
    or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
    INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
    PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    */

    #include <ArduinoTrace.h>

    // Defined the ESP32 pins that are connected to the SIM7000
    #define PWR_PIN 4
    #define PIN_RX 26
    #define PIN_TX 27

    #define TINY_GSM_MODEM_SIM7000

    // Define some C string buffer sizes
    #define BUFSIZE1 65
    #define BUFSIZE2 35
    #define BUFSIZE3 121

    // MQTT details
    // Sign up for a free Adafruit IO account.
    // While signed into your account, you can click on the gold circle with the
    // black key in the upper right corner of the Adafruit IO web page to get your
    // IO_USERNAME (mqttUser[]) and IO_KEY (mqtt_Pass) and fill them in below.
    const char* broker = "io.adafruit.com";
    const uint16_t port = 1883;
    const char mqttUser[] = "";
    const char mqttPass[] = "your IO_KEY";

    // The TinyGSM library is only used for the GPS functions, which I'm too
    // lazy to try to reinvent right now.
    #include <TinyGsmClient.h>
    TinyGsm modem(Serial1);
    TinyGsmClient client(modem);

    unsigned long t_zero, t_one;

    // Read and parse the response from the SIM7000. If E1 command echo is turned on,
    // the first token returned by strtok()is the command just sent.
    // In that case, we want to skip everything up to the first newline
    // and then start processing.
    char * checkResponse(uint8_t tokenNr, char * delimiters, bool skipCmd) {

    while (Serial1.available() == 0) {} //wait for data available
    String response = Serial1.readString();

    // Serial.print("Response from Serial1 = ");
    // Serial.println(response);
    // Serial.print("Response length = ");
    // Serial.println(response.length());

    char resp[BUFSIZE3] = "";
    response.toCharArray(resp, BUFSIZE3);
    char * p_resp = resp;

    char newLine[2] = "\n";
    char * tok;

    if (skipCmd) {
    tok = strtok_r(p_resp, newLine, &p_resp);
    }
    else {
    tok = strtok_r(p_resp, delimiters, &p_resp);
    tokenNr--;
    }

    while ((tok != NULL) && (tokenNr > 0)) {
    tok = strtok_r(NULL, delimiters, &p_resp); // next please!
    if (tok == NULL) { break; }
    tokenNr--;
    }

    // Serial.print("tok = ");
    // Serial.println(tok);

    static char staticTok[BUFSIZE1] = "";
    if (tok != NULL) { strncpy(staticTok, tok, BUFSIZE1); }
    return staticTok;
    }

    // When the SIM7000 first comes out of reset, it spits out what may
    // be some Chinese characters before it starts responding to AT commands
    // with an "OK" response. This function waits for the "OK".
    boolean areWeAwakeYet() {
    // Send the modem "AT". Read the string from the SIM7000. If it contains "OK",
    // the SIM7000 is awake.
    unsigned long t_0 = millis();

    // Give it a minute to wake up
    while (millis() < t_0 + 60000) {
    Serial1.println("AT");
    while (Serial1.available() == 0) {} //wait for data available
    String response = Serial1.readString();

    // Serial.print("Response from Serial1 = ");
// Serial.println(response);
// Serial.print("Response length = ");
// Serial.println(response.length());

    char resp[BUFSIZE1] = "";
    response.toCharArray(resp, BUFSIZE1);

    if (strstr(resp, "OK") != NULL) {
return true;
}


    }

    return false;
    }

    // This function issues the commands necessary to first connect the SIM7000
    // to an LTE CAT-M or NB-IoT network, then issues the commands necessary
    // to connect the SIM7000 to the Adafuit IO MQTT broker.
    boolean bringMQTTOnline(void) {
    for (int i = 10; i > 0; i--) {
    Serial1.println("AT");
    }
    Serial1.println("ATE1");
    Serial1.readStringUntil('\n');

    // Turn on GPS power
    Serial.println("Enabling GPS power...");

    Serial1.println("AT+SGPIO=0,4,1,1");
    char delimiters[2] = "\n";

    char result[6] = "";
    strcpy(result, checkResponse(1, delimiters, true));
    if (strstr(result, "OK") != NULL) {Serial.println("GPS power supply enabled!"); }

    delay(2000);

    if (!modem.enableGPS()) {
    Serial.println("Failed to enable GPS");
    // Continue anyway, but the results won't be spectacular
    }

    // AT+SAPBR=3,1,"APN","hologram" Use the Hologram SIM for the APN
    Serial1.println("AT+SAPBR=3,1,\"APN\",\"hologram\"");
    printResponse(1000);

    // AT+CNMP=38 set preferred connection type to LTE
    Serial1.println("AT+CNMP=51");
    printResponse(1000);

    // AT+CMNB=3 set preferred connection type to CAT-M and NB-IoT
    Serial1.println("AT+CMNB=3");
    printResponse(2000);

    // AT+CIPMUX=1
    Serial1.println("AT+CIPMUX=0"); // start a single IP connection
    printResponse(1000);

    // AT+CSTT="hologram","",""
    Serial1.println("AT+CSTT=\"hologram\",\"\",\"\"");
    printResponse(1000);

    // AT+CNACT=1,"hologram" Make the network active using the supplied APN (I think)
    Serial1.println("AT+CNACT=1,\"hologram\"");
    printResponse(1000);

    // AT+COPS?" query network information
    // a response like +COPS: 0,0,"AT&T Hologram",7 or +COPS: 0,0,"T-Mobile Hologram",7 seems good
    // the '7' in the response means User-specified LTE M1 A GB access technology
    // a '9' in the response would mean User-specified LTE NB S1 access technology
    Serial1.println("AT+COPS?");
    printResponse(1000);

    // AT+CGNAPN query CAT-M or NB-IOT network after the successful registration of APN
    // Basically, if we get a response like +CGNAPN: 1,"hologram" back, we're connected
    Serial1.println("AT+CGNAPN");
    printResponse(1000);

    // AT+SMCONF="URL","io.adafruit.com"
    Serial1.println("AT+SMCONF=\"URL\",\"io.adafruit.com\"");
    printResponse(1000);

    // AT+SMCONF="USERNAME","cf20855"
    Serial1.println("AT+SMCONF=\"USERNAME\",\"cf20855\"");
    printResponse(1000);

    // AT+SMCONF="PASSWORD","aio_zesx89GzAjUC6AYtbh4Uj4eEBfxW"
    Serial1.println("AT+SMCONF=\"PASSWORD\",\"aio_zesx89GzAjUC6AYtbh4Uj4eEBfxW\"");
    printResponse(1000);

    // AT+SMCONN
    Serial1.println("AT+SMCONN");
    printResponse(10000);

    return true;
    }

    // This function parses the SIM7000 +CPSI response to retrieve the
    // Received Signal Strength Indicator (RSSI) value
    int getRSSI(char * cpsiResp) {
    char respCopy[BUFSIZE3];
    char * p_respCopy = respCopy;
    strcpy(respCopy, cpsiResp);
    //Serial.println(respCopy);

    char* tok = strtok_r(p_respCopy, ",", &p_respCopy);
    for (int i = 0; i < 13; i++) {
    tok = strtok_r(NULL, ",", &p_respCopy);
    }
    return atoi(tok);
    }

    // This function generates and publishes a CSV feed message to Adafruit IO
    // containing a parameter and the location at which the parameter was measured.
    // The Adafruit IO documentation on how to send data with location can be found
    // at https://io.adafruit.com/api/docs/mqtt.html#mqtt-data-format .
    void updateParameter() {
    // Variables to hold GPS data
    float latitude = 0.0;
    float longitude = 0.0;
    float speed = 0.0;
    float altitude = 0.0;

    // Get GPS data
    Serial1.readStringUntil('n');
    Serial.println("Getting GPS data...");
    if (modem.getGPS(&latitude, &longitude, &speed, &altitude)) {
    Serial.println("GPS data acquired");
    } else {
    Serial.println("Failed to get GPS data");
    // You may want to handle this case differently
    }

    // Get RSSI
    Serial1.println("AT+CPSI?");
    char delimiters[2] = ",";

    char result[6] = "";
    strcpy(result, checkResponse(14, delimiters, true));
    int rssi = atoi(result);

    char buf1[BUFSIZE1] = "";
    snprintf(buf1, BUFSIZE1, "RSSI = %d, lat = %2.6f, lon = %3.6f, alt = %4.1f", rssi, latitude, longitude, altitude);
    Serial.println(buf1);

    // Prepare MQTT publish content
    // Refer to the SIMCom SIM7000 MQTT appnote to see how to do this.
    // First you issue the command, then the SIM7000 prompts for the data to publish.
    char buf2[BUFSIZE2] = "";
    int size2 = snprintf(buf2, BUFSIZE2, "%d,%2.6f,%3.6f,%4.1f", rssi, latitude, longitude, altitude);
    strncpy(buf1, "", sizeof(buf1));
    snprintf(buf1, BUFSIZE1, "AT+SMPUB=\"cf20855/feeds/update/csv\",\"%d\",1,1", size2);

    // Send MQTT publish
    Serial1.println(buf1);
    printResponse(1000);
    Serial1.println(buf2);
    printResponse(1000);

    }

    // This function is useful for looking at whatever serial data comes out of the SIM7000.
    void printResponse(int delay) {
    t_zero = millis();
    while (millis() < t_zero + delay) {
    if (Serial1.available()) { // If anything comes in Serial1 (pins 0 & 1)
    Serial.write(Serial1.read()); // read it and send it out Serial (USB)
    }
    }
    }

    void setup() {
    // Power up the SIM7000G
    pinMode(PWR_PIN, OUTPUT);
    digitalWrite(PWR_PIN, HIGH);
    delay(300);
    // digitalWrite(PWR_PIN, LOW);

    Serial.begin(115200);
    Serial1.begin(115200, SERIAL_8N1, PIN_RX, PIN_TX);

    // Wait for the SIM7000 to wake up
    delay(2000);
    if (areWeAwakeYet()) {
    Serial.println("SIM7000 woke up! Yay!");
    }
    else {
    Serial.println("SIM7000 never woke up. Groan.");
    }

    bringMQTTOnline();
    Serial1.println("AT+CPSI?");
    printResponse(2000);

    t_zero = millis();
    t_one = millis();

    }

    void loop() {
    // The following two "if" statements are useful for manual control
    // of the SIM7000.
    // if (Serial.available()) { // If anything comes in Serial (USB),
    // Serial1.write(Serial.read()); // read it and send it out Serial1 (pins 0 & 1)
    // }

    // if (Serial1.available()) { // If anything comes in Serial1 (pins 0 & 1)
    // Serial.write(Serial1.read()); // read it and send it out Serial (USB)
    // }

    // Check the connection status every 13 seconds
    if (millis() > t_zero + 13000) {
    // Check the MQTT connection status
    Serial1.println("AT+SMSTATE?");
    char delimiters[2] = ":";

    char result[6] = "";
strcpy(result, checkResponse(2, delimiters, true));

    // Serial.print("MQTT state response token = ");
    // Serial.println(result);

    if (atoi(result) != 1) {
Serial.println("MQTT connection lost, restarting modem!");
Serial1.println("AT+CFUN=1,1");
while (!areWeAwakeYet()) {};
bringMQTTOnline();
t_zero = millis();
t_one = millis();
}


    }

    // Send a report every 17 seconds (I like prime numbers)
    if (millis() > t_one + 17000) {
    t_one = millis();
    updateParameter();
    }
    }

    Reply

14. If you like the LilyGo TTGO SIM7000x, and you like Arduino IO, you might like
    github.com/CF20852/LilyGo-SIM7000-Adafruit-IO-Client

    Reply