From 40812e195b6ab70822ac586f2b823df1506bc477 Mon Sep 17 00:00:00 2001 From: Juha Ylinen Date: Wed, 24 Sep 2025 15:33:26 +0300 Subject: [PATCH] app: Rename AT#XGPS to AT#XGNSS Rename AT commands and update documentation. Add entry to the migration guide. Jira: SLM-127 Signed-off-by: Juha Ylinen --- app/src/gnss/sm_at_gnss.c | 32 ++++++------ doc/app/GNSS_AT_commands.rst | 88 ++++++++++++++++----------------- doc/app/Generic_AT_commands.rst | 2 +- doc/app/sm_migration.rst | 6 +-- 4 files changed, 64 insertions(+), 64 deletions(-) diff --git a/app/src/gnss/sm_at_gnss.c b/app/src/gnss/sm_at_gnss.c index 2fca42c2..480fceda 100644 --- a/app/src/gnss/sm_at_gnss.c +++ b/app/src/gnss/sm_at_gnss.c @@ -58,10 +58,10 @@ static struct modem_pipe *gnss_pipe; /* UTC/GPS time offset as of 1st of January 2017. */ #define GPS_TO_UTC_LEAP_SECONDS (18UL) -/** #XGPS operations. */ +/** #XGNSS operations. */ enum sm_gnss_operation { - GPS_STOP, - GPS_START, + GNSS_STOP, + GNSS_START, }; #if defined(CONFIG_SM_NRF_CLOUD) @@ -134,7 +134,7 @@ static void gnss_status_notifier(struct k_work *) { while (!k_fifo_is_empty(&gnss_status_fifo)) { gnss_status = (enum gnss_status)k_fifo_get(&gnss_status_fifo, K_NO_WAIT); - rsp_send("\r\n#XGPS: 1,%d\r\n", gnss_status); + rsp_send("\r\n#XGNSS: 1,%d\r\n", gnss_status); } } @@ -569,7 +569,7 @@ static void gnss_fix_sender(struct k_work *) } /* GIS accuracy: http://wiki.gis.com/wiki/index.php/Decimal_degrees, use default .6lf */ - rsp_send("\r\n#XGPS: %lf,%lf,%f,%f,%f,%f,\"%04u-%02u-%02u %02u:%02u:%02u\"\r\n", + rsp_send("\r\n#XGNSS: %lf,%lf,%f,%f,%f,%f,\"%04u-%02u-%02u %02u:%02u:%02u\"\r\n", pvt.latitude, pvt.longitude, (double)pvt.altitude, (double)pvt.accuracy, (double)pvt.speed, (double)pvt.heading, pvt.datetime.year, pvt.datetime.month, pvt.datetime.day, @@ -686,8 +686,8 @@ static void gnss_event_handler(int event) } } -SM_AT_CMD_CUSTOM(xgps, "AT#XGPS", handle_at_gps); -static int handle_at_gps(enum at_parser_cmd_type cmd_type, struct at_parser *parser, +SM_AT_CMD_CUSTOM(xgnss, "AT#XGNSS", handle_at_gnss); +static int handle_at_gnss(enum at_parser_cmd_type cmd_type, struct at_parser *parser, uint32_t param_count) { int err = 0; @@ -708,7 +708,7 @@ static int handle_at_gps(enum at_parser_cmd_type cmd_type, struct at_parser *par if (err) { return err; } - if (op == GPS_START) { + if (op == GNSS_START) { if (gnss_running) { LOG_ERR("GNSS is already running. Stop it first."); return -EBUSY; @@ -777,7 +777,7 @@ static int handle_at_gps(enum at_parser_cmd_type cmd_type, struct at_parser *par } /* Make sure to configure the timeout unconditionally in single-fix * and periodic navigation modes. - * An old value might otherwise remain from a previous GPS run. + * An old value might otherwise remain from a previous GNSS run. */ err = nrf_modem_gnss_fix_retry_set(timeout); if (err) { @@ -787,7 +787,7 @@ static int handle_at_gps(enum at_parser_cmd_type cmd_type, struct at_parser *par } err = gnss_startup(); - } else if (op == GPS_STOP && param_count == 2) { + } else if (op == GNSS_STOP && param_count == 2) { if (gnss_running) { err = gnss_shutdown(); } else { @@ -799,12 +799,12 @@ static int handle_at_gps(enum at_parser_cmd_type cmd_type, struct at_parser *par break; case AT_PARSER_CMD_TYPE_READ: - rsp_send("\r\n#XGPS: %d,%d\r\n", (int)is_gnss_activated(), gnss_status); + rsp_send("\r\n#XGNSS: %d,%d\r\n", (int)is_gnss_activated(), gnss_status); break; case AT_PARSER_CMD_TYPE_TEST: - rsp_send("\r\n#XGPS: (%d,%d),(0,1),,\r\n", - GPS_STOP, GPS_START); + rsp_send("\r\n#XGNSS: (%d,%d),(0,1),,\r\n", + GNSS_STOP, GNSS_START); break; default: @@ -815,8 +815,8 @@ static int handle_at_gps(enum at_parser_cmd_type cmd_type, struct at_parser *par return err; } -SM_AT_CMD_CUSTOM(xgpsdel, "AT#XGPSDEL", handle_at_gps_delete); -static int handle_at_gps_delete(enum at_parser_cmd_type cmd_type, struct at_parser *parser, +SM_AT_CMD_CUSTOM(xgnssdel, "AT#XGNSSDEL", handle_at_gnss_delete); +static int handle_at_gnss_delete(enum at_parser_cmd_type cmd_type, struct at_parser *parser, uint32_t) { int err = -EINVAL; @@ -832,7 +832,7 @@ static int handle_at_gps_delete(enum at_parser_cmd_type cmd_type, struct at_pars break; case AT_PARSER_CMD_TYPE_TEST: - rsp_send("\r\n#XGPSDEL: \r\n"); + rsp_send("\r\n#XGNSSDEL: \r\n"); err = 0; break; diff --git a/doc/app/GNSS_AT_commands.rst b/doc/app/GNSS_AT_commands.rst index 3f357978..03d4b96e 100644 --- a/doc/app/GNSS_AT_commands.rst +++ b/doc/app/GNSS_AT_commands.rst @@ -12,7 +12,7 @@ This page describes GNSS-related AT commands. Control GNSS ============ -The ``#XGPS`` command controls the GNSS. +The ``#XGNSS`` command controls the GNSS. Set command ----------- @@ -35,7 +35,7 @@ Syntax :: - #XGPS=,,[,] + #XGNSS=,,[,] The ```` parameter can have the following integer values: @@ -104,7 +104,7 @@ Unsolicited notification .. code-block:: - #XGPS: ,,,,,, + #XGNSS: ,,,,,, * The ```` value represents the latitude in degrees. * The ```` value represents the longitude in degrees. @@ -118,7 +118,7 @@ Unsolicited notification .. code-block:: - #XGPS: , + #XGNSS: , * The ```` parameter is an integer. When it has the value ``1``, it means that GNSS is supported in ``%XSYSTEMMODE`` and activated in ``+CFUN``. @@ -145,15 +145,15 @@ Example AT+CFUN=31 OK - AT#XGPS=1,0,0,0 + AT#XGNSS=1,0,0,0 - #XGPS: 1,1 + #XGNSS: 1,1 OK - #XGPS: 1,4 + #XGNSS: 1,4 - #XGPS: 35.457576,139.625090,121.473785,22.199919,0.442868,0.000000,"2021-06-02 06:25:48" + #XGNSS: 35.457576,139.625090,121.473785,22.199919,0.442868,0.000000,"2021-06-02 06:25:48" :: @@ -176,22 +176,22 @@ Example OK #XNRFCLOUD: 1,0 - AT#XGPS=1,1,0,1 + AT#XGNSS=1,1,0,1 - #XGPS: 1,1 + #XGNSS: 1,1 OK - #XGPS: 35.457417,139.625211,162.850952,15.621976,1.418092,0.000000,"2021-06-02 05:21:31" + #XGNSS: 35.457417,139.625211,162.850952,15.621976,1.418092,0.000000,"2021-06-02 05:21:31" - #XGPS: 35.457435,139.625348,176.104797,14.245458,1.598184,69.148659,"2021-06-02 05:21:32" + #XGNSS: 35.457435,139.625348,176.104797,14.245458,1.598184,69.148659,"2021-06-02 05:21:32" - #XGPS: 35.457417,139.625415,179.132980,13.318132,1.235241,69.148659,"2021-06-02 05:21:33" + #XGNSS: 35.457417,139.625415,179.132980,13.318132,1.235241,69.148659,"2021-06-02 05:21:33" - #XGPS: 35.457410,139.625469,181.223541,12.667312,0.803951,69.148659,"2021-06-02 05:21:34" - AT#XGPS=0 + #XGNSS: 35.457410,139.625469,181.223541,12.667312,0.803951,69.148659,"2021-06-02 05:21:34" + AT#XGNSS=0 - #XGPS: 1,0 + #XGNSS: 1,0 OK @@ -213,38 +213,38 @@ Example OK #XNRFCLOUD: 1,0 - AT#XGPS=1,0,1,30 + AT#XGNSS=1,0,1,30 - #XGPS: 1,1 + #XGNSS: 1,1 OK - #XGPS: 1,2 + #XGNSS: 1,2 - #XGPS: 1,4 + #XGNSS: 1,4 - #XGPS: 35.457243,139.625435,149.005020,28.184258,10.431827,281.446014,"2021-06-24 04:35:52" + #XGNSS: 35.457243,139.625435,149.005020,28.184258,10.431827,281.446014,"2021-06-24 04:35:52" - #XGPS: 1,2 + #XGNSS: 1,2 - #XGPS: 1,4 + #XGNSS: 1,4 - #XGPS: 35.457189,139.625602,176.811203,43.015198,0.601837,281.446014,"2021-06-24 04:36:32" + #XGNSS: 35.457189,139.625602,176.811203,43.015198,0.601837,281.446014,"2021-06-24 04:36:32" - #XGPS: 1,2 + #XGNSS: 1,2 - #XGPS: 1,4 + #XGNSS: 1,4 - #XGPS: 35.457498,139.625422,168.243591,31.753956,0.191195,281.446014,"2021-06-24 04:37:12" + #XGNSS: 35.457498,139.625422,168.243591,31.753956,0.191195,281.446014,"2021-06-24 04:37:12" - #XGPS: 1,2 + #XGNSS: 1,2 - #XGPS: 1,4 + #XGNSS: 1,4 - #XGPS: 35.457524,139.624667,100.745979,25.324850,6.347160,94.699837,"2021-06-24 04:37:52" - AT#XGPS=0 + #XGNSS: 35.457524,139.624667,100.745979,25.324850,6.347160,94.699837,"2021-06-24 04:37:52" + AT#XGNSS=0 - #XGPS: 1,0 + #XGNSS: 1,0 OK @@ -258,7 +258,7 @@ Syntax :: - #XGPS? + #XGNSS? Response syntax ~~~~~~~~~~~~~~~ @@ -272,9 +272,9 @@ Example :: - AT#XGPS? + AT#XGNSS? - #XGPS: 1,1 + #XGNSS: 1,1 OK @@ -288,23 +288,23 @@ Syntax :: - #XGPS=? + #XGNSS=? Example ~~~~~~~ :: - AT#XGPS=? + AT#XGNSS=? - #XGPS: (0,1),(0,1),, + #XGNSS: (0,1),(0,1),, OK Delete GNSS data ================ -The ``#XGPSDEL`` command deletes GNSS data from non-volatile memory. +The ``#XGNSSDEL`` command deletes GNSS data from non-volatile memory. This command should be issued when GNSS is activated but not started yet. .. note:: @@ -322,7 +322,7 @@ Syntax :: - #XGPSDEL= + #XGNSSDEL= The ```` parameter accepts an integer that is the ``OR`` value of the following bitmasks : @@ -345,7 +345,7 @@ Example OK AT+CFUN=31 OK - AT#XGPSDEL=511 + AT#XGNSSDEL=511 OK AT+CFUN=0 OK @@ -365,15 +365,15 @@ Syntax :: - #XGPSDEL=? + #XGNSSDEL=? Example ~~~~~~~ :: - AT#XGPSDEL=? + AT#XGNSSDEL=? - #XGPSDEL: + #XGNSSDEL: OK diff --git a/doc/app/Generic_AT_commands.rst b/doc/app/Generic_AT_commands.rst index 85c71eae..0c45487d 100644 --- a/doc/app/Generic_AT_commands.rst +++ b/doc/app/Generic_AT_commands.rst @@ -109,7 +109,7 @@ Example AT#XSENDTO AT#XRECVFROM AT#XPING - AT#XGPS + AT#XGNSS OK Read command diff --git a/doc/app/sm_migration.rst b/doc/app/sm_migration.rst index 36baaaf1..ef70660e 100644 --- a/doc/app/sm_migration.rst +++ b/doc/app/sm_migration.rst @@ -42,10 +42,10 @@ General renaming * Renamed `slm_*` to `sm_*` * Renamed `modem_slm_*` to `sm_host_*` -`AT#SOMEOLD` renamed to `AT#SOMENEW` +`AT#XGPS` renamed to `AT#XGNSS` ************************************ .. toggle:: - * `AT#SOMEOLD` command has been renamed to `AT#SOMENEW` - * `AT#SOMENEW` command output has changed to include Serial Modem version + * `AT#XGPS` command has been renamed to `AT#XGNSS` + * `AT#XGPSDEL` command has been renamed to `AT#XGNSSDEL`