diff --git a/CHANGELOG.md b/CHANGELOG.md index 214ca5c..261ad86 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.3.0] - 2023-06-12 + +### changed + +- [gnss_middleware] Update to V2.1.0, see [Changelog](geolocation_middleware/CHANGELOG.md). +- [lora_basics_modem] Update to V2.1.0, see [Changelog](lora_basics_modem/lora_basics_modem/CHANGELOG.md). +- [geolocation_gnss] Application code update according to geolocation middleware v2.1.0 and LoRa Basics Modem v3.3.0. +- [geolocation_gnss_wifi] Application code update according to geolocation middleware v2.1.0 and LoRa Basics Modem v3.3.0. +- [geolocation_wifi] Application code update according to geolocation middleware v2.1.0 and LoRa Basics Modem v3.3.0. +- [tracker_application] Application code update according to geolocation middleware v2.1.0 and LoRa Basics Modem v3.3.0. see [Changelog](apps/demonstrations/tracker_application/CHANGELOG.md). + ## [1.2.0] - 2023-01-23 ### changed diff --git a/README.md b/README.md index b06057a..7af4942 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ Here is the different components changelogs and current version included in this | Geolocation - Wi-Fi | Perform Wi-Fi scans and send results over LoRaWAN using Wi-Fi middleware | [README](apps/examples/geolocation_wifi/README.md) | | Geolocation - GNSS & Wi-Fi | Perform GNSS and Wi-Fi scans and send results over LoRaWAN using geolocation middlewares | [README](apps/examples/geolocation_gnss_wifi/README.md) | | Full almanac update | Perform a full almanac update | [README](apps/examples/full_almanac_update/README.md) | +| TX/RX continuous | Generate a TX/RX continuous thanks to the test mode | [README](apps/examples/tx_rx_continuous/README.md) | ## Configuration diff --git a/apps/demonstrations/tracker_application/CHANGELOG.md b/apps/demonstrations/tracker_application/CHANGELOG.md index 2951723..2641e91 100644 --- a/apps/demonstrations/tracker_application/CHANGELOG.md +++ b/apps/demonstrations/tracker_application/CHANGELOG.md @@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [2.3.0] - 2023-06-12 + +### Change +- Application code update according to geolocation middleware v2.1.0. see [Geolocation middleware Changelog](../../../geolocation_middleware/CHANGELOG.md). + +### Change +- Uptate LoRa Basics Modem version from 3.2.4 to 3.3.0 + ## [2.2.0] - 2023-01-23 ### Change diff --git a/apps/demonstrations/tracker_application/MDK-ARM/tracker_application.uvprojx b/apps/demonstrations/tracker_application/MDK-ARM/tracker_application.uvprojx index 8777d99..b67f4a0 100644 --- a/apps/demonstrations/tracker_application/MDK-ARM/tracker_application.uvprojx +++ b/apps/demonstrations/tracker_application/MDK-ARM/tracker_application.uvprojx @@ -1355,11 +1355,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - @@ -2896,11 +2891,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - diff --git a/apps/demonstrations/tracker_application/bin/manifest.json b/apps/demonstrations/tracker_application/bin/manifest.json index 71b4533..a6c0c23 100644 --- a/apps/demonstrations/tracker_application/bin/manifest.json +++ b/apps/demonstrations/tracker_application/bin/manifest.json @@ -1,9 +1,9 @@ {"lr1110_transceiver": { - "version": "03.07", - "url": "https://api.github.com/repos/Lora-net/radio_firmware_images/contents/lr1110/transceiver/lr1110_transceiver_0307.h", - "hash": "638a2630f5b1725fcb78a34ef10467d0"}, + "version": "03.08", + "url": "https://api.github.com/repos/Lora-net/radio_firmware_images/contents/lr1110/transceiver/lr1110_transceiver_0308.h", + "hash": "b6528986d0448b56d9282fe3bc0e678e"}, "lbm_app": { - "version": "2.02.00", + "version": "2.03.00", "url": "https://api.github.com/repos/Lora-net/SWSD004/contents/apps/demonstrations/tracker_application/bin/tracker_application.bin", - "hash": "e0c17421f67580d853373c76a9fb0986"} + "hash": "025107862d0af581f0ea8b26f466eaf4"} } diff --git a/apps/demonstrations/tracker_application/bin/tracker_application.bin b/apps/demonstrations/tracker_application/bin/tracker_application.bin old mode 100644 new mode 100755 index 00dc1d0..792bb19 Binary files a/apps/demonstrations/tracker_application/bin/tracker_application.bin and b/apps/demonstrations/tracker_application/bin/tracker_application.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp1.bin b/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp1.bin old mode 100644 new mode 100755 index 084a5cb..aac9fce Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp1.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp1.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp2.bin b/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp2.bin old mode 100644 new mode 100755 index ef4a907..6bb985e Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp2.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp2.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp3.bin b/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp3.bin old mode 100644 new mode 100755 index 5bcca54..45fd2ba Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp3.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_as923_grp3.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_au915.bin b/apps/demonstrations/tracker_application/bin/tracker_application_au915.bin old mode 100644 new mode 100755 index 8cf48d5..1e961b7 Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_au915.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_au915.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_eu868.bin b/apps/demonstrations/tracker_application/bin/tracker_application_eu868.bin old mode 100644 new mode 100755 index 00dc1d0..792bb19 Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_eu868.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_eu868.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_in865.bin b/apps/demonstrations/tracker_application/bin/tracker_application_in865.bin old mode 100644 new mode 100755 index e07a3ff..1577223 Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_in865.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_in865.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_japan.bin b/apps/demonstrations/tracker_application/bin/tracker_application_japan.bin old mode 100644 new mode 100755 index d1bf96b..94090cb Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_japan.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_japan.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_kr920.bin b/apps/demonstrations/tracker_application/bin/tracker_application_kr920.bin old mode 100644 new mode 100755 index 3c28921..8b4f5e5 Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_kr920.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_kr920.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_ru864.bin b/apps/demonstrations/tracker_application/bin/tracker_application_ru864.bin old mode 100644 new mode 100755 index af910c8..24916ac Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_ru864.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_ru864.bin differ diff --git a/apps/demonstrations/tracker_application/bin/tracker_application_us915.bin b/apps/demonstrations/tracker_application/bin/tracker_application_us915.bin old mode 100644 new mode 100755 index 4b20323..20c4f9e Binary files a/apps/demonstrations/tracker_application/bin/tracker_application_us915.bin and b/apps/demonstrations/tracker_application/bin/tracker_application_us915.bin differ diff --git a/apps/demonstrations/tracker_application/main_tracker_application.c b/apps/demonstrations/tracker_application/main_tracker_application.c index b5bcb8f..966094c 100644 --- a/apps/demonstrations/tracker_application/main_tracker_application.c +++ b/apps/demonstrations/tracker_application/main_tracker_application.c @@ -1130,9 +1130,7 @@ static void on_middleware_gnss_event( uint8_t pending_events ) HAL_DBG_TRACE_INFO( "GNSS middleware event - TERMINATED\n" ); gnss_mw_get_event_data_terminated( &tracker_ctx.gnss_mw_event_data ); - HAL_DBG_TRACE_PRINTF( "-- number of scans sent: %u\n", tracker_ctx.gnss_mw_event_data.nb_scans_sent ); - HAL_DBG_TRACE_PRINTF( "-- aiding position check sent: %d\n", - tracker_ctx.gnss_mw_event_data.aiding_position_check_sent ); + gnss_mw_display_terminated_results( &tracker_ctx.gnss_mw_event_data ); ASSERT_SMTC_MODEM_RC( smtc_modem_get_duty_cycle_status( &duty_cycle_status_ms ) ); HAL_DBG_TRACE_PRINTF( "Remaining duty cycle %d ms\n", duty_cycle_status_ms ); @@ -1264,7 +1262,7 @@ static void on_middleware_wifi_event( uint8_t pending_events ) HAL_DBG_TRACE_INFO( "Wi-Fi middleware event - TERMINATED\n" ); wifi_mw_get_event_data_terminated( &tracker_ctx.wifi_nb_scan_sent ); - HAL_DBG_TRACE_PRINTF( "-- number of scans sent: %u\n", tracker_ctx.wifi_nb_scan_sent.nb_scans_sent ); + wifi_mw_display_terminated_results( &tracker_ctx.wifi_nb_scan_sent ); ASSERT_SMTC_MODEM_RC( smtc_modem_get_duty_cycle_status( &duty_cycle_status_ms ) ); HAL_DBG_TRACE_PRINTF( "Remaining duty cycle %d ms\n", duty_cycle_status_ms ); diff --git a/apps/demonstrations/tracker_application/main_tracker_application.h b/apps/demonstrations/tracker_application/main_tracker_application.h index 59fea09..2842eab 100644 --- a/apps/demonstrations/tracker_application/main_tracker_application.h +++ b/apps/demonstrations/tracker_application/main_tracker_application.h @@ -113,8 +113,8 @@ extern "C" { * @brief Defines the application firmware version */ #define TRACKER_MAJOR_APP_VERSION 2 -#define TRACKER_MINOR_APP_VERSION 2 -#define TRACKER_SUB_MINOR_APP_VERSION 0 +#define TRACKER_MINOR_APP_VERSION 3 +#define TRACKER_SUB_MINOR_APP_VERSION 0 #define TRACKER_PCB_HW_NUMBER 595 #define TRACKER_MAJOR_PCB_HW_VERSION 1 @@ -123,7 +123,7 @@ extern "C" { /** * @brief LR11XX radio firmware */ -#define LR11XX_FW_VERSION 0x0307 +#define LR11XX_FW_VERSION 0x0308 /*! * @brief Time during which a LED is turned on when a TX or RX event occurs, in [ms] diff --git a/apps/demonstrations/tracker_application/makefile/Makefile b/apps/demonstrations/tracker_application/makefile/Makefile index fcb4033..205c0d3 100644 --- a/apps/demonstrations/tracker_application/makefile/Makefile +++ b/apps/demonstrations/tracker_application/makefile/Makefile @@ -72,7 +72,6 @@ C_SOURCES += \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_helpers.c \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_queue.c \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_middleware.c \ -$(TOP_DIR)/geolocation_middleware/gnss/src/lr11xx_driver_extension.c \ $(TOP_DIR)/geolocation_middleware/wifi/src/wifi_middleware.c \ $(TOP_DIR)/geolocation_middleware/wifi/src/wifi_helpers.c \ $(TOP_DIR)/geolocation_middleware/common/mw_common.c \ @@ -128,7 +127,7 @@ C_INCLUDES += \ -I$(TOP_DIR)/geolocation_middleware/wifi/src \ -I$(TOP_DIR)/geolocation_middleware/gnss/src \ -I$(TOP_DIR)/geolocation_middleware/bsp \ --I$(TOP_DIR)/geolocation_middleware/common +-I$(TOP_DIR)/geolocation_middleware/common # Add the macro debug trace definition ifeq ($(MIDDLEWARE_TRACE),yes) diff --git a/apps/demonstrations/tracker_application/tracker_utility/tracker_utility.c b/apps/demonstrations/tracker_application/tracker_utility/tracker_utility.c index d9feca7..6b1dae3 100644 --- a/apps/demonstrations/tracker_application/tracker_utility/tracker_utility.c +++ b/apps/demonstrations/tracker_application/tracker_utility/tracker_utility.c @@ -722,29 +722,50 @@ void tracker_store_gnss_in_internal_log( const gnss_mw_event_data_scan_done_t* g else { uint32_t timestamp = apps_modem_common_get_utc_time( ); - if( tracker_ctx.gnss_antenna_sel == GNSS_PCB_ANTENNA ) + + if( gnss_scan_results->aiding_position_check_size != 0 ) { - scan_buf[index++] = TAG_GNSS_PCB; + scan_buf[index++] = TAG_APC_MSG; + + scan_buf[index++] = GNSS_TIMESTAMP_LEN + gnss_scan_results->aiding_position_check_size; + + /* Scan Timestamp */ + scan_buf[index++] = timestamp; + scan_buf[index++] = timestamp >> 8; + scan_buf[index++] = timestamp >> 16; + scan_buf[index++] = timestamp >> 24; + + memcpy( &scan_buf[index], gnss_scan_results->aiding_position_check_msg, + gnss_scan_results->aiding_position_check_size ); + index += gnss_scan_results->aiding_position_check_size; } else { - scan_buf[index++] = TAG_GNSS_PATCH; - } + if( tracker_ctx.gnss_antenna_sel == GNSS_PCB_ANTENNA ) + { + scan_buf[index++] = TAG_GNSS_PCB; + } + else + { + scan_buf[index++] = TAG_GNSS_PATCH; + } - scan_buf[index++] = - GNSS_TOKEN_LEN + GNSS_NB_SAT_LEN + GNSS_TIMESTAMP_LEN + GNSS_LAST_SCAN_IN_GROUP_LEN + GNSS_PROFILE_LEN; - /* Scan Timestamp */ - scan_buf[index++] = timestamp; - scan_buf[index++] = timestamp >> 8; - scan_buf[index++] = timestamp >> 16; - scan_buf[index++] = timestamp >> 24; - scan_buf[index++] = 0; // Set the token to 0 when no sv detected - scan_buf[index++] = 0; // 0 SV detected - scan_buf[index++] = 1; // set a default GNSS mode - scan_buf[index++] = gnss_scan_results->context.mode; + scan_buf[index++] = GNSS_TOKEN_LEN + GNSS_NB_SAT_LEN + GNSS_TIMESTAMP_LEN + + GNSS_LAST_SCAN_IN_GROUP_LEN + GNSS_PROFILE_LEN; + /* Scan Timestamp */ + scan_buf[index++] = timestamp; + scan_buf[index++] = timestamp >> 8; + scan_buf[index++] = timestamp >> 16; + scan_buf[index++] = timestamp >> 24; + scan_buf[index++] = 0; // Set the token to 0 when no sv detected + scan_buf[index++] = 0; // 0 SV detected + scan_buf[index++] = 1; // set a default GNSS mode + scan_buf[index++] = gnss_scan_results->context.mode; + } nb_variable_elements++; } + tracker_store_internal_log( scan_buf, nb_variable_elements, index ); } } @@ -830,6 +851,28 @@ void tracker_restore_internal_log( void ) } break; } + case TAG_APC_MSG: + { + /* Scan Timestamp */ + scan_timestamp = get_uint32_from_array_at_index_and_inc( scan_buf, &scan_buf_index ); + memcpy( &epoch_time, localtime( &scan_timestamp ), sizeof( struct tm ) ); + + uint16_t apc_len = len - GNSS_TIMESTAMP_LEN; + + /* Display Raw NAV Message*/ + HAL_DBG_TRACE_PRINTF( "[%d-%d-%d %d:%d:%d.000] ", epoch_time.tm_year + 1900, epoch_time.tm_mon + 1, + epoch_time.tm_mday, epoch_time.tm_hour, epoch_time.tm_min, epoch_time.tm_sec ); + HAL_DBG_TRACE_PRINTF( "[%d - %d] ", job_counter, tag_element ); + + for( uint8_t i = 0; i < apc_len; i++ ) + { + HAL_DBG_TRACE_PRINTF( "%02X", scan_buf[scan_buf_index++] ); + } + + HAL_DBG_TRACE_PRINTF( "\n" ); + + break; + } case TAG_WIFI: { int8_t wifi_rssi; @@ -2570,6 +2613,8 @@ static void tracker_get_one_scan_from_internal_log( uint16_t scan_number, uint8_ tag_element = scan_buf[scan_buf_index++]; // get the element len = scan_buf[scan_buf_index++]; // get the size element + HAL_DBG_TRACE_PRINTF( "tag_element %d len %d\n", tag_element, len ); + switch( tag_element ) { case TAG_GNSS_PATCH: @@ -2614,6 +2659,33 @@ static void tracker_get_one_scan_from_internal_log( uint16_t scan_number, uint8_ break; } + case TAG_APC_MSG: + { + HAL_DBG_TRACE_PRINTF( "Restore APC\n" ); + /* Scan Timestamp */ + scan_timestamp = get_uint32_from_array_at_index_and_inc( scan_buf, &scan_buf_index ); + memcpy( &epoch_time, localtime( &scan_timestamp ), sizeof( struct tm ) ); + + uint16_t apc_len = len - GNSS_TIMESTAMP_LEN; + + /* Display Raw NAV Message*/ + *buffer_len += snprintf( ( char* ) ( out_buffer + *buffer_len ), out_buffer_len - *buffer_len, + "[%d-%d-%d %d:%d:%d.000] ", epoch_time.tm_year + 1900, epoch_time.tm_mon + 1, + epoch_time.tm_mday, epoch_time.tm_hour, epoch_time.tm_min, epoch_time.tm_sec ); + + *buffer_len += snprintf( ( char* ) ( out_buffer + *buffer_len ), out_buffer_len - *buffer_len, + "[%ld - %d] ", job_counter, tag_element ); + + for( uint16_t i = 0; i < apc_len; i++ ) + { + *buffer_len += snprintf( ( char* ) ( out_buffer + *buffer_len ), out_buffer_len - *buffer_len, "%02X", + scan_buf[scan_buf_index++] ); + } + + *buffer_len += snprintf( ( char* ) ( out_buffer + *buffer_len ), out_buffer_len - *buffer_len, "\r\n" ); + + break; + } case TAG_WIFI: { int8_t wifi_rssi; diff --git a/apps/demonstrations/tracker_application/tracker_utility/tracker_utility.h b/apps/demonstrations/tracker_application/tracker_utility/tracker_utility.h index a593e83..6dd2749 100644 --- a/apps/demonstrations/tracker_application/tracker_utility/tracker_utility.h +++ b/apps/demonstrations/tracker_application/tracker_utility/tracker_utility.h @@ -64,6 +64,7 @@ extern "C" { #define TAG_GNSS_PATCH 0x02 #define TAG_WIFI 0x03 #define TAG_NEXT_SCAN 0x04 +#define TAG_APC_MSG 0x05 /* Internal Log Len */ #define WIFI_SINGLE_BEACON_LEN 0x08 diff --git a/apps/examples/full_almanac_update/get_full_almanac.py b/apps/examples/full_almanac_update/get_full_almanac.py index 75789f9..88e5334 100644 --- a/apps/examples/full_almanac_update/get_full_almanac.py +++ b/apps/examples/full_almanac_update/get_full_almanac.py @@ -37,6 +37,10 @@ def main(): + # The optional GPS timestamp for specific almanac date. The following website + # can convert an UTC time to a GPS timestamp: https://www.gw-openscience.org/gps/ + toa_default = "" + # The file in which the almanac will be written to filename_default = "almanac.h" parser = ArgumentParser( @@ -51,14 +55,25 @@ def main(): help="file that will contain the results", default=filename_default, ) + parser.add_argument( + "-g", + "--gpstime", + help="GPS time reference to be used for generating the almanac header (can be omitted to get latest almanac)", + default=toa_default, + ) args = parser.parse_args() mgs_token = args.mgs_token filename = args.output_file + toa = args.gpstime # Build request URL - url = "https://mgs.loracloud.com/api/v1/almanac/full" - print("Requesting latest full almanac image available...") + if not toa: + url = "https://mgs.loracloud.com/api/v1/almanac/full" + print("Requesting latest full almanac image available...") + else: + url = "https://mgs.loracloud.com/api/v1/almanac/full?toa=" + toa + print("Requesting full almanac image for GPS time " + toa + "...") # HTTP request to MGS my_header = {"Authorization": mgs_token} @@ -82,6 +97,8 @@ def main(): "/* This file has been auto-generated by the get_full_almanac.py script */\n\n" ) file_header += '#include "lr11xx_gnss.h"\n\n' + if toa: + file_header += "/* Almanac image for GPS time " + toa + " */\n" with open(filename, "w") as f: f.write(file_header + my_almanac_in_hex + "\n") diff --git a/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_LR_cred_crypto.uvprojx b/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_LR_cred_crypto.uvprojx index 7bea792..0e65d8c 100644 --- a/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_LR_cred_crypto.uvprojx +++ b/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_LR_cred_crypto.uvprojx @@ -1258,11 +1258,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -2596,11 +2591,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -3883,11 +3873,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 diff --git a/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_LR_crypto.uvprojx b/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_LR_crypto.uvprojx index bf8cd16..73dabcb 100644 --- a/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_LR_crypto.uvprojx +++ b/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_LR_crypto.uvprojx @@ -1258,11 +1258,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -2596,11 +2591,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -3883,11 +3873,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -5221,11 +5206,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 diff --git a/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_soft_crypto.uvprojx b/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_soft_crypto.uvprojx index e824832..61fe5f1 100644 --- a/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_soft_crypto.uvprojx +++ b/apps/examples/geolocation_gnss/MDK-ARM/lbm_example_geolocation_gnss_soft_crypto.uvprojx @@ -1268,11 +1268,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -2616,11 +2611,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -3913,11 +3903,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -5261,11 +5246,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 diff --git a/apps/examples/geolocation_gnss/main_geolocation_gnss.c b/apps/examples/geolocation_gnss/main_geolocation_gnss.c index a265056..f61da49 100644 --- a/apps/examples/geolocation_gnss/main_geolocation_gnss.c +++ b/apps/examples/geolocation_gnss/main_geolocation_gnss.c @@ -72,9 +72,9 @@ /** * @brief LR11XX radio firmware */ -#define LR1110_FW_VERSION 0x0307 +#define LR1110_FW_VERSION 0x0308 #define LR1110_FW_TYPE 0x01 -#define LR1120_FW_VERSION 0x0101 +#define LR1120_FW_VERSION 0x0102 #define LR1120_FW_TYPE 0x02 /** @@ -450,10 +450,7 @@ static void on_middleware_gnss_event( uint8_t pending_events ) HAL_DBG_TRACE_INFO( "GNSS middleware event - TERMINATED\n" ); gnss_mw_get_event_data_terminated( &event_data ); - HAL_DBG_TRACE_PRINTF( "TERMINATED info:\n" ); - HAL_DBG_TRACE_PRINTF( "-- number of scans sent: %u\n", event_data.nb_scans_sent ); - HAL_DBG_TRACE_PRINTF( "-- aiding position check sent: %d\n", event_data.aiding_position_check_sent ); - HAL_DBG_TRACE_PRINTF( "-- indoor detected: %d\n", event_data.indoor_detected ); + gnss_mw_display_terminated_results( &event_data ); } if( gnss_mw_has_event( pending_events, GNSS_MW_EVENT_SCAN_CANCELLED ) ) diff --git a/apps/examples/geolocation_gnss/makefile/Makefile b/apps/examples/geolocation_gnss/makefile/Makefile index 595ef47..088ba1f 100644 --- a/apps/examples/geolocation_gnss/makefile/Makefile +++ b/apps/examples/geolocation_gnss/makefile/Makefile @@ -68,7 +68,6 @@ BUILD_DIR = ./build C_SOURCES += \ ../main_$(APP).c \ $(TOP_DIR)/geolocation_middleware/common/mw_common.c \ -$(TOP_DIR)/geolocation_middleware/gnss/src/lr11xx_driver_extension.c \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_helpers.c \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_queue.c \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_middleware.c \ diff --git a/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_LR_cred_crypto.uvprojx b/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_LR_cred_crypto.uvprojx index e263b4a..692f2e8 100644 --- a/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_LR_cred_crypto.uvprojx +++ b/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_LR_cred_crypto.uvprojx @@ -1258,11 +1258,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -2606,11 +2601,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -3903,11 +3893,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -5251,11 +5236,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 diff --git a/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_LR_crypto.uvprojx b/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_LR_crypto.uvprojx index a78dfd5..e054e44 100644 --- a/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_LR_crypto.uvprojx +++ b/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_LR_crypto.uvprojx @@ -1258,11 +1258,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -2606,11 +2601,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -3903,11 +3893,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -5251,11 +5236,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 diff --git a/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_soft_crypto.uvprojx b/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_soft_crypto.uvprojx index a93e52d..cb66e67 100644 --- a/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_soft_crypto.uvprojx +++ b/apps/examples/geolocation_gnss_wifi/MDK-ARM/lbm_example_geolocation_gnss_wifi_soft_crypto.uvprojx @@ -1268,11 +1268,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -2626,11 +2621,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -3933,11 +3923,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 @@ -5291,11 +5276,6 @@ 1 ..\..\..\..\geolocation_middleware\gnss\src\gnss_queue.c - - lr11xx_driver_extension.c - 1 - ..\..\..\..\geolocation_middleware\gnss\src\lr11xx_driver_extension.c - mw_common.c 1 diff --git a/apps/examples/geolocation_gnss_wifi/main_geolocation_gnss_wifi.c b/apps/examples/geolocation_gnss_wifi/main_geolocation_gnss_wifi.c index 1f1f631..7b70041 100644 --- a/apps/examples/geolocation_gnss_wifi/main_geolocation_gnss_wifi.c +++ b/apps/examples/geolocation_gnss_wifi/main_geolocation_gnss_wifi.c @@ -79,9 +79,9 @@ /** * @brief LR11XX radio firmware */ -#define LR1110_FW_VERSION 0x0307 +#define LR1110_FW_VERSION 0x0308 #define LR1110_FW_TYPE 0x01 -#define LR1120_FW_VERSION 0x0101 +#define LR1120_FW_VERSION 0x0102 #define LR1120_FW_TYPE 0x02 /** @@ -108,6 +108,11 @@ */ #define APP_TIMER_KEEP_ALIVE ( 30 ) +/** + * @brief The delay before a Wi-Fi scan when a DM request is sent + */ +#define WIFI_SCAN_DELAY_S ( 60 ) + /* * ----------------------------------------------------------------------------- * --- PRIVATE TYPES ----------------------------------------------------------- @@ -133,6 +138,11 @@ static ralf_t* modem_radio; */ static wifi_mw_event_data_scan_done_t wifi_results; +/*! + * @brief Wi-Fi scan delay after GNSS scan + */ +static uint32_t wifi_scan_delay = 0; + /*! * @brief First time sync status for application startup */ @@ -459,6 +469,9 @@ static void on_middleware_gnss_event( uint8_t pending_events ) { uint8_t dm_almanac_status = SMTC_MODEM_DM_FIELD_ALMANAC_STATUS; ASSERT_SMTC_MODEM_RC( smtc_modem_dm_request_single_uplink( &dm_almanac_status, 1 ) ); + + /* Delay next wifi scan to avoid collision with almanac status request */ + wifi_scan_delay = WIFI_SCAN_DELAY_S; } } @@ -471,10 +484,7 @@ static void on_middleware_gnss_event( uint8_t pending_events ) HAL_DBG_TRACE_INFO( "GNSS middleware event - TERMINATED\n" ); gnss_mw_get_event_data_terminated( &event_data ); - HAL_DBG_TRACE_PRINTF( "TERMINATED info:\n" ); - HAL_DBG_TRACE_PRINTF( "-- number of scans sent: %u\n", event_data.nb_scans_sent ); - HAL_DBG_TRACE_PRINTF( "-- aiding position check sent: %d\n", event_data.aiding_position_check_sent ); - HAL_DBG_TRACE_PRINTF( "-- indoor detected: %d\n", event_data.indoor_detected ); + gnss_mw_display_terminated_results( &event_data ); } if( gnss_mw_has_event( pending_events, GNSS_MW_EVENT_SCAN_CANCELLED ) ) @@ -486,6 +496,9 @@ static void on_middleware_gnss_event( uint8_t pending_events ) { HAL_DBG_TRACE_ERROR( "GNSS middleware event - ERROR NO TIME\n" ); ASSERT_SMTC_MODEM_RC( smtc_modem_time_trigger_sync_request( stack_id ) ); + + /* Delay next wifi scan to avoid collision with time sync request */ + wifi_scan_delay = WIFI_SCAN_DELAY_S; } if( gnss_mw_has_event( pending_events, GNSS_MW_EVENT_ERROR_ALMANAC_UPDATE ) ) @@ -493,6 +506,9 @@ static void on_middleware_gnss_event( uint8_t pending_events ) HAL_DBG_TRACE_ERROR( "GNSS middleware event - ALMANAC UPDATE REQUIRED\n" ); uint8_t dm_almanac_status = SMTC_MODEM_DM_FIELD_ALMANAC_STATUS; ASSERT_SMTC_MODEM_RC( smtc_modem_dm_request_single_uplink( &dm_almanac_status, 1 ) ); + + /* Delay next wifi scan to avoid collision with almanac status request */ + wifi_scan_delay = WIFI_SCAN_DELAY_S; } if( gnss_mw_has_event( pending_events, GNSS_MW_EVENT_ERROR_NO_AIDING_POSITION ) ) @@ -521,11 +537,12 @@ static void on_middleware_gnss_event( uint8_t pending_events ) gnss_mw_has_event( pending_events, GNSS_MW_EVENT_ERROR_UNKNOWN ) || gnss_mw_has_event( pending_events, GNSS_MW_EVENT_SCAN_CANCELLED ) ) { - wifi_rc = wifi_mw_scan_start( 0 ); + wifi_rc = wifi_mw_scan_start( wifi_scan_delay ); if( wifi_rc != MW_RC_OK ) { HAL_DBG_TRACE_ERROR( "Failed to start WiFi scan\n" ); } + wifi_scan_delay = 0; } gnss_mw_clear_pending_events( ); @@ -552,8 +569,7 @@ static void on_middleware_wifi_event( uint8_t pending_events ) HAL_DBG_TRACE_INFO( "Wi-Fi middleware event - TERMINATED\n" ); wifi_mw_get_event_data_terminated( &event_data ); - HAL_DBG_TRACE_PRINTF( "TERMINATED info:\n" ); - HAL_DBG_TRACE_PRINTF( "-- number of scans sent: %u\n", event_data.nb_scans_sent ); + wifi_mw_display_terminated_results( &event_data ); } if( wifi_mw_has_event( pending_events, WIFI_MW_EVENT_SCAN_CANCELLED ) ) diff --git a/apps/examples/geolocation_gnss_wifi/makefile/Makefile b/apps/examples/geolocation_gnss_wifi/makefile/Makefile index a58a7ed..62f54b1 100644 --- a/apps/examples/geolocation_gnss_wifi/makefile/Makefile +++ b/apps/examples/geolocation_gnss_wifi/makefile/Makefile @@ -68,7 +68,6 @@ BUILD_DIR = ./build C_SOURCES += \ ../main_$(APP).c \ $(TOP_DIR)/geolocation_middleware/common/mw_common.c \ -$(TOP_DIR)/geolocation_middleware/gnss/src/lr11xx_driver_extension.c \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_helpers.c \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_queue.c \ $(TOP_DIR)/geolocation_middleware/gnss/src/gnss_middleware.c \ diff --git a/apps/examples/geolocation_wifi/main_geolocation_wifi.c b/apps/examples/geolocation_wifi/main_geolocation_wifi.c index d0c2b61..12eddef 100644 --- a/apps/examples/geolocation_wifi/main_geolocation_wifi.c +++ b/apps/examples/geolocation_wifi/main_geolocation_wifi.c @@ -73,9 +73,9 @@ /** * @brief LR11XX radio firmware */ -#define LR1110_FW_VERSION 0x0307 +#define LR1110_FW_VERSION 0x0308 #define LR1110_FW_TYPE 0x01 -#define LR1120_FW_VERSION 0x0101 +#define LR1120_FW_VERSION 0x0102 #define LR1120_FW_TYPE 0x02 /* @@ -324,8 +324,7 @@ static void on_middleware_wifi_event( uint8_t pending_events ) HAL_DBG_TRACE_INFO( "Wi-Fi middleware event - TERMINATED\n" ); wifi_mw_get_event_data_terminated( &event_data ); - HAL_DBG_TRACE_PRINTF( "TERMINATED info:\n" ); - HAL_DBG_TRACE_PRINTF( "-- number of scans sent: %u\n", event_data.nb_scans_sent ); + wifi_mw_display_terminated_results( &event_data ); } if( wifi_mw_has_event( pending_events, WIFI_MW_EVENT_SCAN_CANCELLED ) ) diff --git a/geolocation_middleware/.clang-format b/geolocation_middleware/.clang-format new file mode 100644 index 0000000..e259ec1 --- /dev/null +++ b/geolocation_middleware/.clang-format @@ -0,0 +1,88 @@ +--- +Language: Cpp +# BasedOnStyle: Google +AccessModifierOffset: -1 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: true +AlignConsecutiveDeclarations: true +AlignEscapedNewlinesLeft: true +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: None +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: true +AlwaysBreakTemplateDeclarations: true +BinPackArguments: true +BinPackParameters: true +BreakBeforeBraces: Custom +BraceWrapping: + AfterClass: true + AfterControlStatement: true + AfterEnum: true + AfterFunction: true + AfterNamespace: true + AfterObjCDeclaration: true + AfterStruct: true + AfterUnion: true + BeforeElse: true + IndentBraces: false +BreakBeforeBinaryOperators: None +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +ColumnLimit: 120 +CommentPragmas: '^ IWYU pragma:' +ConstructorInitializerAllOnOneLineOrOnePerLine: true +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: false +DerivePointerAlignment: false +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ] +IncludeCategories: + - Regex: '^<.*\.h>' + Priority: 1 + - Regex: '^<.*' + Priority: 2 + - Regex: '.*' + Priority: 3 +IndentCaseLabels: false +IndentWidth: 4 +IndentWrappedFunctionNames: false +KeepEmptyLinesAtTheStartOfBlocks: false +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBlockIndentWidth: 2 +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: false +PenaltyBreakBeforeFirstCallParameter: 1 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 200 +PointerAlignment: Left +ReflowComments: true +SortIncludes: false +SpaceAfterCStyleCast: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: Never +SpaceInEmptyParentheses: true +SpacesBeforeTrailingComments: 2 +SpacesInAngles: true +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: true +SpacesInParentheses: true +SpacesInSquareBrackets: false +Standard: Auto +TabWidth: 4 +UseTab: Never +... diff --git a/geolocation_middleware/CHANGELOG.md b/geolocation_middleware/CHANGELOG.md index 0000ba3..4d08975 100644 --- a/geolocation_middleware/CHANGELOG.md +++ b/geolocation_middleware/CHANGELOG.md @@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [v2.1.0] 2023-06-20 + +This release comes with the latest release of LR11xx transceiver (LR1110:0x308, LR1110:0x102), which fixes an issue when generating GNSS NAV messages with dopplers enabled but in the mode '7 dopplers max'. +Now that this issue is fixed, we can enable the dopplers in all modes, to improve aiding position update in general case. + +This release also provides few bugfixes as described below, and comes with a minor API changes in the public types for SCAN_DONE and TERMINATED events data. + +### Changed + +* [gnss_middleware]: Enabled dopplers (7 max) in NAV messages for all scan modes (autonomous, assisted, assisted_for_aiding_position). +* [gnss_middleware]: Reduced stack memory usage +* [gnss_middleware]: Changed `gnss_mw_event_data_scan_done_t` to include APC message payload and size. So that those messages can be handled by the use +application when send_bypass mode is selected. +* [gnss_middleware]: Moved `indoor_detected` status from `gnss_mw_event_data_terminated_t` to `gnss_mw_event_data_scan_done_t`, as it relates to a scan status. +* [gnss_middleware]: Bugfix: Do not send APC messages over the air when send_bypass mode is selected. +* [gnss_middleware]: Bugfix: In function `smtc_gnss_get_doppler_error()`, doppler error is not computed if there is no space vehicles (among detected ones) with almanac age 0 at all. +* [gnss_middleware]: Removed lr11xx_driver_extension.h/c files as functions have been released with the LR11xx driver coming with LBM release v3.3.x. +* [gnss_middleware]: Almanacs are considered to be updated when age is greater or equal to 6 months for GPS and 8 months for Beidou. +* [gnss_middleware]: Added a new API function to print TERMINATED event info: `gnss_mw_display_terminated_results()`. +* [wifi_middleware]: Reduced stack memory usage +* [wifi_middleware]: Added a new API function to print TERMINATED event info: `wifi_mw_display_terminated_results()`. + ## [v2.0.0] 2023-01-20 This release comes along with the new `GNSS NAV-Group Protocol Specification` from LoRaCloud `Modem and Geolocation Services`, and aims to simplify end-to-end integration by removing the need for an Application Server to handle the GNSS middleware logic. diff --git a/geolocation_middleware/doc/geolocationMiddleware.rst b/geolocation_middleware/doc/geolocationMiddleware.rst index a181e9d..d2496d9 100644 --- a/geolocation_middleware/doc/geolocationMiddleware.rst +++ b/geolocation_middleware/doc/geolocationMiddleware.rst @@ -39,13 +39,13 @@ The user application just has to program when the next scan needs to be launched GNSS middleware --------------- +The GNSS middleware implements the `LoRa Edge GNSS-NG (NAV-Group) positioning protocol `_ specified by LoRaCloud. + .. _GNSS scan group: Scan group (GNSS Nav-Group) +++++++++++++++++++++++++++ -------- TODO: add link to GNSS Nav-Group description of LoRaCloud -------- - In order to get the best accuracy from GNSS scan results, it is recommended to use the **multiframe** feature of the solver. In this context, a scan group is a group of scan results (NAV messages) to be used together to solve a position. @@ -126,7 +126,7 @@ Internal choices In order to reach an acceptable trade-off for performances, power consumption and simplicity, some parameters have been set in the middleware, and are not configurable from the API. * A maximum of 10 Space Vehicles detected per NAV message: allow good accuracy while still being able to transmit a complete NAV message in 1 uplink (49 bytes when dopplers are enabled). -* LR1110 scan parameters: dopplers are enabled only for autonomous scans or for aiding position update scans, so that the doppler solver can be used to get an assistance position update from LoRaCloud. +* LR1110 scan parameters: dopplers are always enabled in NAV messages, to maximize the chances to to get an assistance position update from LoRaCloud, using the doppler solver. * A scan group is valid as soon as there is a valid scan in the group (with a valid NAV message). Some clarification about what is a valid scan group, a valid scan or a valid NAV message: @@ -192,7 +192,7 @@ There are some prerequisites necessary to have a functional GNSS scan, and to ge * **time**: a valid time must be provided (ALC Sync, network clock sync...). The Modem clock sync feature from LBM is used. * **almanac**: the Almanac written in the LR11xx flash memory must be as up-to-date as possible. It can either be be fully updated at once, or incrementally updated through LoRaCloud Modem & Geolocation Services. The Modem almanac update feature from LBM is used. -* **assistance position**: an assistance position must be provided to the middleware, either as a user defined assistance position, or by forwarding the downlink coming from the solver. +* **assistance position**: an assistance position must be provided to the middleware, either as a user defined assistance position, or by forwarding downlinks coming from LoRaCloud. * **downlinks**: downlinks received by the user application on the port used by GNSS middleware should be transmitted to the middleware using the ``gnss_mw_handle_downlink()`` API function. It is important in order to receive an aiding position update from LoRaCloud. .. _GNSS scan results payload format: @@ -211,12 +211,12 @@ The format is the following: +---------------------+--------+------------------+--------------------+ | scan group last NAV | RFU | scan group token | NAV message | +=====================+========+==================+====================+ - | 1 bit | 2 bits | 5 bits | 36 or 47 bytes max | + | 1 bit | 2 bits | 5 bits | 47 bytes max | +---------------------+--------+------------------+--------------------+ * scan group last NAV: indicates that this scan is the last of a scan group. * scan group token: it is the identifier of the current scan group. It is used to group the NAV message which should be used as a multiframe solving request. -* NAV message: it is the GNSS scan result returned by the LR11xx radio. The actual size depends on the number of Space Vehicle detected by the scan, and if dopplers are enabled or not. For assisted scans, the maximum size is 49 bytes if dopplers are enabled, and 36 bytes otherwise. +* NAV message: it is the GNSS scan result returned by the LR11xx radio. The actual size depends on the number of Space Vehicle detected by the scan. The maximum size of the complete payload has been kept under 51 bytes to match with the maximum payload size allowed by the LoRaWAN Regional Parameters for most regions (there are few exceptions like DR0 of the US915 region which therefore cannot be used). @@ -225,7 +225,7 @@ The maximum size of the complete payload has been kept under 51 bytes to match w Aiding Position Check (APC) payload format ++++++++++++++++++++++++++++++++++++++++++ -When a scan group completes with no NAV message generated, the middleware will try to check if it is because the device is indoor (with an autonomous scan), or maybe because the current assistance position is too wrong to allow the assisted scan to detect anything. +When a scan group completes with no NAV message generated, the middleware will try to check if it is because the device is indoor (with an autonomous scan), or because the current assistance position is too wrong to allow the assisted scan to detect anything. If it is not indoor, the middleware will send an Aiding Position Check (APC) message to LoRaCloud, to allow LoRaCloud to compare the current aiding position configured in the end-device, with any history or context it may have to check (Wi-Fi fix, network position...). There are 2 possible formats for APC messages: @@ -264,7 +264,7 @@ The best performances for GNSS geolocation is achieved by using the "assisted sc There are 2 ways to provide this assistance position: * an assistance position is given by the user at application startup. -* no assistance position is given by the user, so the middleware starts with an "autonomous scan" and rely on the solver and the application server to return an assistance position with an applicative downlink based on the autonomous can result. +* no assistance position is given by the user, so the middleware starts with an "autonomous scan" and rely on the solver and the application server to return an assistance position with an applicative downlink based on the autonomous scan result. Note: When using autonomous scan, the sensitivity is not optimal. A better sky view is required to detect Space Vehicles compared to assisted scan. So it is recommended, if possible, to set an assistance position (as accurate as possible) at startup. @@ -324,7 +324,7 @@ Refer to the ``gnss/src/gnss_middleware.h`` file. Wi-Fi middleware ---------------- -The Wi-Fi middleware implements the `LoRa Edge Wi-Fi positioning protocol` specified by LoRaCloud. +The Wi-Fi middleware implements the `LoRa Edge Wi-Fi positioning protocol `_ specified by LoRaCloud. Contrary to the GNSS middleware, there is no scan group concept in the Wi-Fi middleware, and no multiframe solving. A Wi-Fi scan will simply return the list of Access Points MAC address that have been detected (and optionally RSSI), and will be sent to the solver within one uplink message. @@ -410,8 +410,6 @@ Scan results payload format The format of the payload is described by the `LoRa Edge Wi-Fi positioning protocol` of LoRaCloud. -https://www.loracloud.com/documentation/modem_services?url=mdmsvc.html#lr1110-wifi-positioning-protocol - There are 2 formats possible, that the user can choose: * `WIFI_MW_PAYLOAD_MAC`: contains only the MAC addresses of the detected Access Points diff --git a/geolocation_middleware/gnss/src/gnss_helpers.c b/geolocation_middleware/gnss/src/gnss_helpers.c index e6e0359..b6ee9f5 100644 --- a/geolocation_middleware/gnss/src/gnss_helpers.c +++ b/geolocation_middleware/gnss/src/gnss_helpers.c @@ -51,8 +51,6 @@ #include "lr11xx_system.h" #include "lr11xx_gnss.h" -#include "lr11xx_driver_extension.h" - /* * ----------------------------------------------------------------------------- * --- PRIVATE MACROS----------------------------------------------------------- @@ -92,16 +90,52 @@ * --- PRIVATE CONSTANTS ------------------------------------------------------- */ +/** + * @brief The maximum number of visible satellite for 1 constellation + */ +#define GNSS_NB_VISIBLE_SVS_PER_CONSTELLATION_MAX ( 12 ) + /* * ----------------------------------------------------------------------------- * --- PRIVATE TYPES ----------------------------------------------------------- */ +/** + * @brief Doppler offset between detected and visible satellite + */ +typedef struct doppler_offset_s +{ + lr11xx_gnss_satellite_id_t satellite_id; //!< SV ID + int16_t doppler_offset; //!< SV doppler offset in Hz + int16_t doppler_error; //!< SV doppler error - step of 125Hz (almanac age) +} doppler_offset_t; + /* * ----------------------------------------------------------------------------- * --- PRIVATE VARIABLES ------------------------------------------------------- */ +/** + * @brief Array to store current visible satellites for GPS constellation + */ +static lr11xx_gnss_visible_satellite_t visible_svs_gps[GNSS_NB_VISIBLE_SVS_PER_CONSTELLATION_MAX]; + +/** + * @brief Array to store current visible satellites for BEIDOU constellation + */ +static lr11xx_gnss_visible_satellite_t visible_svs_beidou[GNSS_NB_VISIBLE_SVS_PER_CONSTELLATION_MAX]; + +/** + * @brief Offsets of doppler between theoretical visible satellites and detected satellites + */ +static doppler_offset_t doppler_offsets[GNSS_NB_SVS_MAX]; + +/** + * @brief Offsets storage for median calculation + */ +static int doppler_offsets_for_median_size; +static int doppler_offsets_for_median[GNSS_NB_SVS_MAX]; + /* * ----------------------------------------------------------------------------- * --- PRIVATE FUNCTIONS DECLARATION ------------------------------------------- @@ -299,29 +333,24 @@ smtc_gnss_get_results_return_code_t smtc_gnss_get_results( const void* radio_con const lr11xx_gnss_message_host_status_t status_code_raw = ( lr11xx_gnss_message_host_status_t ) results[1]; switch( status_code_raw ) { - case LR11XX_GNSS_HOST_NO_TIME: - { + case LR11XX_GNSS_HOST_NO_TIME: { MW_DBG_TRACE_ERROR( "GNSS error: NO TIME\n" ); return SMTC_GNSS_GET_RESULTS_ERROR_NO_TIME; } - case LR11XX_GNSS_HOST_NO_SATELLITE_DETECTED: - { + case LR11XX_GNSS_HOST_NO_SATELLITE_DETECTED: { MW_DBG_TRACE_INFO( "GNSS error: NO SATELLITE\n" ); *no_sv_detected = true; return SMTC_GNSS_GET_RESULTS_NO_ERROR; /* not an error */ } - case LR11XX_GNSS_HOST_ALMANAC_IN_FLASH_TOO_OLD: - { + case LR11XX_GNSS_HOST_ALMANAC_IN_FLASH_TOO_OLD: { MW_DBG_TRACE_ERROR( "GNSS error: ALMANAC TOO OLD\n" ); return SMTC_GNSS_GET_RESULTS_ERROR_ALMANAC; } - case LR11XX_GNSS_HOST_NOT_ENOUGH_SV_DETECTED_TO_BUILD_A_NAV_MESSAGE: - { + case LR11XX_GNSS_HOST_NOT_ENOUGH_SV_DETECTED_TO_BUILD_A_NAV_MESSAGE: { MW_DBG_TRACE_INFO( "GNSS error: NOT ENOUGH SVs TO BUILD A NAV MESSAGE\n" ); return SMTC_GNSS_GET_RESULTS_NO_ERROR; /* not an error */ } - default: - { + default: { MW_DBG_TRACE_ERROR( "GNSS error: UNKNOWN ERROR CODE: 0x%02X\n", status_code_raw ); return SMTC_GNSS_GET_RESULTS_ERROR_UNKNOWN; } @@ -393,11 +422,13 @@ bool smtc_gnss_get_almanac_update_status( const void* radio_context, const uint3 const lr11xx_gnss_constellation_mask_t constellations, bool* almanacs_update_required ) { - lr11xx_status_t status; - uint8_t nb_visible_gps_satellites, nb_visible_beidou_satellites; - lr11xx_gnss_visible_satellite_t visible_gps[12]; - lr11xx_gnss_visible_satellite_t visible_beidou[12]; - uint8_t nb_almanac_old = 0; + lr11xx_status_t status; + uint8_t nb_visible_gps_satellites = 0, nb_visible_beidou_satellites = 0; + uint8_t nb_almanac_old = 0; + + /* Initialize work variables */ + memset( visible_svs_gps, 0, sizeof visible_svs_gps ); + memset( visible_svs_beidou, 0, sizeof visible_svs_beidou ); /* Initialize output status */ *almanacs_update_required = false; @@ -413,26 +444,29 @@ bool smtc_gnss_get_almanac_update_status( const void* radio_context, const uint3 return false; } - status = lr11xx_gnss_get_visible_satellites( radio_context, nb_visible_gps_satellites, visible_gps ); + status = lr11xx_gnss_get_visible_satellites( radio_context, nb_visible_gps_satellites, visible_svs_gps ); if( status != LR11XX_STATUS_OK ) { MW_DBG_TRACE_ERROR( "Failed to get visible GPS satellites info\n" ); return false; } + /* Debug prints */ +#if GNSS_HELPERS_DBG_TRACE == GNSS_HELPERS_FEATURE_ON GNSS_HELPERS_TRACE_PRINTF( "\nVisible GPS satellites: %u\n", nb_visible_gps_satellites ); GNSS_HELPERS_TRACE_PRINTF( "id | doppler | almanac_age \n" ); GNSS_HELPERS_TRACE_PRINTF( "----|------------|--------------\n" ); - for( int i = 0; i < nb_visible_gps_satellites; i++ ) + for( uint8_t i = 0; i < nb_visible_gps_satellites; i++ ) { - GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", visible_gps[i].satellite_id, visible_gps[i].doppler, - visible_gps[i].doppler_error ); + GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", visible_svs_gps[i].satellite_id, + visible_svs_gps[i].doppler, visible_svs_gps[i].doppler_error ); } +#endif /* Get the ratio of visible GPS SVs which have almanacs up-to-date */ - for( int i = 0; i < nb_visible_gps_satellites; i++ ) + for( uint8_t i = 0; i < nb_visible_gps_satellites; i++ ) { - if( visible_gps[i].doppler_error > 250 ) /* almanac age more than 6 months old (125Hz = 3months) */ + if( visible_svs_gps[i].doppler_error >= 250 ) /* almanac age more than 6 months old (125Hz = 3months) */ { nb_almanac_old += 1; } @@ -450,26 +484,29 @@ bool smtc_gnss_get_almanac_update_status( const void* radio_context, const uint3 return false; } - status = lr11xx_gnss_get_visible_satellites( radio_context, nb_visible_beidou_satellites, visible_beidou ); + status = lr11xx_gnss_get_visible_satellites( radio_context, nb_visible_beidou_satellites, visible_svs_beidou ); if( status != LR11XX_STATUS_OK ) { MW_DBG_TRACE_ERROR( "Failed to get visible BEIDOU satellites info\n" ); return false; } + /* Debug prints */ +#if GNSS_HELPERS_DBG_TRACE == GNSS_HELPERS_FEATURE_ON GNSS_HELPERS_TRACE_PRINTF( "\nVisible BEIDOU satellites: %u\n", nb_visible_beidou_satellites ); GNSS_HELPERS_TRACE_PRINTF( "id | doppler | almanac_age \n" ); GNSS_HELPERS_TRACE_PRINTF( "----|------------|--------------\n" ); - for( int i = 0; i < nb_visible_beidou_satellites; i++ ) + for( uint8_t i = 0; i < nb_visible_beidou_satellites; i++ ) { - GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", visible_beidou[i].satellite_id, - visible_beidou[i].doppler, visible_beidou[i].doppler_error ); + GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", visible_svs_beidou[i].satellite_id, + visible_svs_beidou[i].doppler, visible_svs_beidou[i].doppler_error ); } +#endif /* Get the ratio of visible BEIDOU SVs which have almanacs up-to-date */ - for( int i = 0; i < nb_visible_beidou_satellites; i++ ) + for( uint8_t i = 0; i < nb_visible_beidou_satellites; i++ ) { - if( visible_beidou[i].doppler_error > 250 ) /* almanac age more than 8 months old (125Hz = 4months) */ + if( visible_svs_beidou[i].doppler_error >= 250 ) /* almanac age more than 8 months old (125Hz = 4months) */ { nb_almanac_old += 1; } @@ -477,18 +514,23 @@ bool smtc_gnss_get_almanac_update_status( const void* radio_context, const uint3 } /* Percentage of almanac updated among visible SVs */ - uint16_t almanacs_updated_status = - 100 - ( nb_almanac_old * 100 / ( nb_visible_gps_satellites + nb_visible_beidou_satellites ) ); + uint16_t almanacs_updated_status; + if( ( nb_visible_gps_satellites == 0 ) && ( nb_visible_beidou_satellites == 0 ) ) + { + MW_DBG_TRACE_ERROR( "no visible satellites for GPS and Beidou, should not happen\n" ); + return false; + } + else + { + almanacs_updated_status = + 100 - ( nb_almanac_old * 100 / ( nb_visible_gps_satellites + nb_visible_beidou_satellites ) ); + } /* at least 70% of visible SVs with up-to-date almanacs are necessary to trust doppler error detection */ if( almanacs_updated_status < 70 ) { *almanacs_update_required = true; } - else - { - *almanacs_update_required = false; - } GNSS_HELPERS_TRACE_PRINTF( "Almanac update status: %u%% (update_required:%d)\n", almanacs_updated_status, *almanacs_update_required ); @@ -496,32 +538,20 @@ bool smtc_gnss_get_almanac_update_status( const void* radio_context, const uint3 return true; } -bool smtc_gnss_get_doppler_error_from_nav( const uint8_t* nav ) -{ - uint8_t bit = GETBIT( nav[0], 4 ); - return ( bool ) bit; -} - bool smtc_gnss_get_doppler_error( const void* radio_context, const uint32_t date, const lr11xx_gnss_solver_assistance_position_t* assistance_position, const lr11xx_gnss_constellation_mask_t constellations, const uint8_t nb_detected_sv, const lr11xx_gnss_detected_satellite_t* detected_sv_info, bool* doppler_error ) { - lr11xx_status_t status; - uint8_t nb_visible_gps_satellites, nb_visible_beidou_satellites; - lr11xx_gnss_visible_satellite_t visible_gps[12]; - lr11xx_gnss_visible_satellite_t visible_beidou[12]; - - typedef struct doppler_offset_s - { - lr11xx_gnss_satellite_id_t id; - int16_t doppler_offset; - int16_t almanac_age; - } doppler_offset_t; - doppler_offset_t doppler_offsets[GNSS_NB_SVS_MAX] = { 0 }; /* doppler offsets of detected SVs */ + lr11xx_status_t status; + uint8_t nb_visible_gps_satellites, nb_visible_beidou_satellites; - int doppler_offsets_for_median_size = 0; - int doppler_offsets_for_median[GNSS_NB_SVS_MAX] = { 0 }; + /* Initialize work variables */ + doppler_offsets_for_median_size = 0; + memset( doppler_offsets_for_median, 0, sizeof doppler_offsets_for_median ); + memset( doppler_offsets, 0, sizeof doppler_offsets ); + memset( visible_svs_gps, 0, sizeof visible_svs_gps ); + memset( visible_svs_beidou, 0, sizeof visible_svs_beidou ); /* Initialize output status */ *doppler_error = false; @@ -540,7 +570,7 @@ bool smtc_gnss_get_doppler_error( const void* radio_context, const uint32_t date return false; } - status = lr11xx_gnss_get_visible_satellites( radio_context, nb_visible_gps_satellites, visible_gps ); + status = lr11xx_gnss_get_visible_satellites( radio_context, nb_visible_gps_satellites, visible_svs_gps ); if( status != LR11XX_STATUS_OK ) { MW_DBG_TRACE_ERROR( "Failed to get visible GPS satellites info\n" ); @@ -559,7 +589,7 @@ bool smtc_gnss_get_doppler_error( const void* radio_context, const uint32_t date return false; } - status = lr11xx_gnss_get_visible_satellites( radio_context, nb_visible_beidou_satellites, visible_beidou ); + status = lr11xx_gnss_get_visible_satellites( radio_context, nb_visible_beidou_satellites, visible_svs_beidou ); if( status != LR11XX_STATUS_OK ) { MW_DBG_TRACE_ERROR( "Failed to get visible BEIDOU satellites info\n" ); @@ -568,21 +598,21 @@ bool smtc_gnss_get_doppler_error( const void* radio_context, const uint32_t date } /* Compute the offset between the detected doppler and the theoretical doppler of visible SVs */ - for( int j = 0; j < nb_detected_sv; j++ ) + for( uint8_t j = 0; j < nb_detected_sv; j++ ) { /* GPS satellites */ if( constellations & LR11XX_GNSS_GPS_MASK ) { - for( int k = 0; k < nb_visible_gps_satellites; k++ ) + for( uint8_t k = 0; k < nb_visible_gps_satellites; k++ ) { - if( detected_sv_info[j].satellite_id == visible_gps[k].satellite_id ) + if( detected_sv_info[j].satellite_id == visible_svs_gps[k].satellite_id ) { - doppler_offsets[j].id = detected_sv_info[j].satellite_id; - doppler_offsets[j].doppler_offset = detected_sv_info[j].doppler - visible_gps[k].doppler; - doppler_offsets[j].almanac_age = visible_gps[k].doppler_error; + doppler_offsets[j].satellite_id = detected_sv_info[j].satellite_id; + doppler_offsets[j].doppler_offset = detected_sv_info[j].doppler - visible_svs_gps[k].doppler; + doppler_offsets[j].doppler_error = visible_svs_gps[k].doppler_error; /* Add doppler_offset to median calculation, if almanac is up-to-date */ - if( doppler_offsets[j].almanac_age == 0 ) + if( doppler_offsets[j].doppler_error == 0 ) { doppler_offsets_for_median[doppler_offsets_for_median_size] = ( int ) doppler_offsets[j].doppler_offset; @@ -594,16 +624,16 @@ bool smtc_gnss_get_doppler_error( const void* radio_context, const uint32_t date /* BEIDOU satellites */ if( constellations & LR11XX_GNSS_BEIDOU_MASK ) { - for( int k = 0; k < nb_visible_beidou_satellites; k++ ) + for( uint8_t k = 0; k < nb_visible_beidou_satellites; k++ ) { - if( detected_sv_info[j].satellite_id == visible_beidou[k].satellite_id ) + if( detected_sv_info[j].satellite_id == visible_svs_beidou[k].satellite_id ) { - doppler_offsets[j].id = detected_sv_info[j].satellite_id; - doppler_offsets[j].doppler_offset = detected_sv_info[j].doppler - visible_beidou[k].doppler; - doppler_offsets[j].almanac_age = visible_beidou[k].doppler_error; + doppler_offsets[j].satellite_id = detected_sv_info[j].satellite_id; + doppler_offsets[j].doppler_offset = detected_sv_info[j].doppler - visible_svs_beidou[k].doppler; + doppler_offsets[j].doppler_error = visible_svs_beidou[k].doppler_error; /* Add doppler_offset to median calculation, if almanac is up-to-date */ - if( doppler_offsets[j].almanac_age == 0 ) + if( doppler_offsets[j].doppler_error == 0 ) { doppler_offsets_for_median[doppler_offsets_for_median_size] = ( int ) doppler_offsets[j].doppler_offset; @@ -614,104 +644,114 @@ bool smtc_gnss_get_doppler_error( const void* radio_context, const uint32_t date } } - /* Compute the median doppler offset of SVs with updated almanacs */ - int median_offset = median( doppler_offsets_for_median_size, doppler_offsets_for_median ); - - /* Debug prints: TODO: add flag to disable/enable */ - GNSS_HELPERS_TRACE_PRINTF( "\nDetected satellites: %u\n", nb_detected_sv ); - GNSS_HELPERS_TRACE_PRINTF( "id | doppler | cnr\n" ); - GNSS_HELPERS_TRACE_PRINTF( "----|------------|--------------\n" ); - for( int i = 0; i < nb_detected_sv; i++ ) + if( doppler_offsets_for_median_size > 0 ) { - GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", detected_sv_info[i].satellite_id, - detected_sv_info[i].doppler, detected_sv_info[i].cnr ); - } + /* Compute the median doppler offset of SVs with updated almanacs */ + int median_offset = median( doppler_offsets_for_median_size, doppler_offsets_for_median ); - if( constellations & LR11XX_GNSS_GPS_MASK ) - { - GNSS_HELPERS_TRACE_PRINTF( "\nVisible GPS satellites: %u\n", nb_visible_gps_satellites ); - GNSS_HELPERS_TRACE_PRINTF( "id | doppler | almanac_age \n" ); + /* Debug prints */ +#if GNSS_HELPERS_DBG_TRACE == GNSS_HELPERS_FEATURE_ON + GNSS_HELPERS_TRACE_PRINTF( "\nDetected satellites: %u\n", nb_detected_sv ); + GNSS_HELPERS_TRACE_PRINTF( "id | doppler | cnr\n" ); GNSS_HELPERS_TRACE_PRINTF( "----|------------|--------------\n" ); - for( int i = 0; i < nb_visible_gps_satellites; i++ ) + for( uint8_t i = 0; i < nb_detected_sv; i++ ) { - GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", visible_gps[i].satellite_id, visible_gps[i].doppler, - visible_gps[i].doppler_error ); + GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", detected_sv_info[i].satellite_id, + detected_sv_info[i].doppler, detected_sv_info[i].cnr ); } - } - if( constellations & LR11XX_GNSS_BEIDOU_MASK ) - { - GNSS_HELPERS_TRACE_PRINTF( "\nVisible BEIDOU satellites: %u\n", nb_visible_beidou_satellites ); - GNSS_HELPERS_TRACE_PRINTF( "id | doppler | almanac_age \n" ); - GNSS_HELPERS_TRACE_PRINTF( "----|------------|--------------\n" ); - for( int i = 0; i < nb_visible_beidou_satellites; i++ ) + if( constellations & LR11XX_GNSS_GPS_MASK ) { - GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", visible_beidou[i].satellite_id, - visible_beidou[i].doppler, visible_beidou[i].doppler_error ); + GNSS_HELPERS_TRACE_PRINTF( "\nVisible GPS satellites: %u\n", nb_visible_gps_satellites ); + GNSS_HELPERS_TRACE_PRINTF( "id | doppler | almanac_age \n" ); + GNSS_HELPERS_TRACE_PRINTF( "----|------------|--------------\n" ); + for( uint8_t i = 0; i < nb_visible_gps_satellites; i++ ) + { + GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", visible_svs_gps[i].satellite_id, + visible_svs_gps[i].doppler, visible_svs_gps[i].doppler_error ); + } } - } - /* Get the current frequency search space configuration to determine threshold for acceptable doppler offset */ - lr11xx_gnss_freq_search_space_t freq_search_space; - int16_t offset_threshold; - status = lr11xx_gnss_read_freq_search_space( radio_context, &freq_search_space ); - if( status != LR11XX_STATUS_OK ) - { - MW_DBG_TRACE_ERROR( "Failed to read current freq search space\n" ); - return false; - } - switch( freq_search_space ) - { - case LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_250_HZ: - offset_threshold = 250; - break; - case LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_500_HZ: - offset_threshold = 500; - break; - case LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_1_KHZ: - offset_threshold = 1000; - break; - case LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_2_KHZ: - offset_threshold = 2000; - break; - default: - MW_DBG_TRACE_ERROR( "Unknown freq search space - %d\n", freq_search_space ); - return false; - } + if( constellations & LR11XX_GNSS_BEIDOU_MASK ) + { + GNSS_HELPERS_TRACE_PRINTF( "\nVisible BEIDOU satellites: %u\n", nb_visible_beidou_satellites ); + GNSS_HELPERS_TRACE_PRINTF( "id | doppler | almanac_age \n" ); + GNSS_HELPERS_TRACE_PRINTF( "----|------------|--------------\n" ); + for( uint8_t i = 0; i < nb_visible_beidou_satellites; i++ ) + { + GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d\n", visible_svs_beidou[i].satellite_id, + visible_svs_beidou[i].doppler, visible_svs_beidou[i].doppler_error ); + } + } +#endif - /* Check if there is at least 1 SV with doppler error (with almanac up-to-date) */ - int16_t offset_from_median; - bool doppler_error_sv; - bool doppler_error_ignored; - GNSS_HELPERS_TRACE_PRINTF( "\nDoppler offsets (median=%d):\n", median_offset ); - GNSS_HELPERS_TRACE_PRINTF( "id | offset | off-median | doppler_err\n" ); - GNSS_HELPERS_TRACE_PRINTF( "----|------------|------------|------------\n" ); - for( int i = 0; i < nb_detected_sv; i++ ) - { - offset_from_median = ABS( ( int16_t )( doppler_offsets[i].doppler_offset - median_offset ) ); - doppler_error_sv = ( offset_from_median > offset_threshold ) ? true : false; - doppler_error_ignored = ( doppler_offsets[i].almanac_age > 250 ) - ? true - : false; /* If almanac is too old for this SV, ignore doppler detected */ - if( doppler_error_ignored == true ) + /* Get the current frequency search space configuration to determine threshold for acceptable doppler offset */ + lr11xx_gnss_freq_search_space_t freq_search_space; + int16_t offset_threshold; + status = lr11xx_gnss_read_freq_search_space( radio_context, &freq_search_space ); + if( status != LR11XX_STATUS_OK ) + { + MW_DBG_TRACE_ERROR( "Failed to read current freq search space\n" ); + return false; + } + switch( freq_search_space ) + { + case LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_250_HZ: + offset_threshold = 250; + break; + case LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_500_HZ: + offset_threshold = 500; + break; + case LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_1_KHZ: + offset_threshold = 1000; + break; + case LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_2_KHZ: + offset_threshold = 2000; + break; + default: + MW_DBG_TRACE_ERROR( "Unknown freq search space - %d\n", freq_search_space ); + return false; + } + + /* Check if there is at least 1 SV with doppler error (with almanac up-to-date) */ + int16_t offset_from_median; + bool doppler_error_sv; + bool doppler_error_ignored; + GNSS_HELPERS_TRACE_PRINTF( "\nDoppler offsets (median=%d):\n", median_offset ); + GNSS_HELPERS_TRACE_PRINTF( "id | offset | off-median | doppler_err\n" ); + GNSS_HELPERS_TRACE_PRINTF( "----|------------|------------|------------\n" ); + for( uint8_t i = 0; i < nb_detected_sv; i++ ) { - doppler_error_sv = false; + offset_from_median = ABS( ( int16_t )( doppler_offsets[i].doppler_offset - median_offset ) ); + doppler_error_sv = ( offset_from_median > offset_threshold ) ? true : false; + doppler_error_ignored = ( doppler_offsets[i].doppler_error > 250 ) + ? true + : false; /* If almanac is too old for this SV, ignore doppler detected */ + if( doppler_error_ignored == true ) + { + doppler_error_sv = false; + } + GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d | %d %s\n", doppler_offsets[i].satellite_id, + doppler_offsets[i].doppler_offset, offset_from_median, doppler_error_sv, + ( doppler_error_ignored == true ) ? "(IGNORED)" : "" ); + + if( doppler_error_sv == true ) + { + /* Return doppler error status */ + *doppler_error = true; + /* TODO: break here if don't want to have details for all SVs */ + } } - GNSS_HELPERS_TRACE_PRINTF( "%-3u | %-10d | %-10d | %d %s\n", doppler_offsets[i].id, - doppler_offsets[i].doppler_offset, offset_from_median, doppler_error_sv, - ( doppler_error_ignored == true ) ? "(IGNORED)" : "" ); - if( doppler_error_sv == true ) + if( *doppler_error == true ) { - /* Return doppler error status */ - *doppler_error = true; - /* TODO: break here if don't want to have details for all SVs */ + MW_DBG_TRACE_WARNING( "Doppler error detected\n" ); } } - - if( *doppler_error == true ) + else { - MW_DBG_TRACE_WARNING( "Doppler error detected\n" ); + MW_DBG_TRACE_WARNING( "No almanac up-to-date to check for doppler error\n" ); + /* TODO: this could be a feedback to application to send an ALMANAC_STATUS DM */ } return true; @@ -908,14 +948,15 @@ static int median( int n, int x[] ) { int temp; int i, j; - // the following two loops sort the array x in ascending order + + /* sort the array x in ascending order */ for( i = 0; i < n - 1; i++ ) { for( j = i + 1; j < n; j++ ) { if( x[j] < x[i] ) { - // swap elements + /* swap elements */ temp = x[i]; x[i] = x[j]; x[j] = temp; @@ -925,12 +966,12 @@ static int median( int n, int x[] ) if( n % 2 == 0 ) { - // if there is an even number of elements, return mean of the two elements in the middle + /* if there is an even number of elements, return mean of the two elements in the middle */ return ( ( x[n / 2] + x[n / 2 - 1] ) / 2 ); } else { - // else return the element in the middle + /* else return the element in the middle */ return x[n / 2]; } } diff --git a/geolocation_middleware/gnss/src/gnss_helpers.h b/geolocation_middleware/gnss/src/gnss_helpers.h index 6f2fb5d..39ca2bd 100644 --- a/geolocation_middleware/gnss/src/gnss_helpers.h +++ b/geolocation_middleware/gnss/src/gnss_helpers.h @@ -167,7 +167,14 @@ bool smtc_gnss_get_sv_info( const void* radio_context, const uint8_t sv_info_max lr11xx_gnss_detected_satellite_t* sv_info ); /*! - * @brief TODO + * @brief Check almanac update status for visible satellites + * + * @param [in] radio_context Chip implementation context + * @param [in] date Current GPS time + * @param [in] assistance_position Current aiding position + * @param [in] constellations GNSS constellations to be checked + * @param [out] almanacs_update_required Boolean that indicates if at least 70% of visible satellites have their almanac + * not too old (less than 6 months for GPS, less that 8 months for Beidou). */ bool smtc_gnss_get_almanac_update_status( const void* radio_context, const uint32_t date, const lr11xx_gnss_solver_assistance_position_t* assistance_position, @@ -175,12 +182,16 @@ bool smtc_gnss_get_almanac_update_status( const void* radio_context, const uint3 bool* almanacs_update_required ); /*! - * @brief TODO - */ -bool smtc_gnss_get_doppler_error_from_nav( const uint8_t* nav ); - -/*! - * @brief TODO + * @brief Compute doppler error on detected satellites to detect aiding position error (to be used only of almanacs are + * not too old). + * + * @param [in] radio_context Chip implementation context + * @param [in] date Current GPS time + * @param [in] assistance_position Current aiding position + * @param [in] constellations GNSS constellations to be checked + * @param [in] nb_detected_sv Number of detected satellites + * @param [in] detected_sv_info Detected satellites information + * @param [out] doppler_error Boolean that indicates if doppler error has been detected. */ bool smtc_gnss_get_doppler_error( const void* radio_context, const uint32_t date, const lr11xx_gnss_solver_assistance_position_t* assistance_position, diff --git a/geolocation_middleware/gnss/src/gnss_helpers_defs.h b/geolocation_middleware/gnss/src/gnss_helpers_defs.h index 70d1f1c..5967b86 100644 --- a/geolocation_middleware/gnss/src/gnss_helpers_defs.h +++ b/geolocation_middleware/gnss/src/gnss_helpers_defs.h @@ -56,6 +56,8 @@ extern "C" { /*! * @brief Maximal number of Space Vehicles to search during a GNSS scan + * @note Autonomous scan: NAV2: 10 SV + 7 dopplers => 44 bytes + * @note Assisted scan: NAV2: 10 SV + 7 dopplers => 47 bytes */ #define GNSS_NB_SVS_MAX ( 10 ) diff --git a/geolocation_middleware/gnss/src/gnss_middleware.c b/geolocation_middleware/gnss/src/gnss_middleware.c index 7aca013..9e7e61a 100644 --- a/geolocation_middleware/gnss/src/gnss_middleware.c +++ b/geolocation_middleware/gnss/src/gnss_middleware.c @@ -118,12 +118,12 @@ #define SMTC_MODEM_EXTENDED_UPLINK_ID_GNSS 1 /** - * @brief TODO + * @brief GNSS latitude scaling factor */ #define LR11XX_GNSS_SCALING_LATITUDE 90 /** - * @brief TODO + * @brief GNSS longitude scaling factor */ #define LR11XX_GNSS_SCALING_LONGITUDE 180 @@ -154,7 +154,7 @@ typedef struct } gnss_mw_mode_desc_t; /** - * @brief TODO + * @brief The list of possible scan types */ typedef enum { @@ -207,7 +207,7 @@ static bool solver_aiding_position_update_received = false; static uint8_t solver_aiding_position_update[SOLVER_AIDING_POSITION_SIZE]; /*! - * @brief TODO + * @brief The current scan type selected */ static gnss_mw_scan_type_t current_scan_type = GNSS_MW_SCAN_TYPE_AUTONOMOUS; @@ -253,6 +253,8 @@ static uint8_t lorawan_port = GNSS_DEFAULT_UPLINK_PORT; */ static bool scan_aggregate = false; +static int nb_scan_aggregate = 0; + /*! * @brief Indicates sequence to "scan & send" or "scan only" mode */ @@ -276,22 +278,32 @@ static bool task_running = false; static gnss_mw_scan_context_t lr11xx_scan_context; /*! - * @brief TODO + * @brief The current Aiding Position Check (APC) message */ static uint8_t aid_pos_check_buffer[5 + GNSS_RESULT_SIZE_MAX_MODE3] = { 0 }; /* | TAG | 0x00 | LAT/LON | NAV | */ /*! - * @brief TODO + * @brief The size of the current Aiding Position Check (APC) message + */ +static uint8_t aid_pos_check_size; + +/*! + * @brief Statistics variables */ static uint8_t stat_nb_scans_sent_within_current_scan_group = 0; static bool stat_aiding_position_check_sent = false; static bool stat_indoor_detected = false; /*! - * @brief TODO + * @brief Flag to indicate if an autonomous scan for indoor check was launched */ static bool autonomous_scan_for_indoor_check = false; +/*! + * @brief GNSS scan results storage + */ +static gnss_scan_t scan_results; + /* * ----------------------------------------------------------------------------- * --- PRIVATE FUNCTIONS DECLARATION ------------------------------------------- @@ -307,7 +319,7 @@ static bool autonomous_scan_for_indoor_check = false; static smtc_modem_return_code_t gnss_mw_scan_next( uint32_t delay_s ); /*! - * @brief TODO + * @brief Get next scan delay */ static uint32_t gnss_mw_get_next_scan_delay( void ); @@ -332,11 +344,11 @@ static void gnss_mw_scan_rp_task_done( smtc_modem_rp_status_t* status ); * update if necessary. * * @param [in] current_assistance_position The current aiding position configured + * @param [in] scan The scan result to be appended with APC message (if any) * - * @return a boolean set to true for success, false otherwise */ -static bool gnss_mw_send_aiding_position_check_request( - const lr11xx_gnss_solver_assistance_position_t* current_assistance_position, gnss_scan_t* scan ); +static void gnss_mw_prepare_apc_msg( const lr11xx_gnss_solver_assistance_position_t* current_assistance_position, + gnss_scan_t* scan ); /*! * @brief Callback called by the LBM when the uplink has been sent. Pop the next result ot be sent until the scan group @@ -454,6 +466,9 @@ mw_return_code_t gnss_mw_scan_start( gnss_mw_mode_t mode, uint32_t start_delay ) stat_aiding_position_check_sent = false; stat_indoor_detected = false; + /* Reset APC message */ + aid_pos_check_size = 0; + /* Switch back to assisted if previous scan was for aiding position request */ if( current_scan_type == GNSS_MW_SCAN_TYPE_ASSISTED_FOR_AIDING_POSITION ) { @@ -584,6 +599,9 @@ mw_return_code_t gnss_mw_get_event_data_scan_done( gnss_mw_event_data_scan_done_ data->context.aiding_position_longitude = lr11xx_scan_context.aiding_position_longitude; data->context.almanac_crc = lr11xx_scan_context.almanac_crc; data->context.almanac_update_required = lr11xx_scan_context.almanac_update_required; + data->indoor_detected = stat_indoor_detected; + data->aiding_position_check_size = aid_pos_check_size; + data->aiding_position_check_msg = aid_pos_check_buffer; return MW_RC_OK; } @@ -610,7 +628,10 @@ void gnss_mw_set_constellations( gnss_mw_constellation_t constellations ) } } -void gnss_mw_set_port( uint8_t port ) { lorawan_port = port; } +void gnss_mw_set_port( uint8_t port ) +{ + lorawan_port = port; +} void gnss_mw_scan_aggregate( bool aggregate ) { @@ -618,6 +639,11 @@ void gnss_mw_scan_aggregate( bool aggregate ) /* Set scan aggregation current mode */ scan_aggregate = aggregate; + + if( aggregate == false ) + { + nb_scan_aggregate = 0; + } } void gnss_mw_send_bypass( bool no_send ) @@ -663,6 +689,26 @@ void gnss_mw_display_results( const gnss_mw_event_data_scan_done_t* data ) } MW_DBG_TRACE_PRINTF( "-- almanac CRC: 0X%08X\n", data->context.almanac_crc ); MW_DBG_TRACE_PRINTF( "-- almanac update required: %d\n", data->context.almanac_update_required ); + MW_DBG_TRACE_PRINTF( "-- indoor detected: %d\n", data->indoor_detected ); + if( data->aiding_position_check_size > 0 ) + { + MW_DBG_TRACE_PRINTF( "-- APC (%u): ", data->aiding_position_check_size ); + for( i = 0; i < data->aiding_position_check_size; i++ ) + { + MW_DBG_TRACE_PRINTF( "%02X", data->aiding_position_check_msg[i] ); + } + MW_DBG_TRACE_PRINTF( "\n" ); + } + } +} + +void gnss_mw_display_terminated_results( const gnss_mw_event_data_terminated_t* data ) +{ + if( data != NULL ) + { + MW_DBG_TRACE_PRINTF( "TERMINATED info:\n" ); + MW_DBG_TRACE_PRINTF( "-- number of scans sent: %u\n", data->nb_scans_sent ); + MW_DBG_TRACE_PRINTF( "-- APC message sent: %d\n", data->aiding_position_check_sent ); } } @@ -678,7 +724,6 @@ mw_return_code_t gnss_mw_get_event_data_terminated( gnss_mw_event_data_terminate { data->nb_scans_sent = stat_nb_scans_sent_within_current_scan_group; data->aiding_position_check_sent = stat_aiding_position_check_sent; - data->indoor_detected = stat_indoor_detected; return MW_RC_OK; } else @@ -688,7 +733,10 @@ mw_return_code_t gnss_mw_get_event_data_terminated( gnss_mw_event_data_terminate } } -void gnss_mw_clear_pending_events( void ) { pending_events = 0; } +void gnss_mw_clear_pending_events( void ) +{ + pending_events = 0; +} mw_return_code_t gnss_mw_handle_downlink( uint8_t port, const uint8_t* payload, uint8_t size ) { @@ -834,24 +882,20 @@ static void gnss_mw_scan_rp_task_launch( void* context ) case GNSS_MW_SCAN_TYPE_AUTONOMOUS: scan_params.assisted = false; scan_params.freq_search_space = LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_250_HZ; /* not used */ - scan_params.input_parameters = LR11XX_GNSS_RESULTS_DOPPLER_MASK + - LR11XX_GNSS_RESULTS_DOPPLER_ENABLE_MASK; /* 14 dopplers max, no bit change */ - scan_params.nb_svs_max = - 9; /* NAV2: 9 SV + 9 dopplers => 44 bytes (reduce nb SV to keep space for APC message)*/ + scan_params.input_parameters = LR11XX_GNSS_RESULTS_DOPPLER_ENABLE_MASK; /* 7 dopplers max, no bit change */ + scan_params.nb_svs_max = GNSS_NB_SVS_MAX; break; case GNSS_MW_SCAN_TYPE_ASSISTED: scan_params.assisted = true; scan_params.freq_search_space = LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_250_HZ; - scan_params.input_parameters = 0; /* no dopplers, no bit change */ + scan_params.input_parameters = LR11XX_GNSS_RESULTS_DOPPLER_ENABLE_MASK; /* 7 dopplers max, no bit change */ scan_params.nb_svs_max = GNSS_NB_SVS_MAX; break; case GNSS_MW_SCAN_TYPE_ASSISTED_FOR_AIDING_POSITION: scan_params.assisted = true; scan_params.freq_search_space = LR11XX_GNSS_FREQUENCY_SEARCH_SPACE_2_KHZ; - scan_params.input_parameters = LR11XX_GNSS_RESULTS_DOPPLER_MASK + - LR11XX_GNSS_RESULTS_DOPPLER_ENABLE_MASK; /* 14 dopplers max, no bit change */ - scan_params.nb_svs_max = - 9; /* NAV2: 9 SV + 9 dopplers => 47 bytes (reduce nb SV to keep payload under 50 bytes) */ + scan_params.input_parameters = LR11XX_GNSS_RESULTS_DOPPLER_ENABLE_MASK; /* 7 dopplers max, no bit change */ + scan_params.nb_svs_max = GNSS_NB_SVS_MAX; break; default: break; @@ -961,7 +1005,6 @@ void gnss_mw_scan_rp_task_done( smtc_modem_rp_status_t* status ) } else if( irq_status == SMTC_RP_RADIO_GNSS_SCAN_DONE ) { - gnss_scan_t scan_results = { 0 }; smtc_gnss_get_results_return_code_t scan_results_rc; bool scan_results_no_sv = false; bool doppler_error = false; @@ -972,6 +1015,7 @@ void gnss_mw_scan_rp_task_done( smtc_modem_rp_status_t* status ) current_assistance_position.longitude = lr11xx_scan_context.aiding_position_longitude; /* Get scan results from LR1110 */ + memset( &scan_results, 0, sizeof scan_results ); scan_results.timestamp = mw_get_gps_time( ); scan_results_rc = smtc_gnss_get_results( modem_radio_ctx->ral.context, GNSS_RESULT_SIZE_MAX_MODE3, &scan_results.results_size, @@ -997,14 +1041,34 @@ void gnss_mw_scan_rp_task_done( smtc_modem_rp_status_t* status ) { /* If NO SATELLITES has been detected, we consider the device is indoor */ stat_indoor_detected = true; + gnss_mw_send_event( GNSS_MW_EVENT_SCAN_DONE ); gnss_mw_send_event( GNSS_MW_EVENT_TERMINATED ); } else { - /* The autonomous scan detected some SVs but not enough to generate a NAV, so send an aiding - * position check uplink */ - stat_aiding_position_check_sent = true; - gnss_mw_send_aiding_position_check_request( ¤t_assistance_position, &scan_results ); + /* Prepare APC message */ + gnss_mw_prepare_apc_msg( ¤t_assistance_position, &scan_results ); + + /* Send an event to application for scan results */ + gnss_mw_send_event( GNSS_MW_EVENT_SCAN_DONE ); + + if( send_bypass == true ) + { + /* Send an event to application to notify for completion */ + gnss_mw_send_event( GNSS_MW_EVENT_TERMINATED ); + } + else + { + /* Send uplink */ + if( gnss_mw_send_frame( aid_pos_check_buffer, aid_pos_check_size, lorawan_port ) == false ) + { + MW_DBG_TRACE_ERROR( "Failed to send uplink for APC frame\n" ); + } + else + { + stat_aiding_position_check_sent = true; + } + } } } else @@ -1024,10 +1088,9 @@ void gnss_mw_scan_rp_task_done( smtc_modem_rp_status_t* status ) if( ( scan_results.detected_svs > 0 ) && ( current_scan_type != GNSS_MW_SCAN_TYPE_AUTONOMOUS ) && ( lr11xx_scan_context.almanac_update_required == false ) ) { - smtc_gnss_get_doppler_error( - modem_radio_ctx->ral.context, lr11xx_scan_context.gps_time, ¤t_assistance_position, - current_constellations, scan_results.detected_svs, scan_results.info_svs, - &doppler_error ); /* TODO: need to add constellations to scan context */ + smtc_gnss_get_doppler_error( modem_radio_ctx->ral.context, lr11xx_scan_context.gps_time, + ¤t_assistance_position, current_constellations, + scan_results.detected_svs, scan_results.info_svs, &doppler_error ); } if( ( doppler_error == true ) && @@ -1065,8 +1128,27 @@ void gnss_mw_scan_rp_task_done( smtc_modem_rp_status_t* status ) } else { - /* All scans in the group have been completed, send an event to application */ - gnss_mw_send_event( GNSS_MW_EVENT_SCAN_DONE ); + /* Increment scan group token if valid and not aggregated */ + if( gnss_scan_group_queue_is_valid( &gnss_scan_group_queue ) ) + { + if( scan_aggregate == false ) + { + gnss_scan_group_queue_increment_token( &gnss_scan_group_queue ); + } + else + { + /* Increment token for the first group of the aggregated groups */ + if( nb_scan_aggregate == 0 ) + { + gnss_scan_group_queue_increment_token( &gnss_scan_group_queue ); + nb_scan_aggregate += 1; + } + } + } + else + { + MW_DBG_TRACE_PRINTF( "Scan group is not valid, do not increment token\n" ); + } /* Send results */ /* static variables because there is no copy done by LBM for extended send API */ @@ -1081,11 +1163,12 @@ void gnss_mw_scan_rp_task_done( smtc_modem_rp_status_t* status ) * position check */ autonomous_scan_for_indoor_check = true; MW_ASSERT_SMTC_MODEM_RC( gnss_mw_scan_next( 0 ) ); - /* TODO: if current scan was an autonomous one, we could avoid this last one for indoor - * check */ } else { + /* All scans in the group have been completed, send an event to application */ + gnss_mw_send_event( GNSS_MW_EVENT_SCAN_DONE ); + /* Check if "no send "mode" is configured */ if( send_bypass == true ) { @@ -1152,14 +1235,14 @@ void gnss_mw_scan_rp_task_done( smtc_modem_rp_status_t* status ) mw_radio_set_sleep( modem_radio_ctx->ral.context ); } -static bool gnss_mw_send_aiding_position_check_request( - const lr11xx_gnss_solver_assistance_position_t* current_assistance_position, gnss_scan_t* scan ) +static void gnss_mw_prepare_apc_msg( const lr11xx_gnss_solver_assistance_position_t* current_assistance_position, + gnss_scan_t* scan ) { - bool success = false; const int16_t latitude = ( ( current_assistance_position->latitude * 2048 ) / LR11XX_GNSS_SCALING_LATITUDE ); const int16_t longitude = ( ( current_assistance_position->longitude * 2048 ) / LR11XX_GNSS_SCALING_LONGITUDE ); - /* Prepare buffer for request */ + /* Prepare buffer for APC message */ + aid_pos_check_size = 5; /* | TAG (8b) | 0x00 | LatLSB (8b) | LonLSB (4b) LatMSB (4b) | LonMSB (8b) | */ aid_pos_check_buffer[0] = ( scan->detected_svs > 0 ) ? 0x01 : 0x00; /* TAG */ aid_pos_check_buffer[1] = 0x00; /* Extension marker */ @@ -1175,19 +1258,8 @@ static bool gnss_mw_send_aiding_position_check_request( /* The number of SV max has been limited for autonomous scan in order to keep the complete buffer below 51 bytes */ memcpy( &aid_pos_check_buffer[5], &( scan->results_buffer[GNSS_SCAN_METADATA_SIZE] ), scan->results_size ); + aid_pos_check_size += scan->results_size; } - - /* Send uplink */ - if( gnss_mw_send_frame( aid_pos_check_buffer, 5 + scan->results_size, lorawan_port ) == true ) - { - success = true; - } - else - { - MW_DBG_TRACE_ERROR( "Failed to send aiding position request uplink frame\n" ); - } - - return success; } static void gnss_mw_tx_done_callback( void ) @@ -1271,15 +1343,6 @@ static void gnss_mw_send_event( gnss_mw_event_type_t event_type ) task_running = false; } - /* Increment the token on SCAN_DONE if the scan group is valid (and no aggregate) */ - if( event_type == GNSS_MW_EVENT_SCAN_DONE ) - { - if( ( scan_aggregate == false ) && ( gnss_scan_group_queue_is_valid( &gnss_scan_group_queue ) ) ) - { - gnss_scan_group_queue_increment_token( &gnss_scan_group_queue ); - } - } - /* Send the event to the application */ pending_events = pending_events | ( 1 << event_type ); MW_ASSERT_SMTC_MODEM_RC( smtc_modem_increment_event_middleware( SMTC_MODEM_EVENT_MIDDLEWARE_1, pending_events ) ); diff --git a/geolocation_middleware/gnss/src/gnss_middleware.h b/geolocation_middleware/gnss/src/gnss_middleware.h index 4a5593a..7b143e5 100644 --- a/geolocation_middleware/gnss/src/gnss_middleware.h +++ b/geolocation_middleware/gnss/src/gnss_middleware.h @@ -153,6 +153,9 @@ typedef struct gnss_mw_event_data_scan_desc_t scans[GNSS_SCAN_GROUP_SIZE_MAX]; //!< Descriptions of all scan results uint32_t power_consumption_uah; //!< Power consumption induced by this scan group gnss_mw_scan_context_t context; //!< Configuration context used for this scan + bool indoor_detected; //!< Indicates if an indoor detection occurred (in case aiding position check was enabled) + uint8_t* aiding_position_check_msg; //!< APC message buffer + uint8_t aiding_position_check_size; //!< APC message buffer size in bytes } gnss_mw_event_data_scan_done_t; /** @@ -161,8 +164,7 @@ typedef struct typedef struct { uint8_t nb_scans_sent; //!< Number of scans which have been sent over the air - bool aiding_position_check_sent; //!< Indicates if an aiding position check uplink has been sent - bool indoor_detected; //!< Indicates if an indoor detection occurred (in case aiding position check was enabled) + bool aiding_position_check_sent; //!< Indicates if an APC message has been sent over the air } gnss_mw_event_data_terminated_t; /* @@ -312,6 +314,13 @@ void gnss_mw_send_bypass( bool no_send ); */ void gnss_mw_display_results( const gnss_mw_event_data_scan_done_t* data ); +/** + * @brief Print the results of the GNSS_MW_EVENT_TERMINATED event + * + * @param [in] data Sequence results to be printed on the console + */ +void gnss_mw_display_terminated_results( const gnss_mw_event_data_terminated_t* data ); + /** * @brief Parse downlink message, and handle it if it targets the GNSS middleware. * diff --git a/geolocation_middleware/gnss/src/gnss_version.h b/geolocation_middleware/gnss/src/gnss_version.h index 61021ad..8b7b092 100644 --- a/geolocation_middleware/gnss/src/gnss_version.h +++ b/geolocation_middleware/gnss/src/gnss_version.h @@ -56,7 +56,7 @@ extern "C" { * --- PUBLIC TYPES ------------------------------------------------------------ */ #define GNSS_MW_VERSION_MAJOR 2 -#define GNSS_MW_VERSION_MINOR 0 +#define GNSS_MW_VERSION_MINOR 1 #define GNSS_MW_VERSION_PATCH 0 /* diff --git a/geolocation_middleware/gnss/src/lr11xx_driver_extension.c b/geolocation_middleware/gnss/src/lr11xx_driver_extension.c deleted file mode 100644 index baa7689..0000000 --- a/geolocation_middleware/gnss/src/lr11xx_driver_extension.c +++ /dev/null @@ -1,179 +0,0 @@ -/*! - * @file lr11xx_driver_extension.c - * - * @brief driver extension implementation for LR11XX - * - * The Clear BSD License - * Copyright Semtech Corporation 2021. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted (subject to the limitations in the disclaimer - * below) provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * * Neither the name of the Semtech corporation nor the - * names of its contributors may be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY - * THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND - * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT - * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ - -/* - * ----------------------------------------------------------------------------- - * --- DEPENDENCIES ------------------------------------------------------------ - */ - -#include "lr11xx_hal.h" -#include "lr11xx_driver_extension.h" - -/* - * ----------------------------------------------------------------------------- - * --- PRIVATE MACROS----------------------------------------------------------- - */ - -/* - * ----------------------------------------------------------------------------- - * --- PRIVATE CONSTANTS ------------------------------------------------------- - */ - -#define LR11XX_GNSS_SET_FREQ_SEARCH_SPACE_CMD_LENGTH ( 2 + 1 ) -#define LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_CMD_LENGTH ( 2 ) -#define LR11XX_GNSS_GET_SV_VISIBLE_CMD_LENGTH ( 2 + 9 ) -#define LR11XX_GNSS_GET_SV_VISIBLE_DOPPLER_CMD_LENGTH ( 2 ) - -#define LR11XX_GNSS_SCALING_LATITUDE 90 -#define LR11XX_GNSS_SCALING_LONGITUDE 180 - -/* - * ----------------------------------------------------------------------------- - * --- PRIVATE TYPES ----------------------------------------------------------- - */ - -/*! - * @brief Operating codes for GNSS-related operations - */ -enum -{ - LR11XX_GNSS_SET_FREQ_SEARCH_SPACE_OC = 0x0404, //!< Set the frequency search space - LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_OC = 0x0405, //!< Read the frequency search space - LR11XX_GNSS_GET_SV_VISIBLE_OC = 0x041F, //!< Get the number of visible SV from a date and a position - LR11XX_GNSS_GET_SV_VISIBLE_DOPPLER_OC = 0x0420, //!< Get visible SV ID and corresponding doppler value -}; - -/* - * ----------------------------------------------------------------------------- - * --- PRIVATE VARIABLES ------------------------------------------------------- - */ - -/* - * ----------------------------------------------------------------------------- - * --- PRIVATE FUNCTIONS DECLARATION ------------------------------------------- - */ - -/* - * ----------------------------------------------------------------------------- - * --- PUBLIC FUNCTIONS DEFINITION --------------------------------------------- - */ - -lr11xx_status_t lr11xx_gnss_set_freq_search_space( const void* radio, - const lr11xx_gnss_freq_search_space_t freq_search_space ) -{ - const uint8_t cbuffer[LR11XX_GNSS_SET_FREQ_SEARCH_SPACE_CMD_LENGTH] = { - ( uint8_t )( LR11XX_GNSS_SET_FREQ_SEARCH_SPACE_OC >> 8 ), - ( uint8_t )( LR11XX_GNSS_SET_FREQ_SEARCH_SPACE_OC >> 0 ), - ( uint8_t ) freq_search_space, - }; - - return ( lr11xx_status_t ) lr11xx_hal_write( radio, cbuffer, LR11XX_GNSS_SET_FREQ_SEARCH_SPACE_CMD_LENGTH, 0, 0 ); -} - -lr11xx_status_t lr11xx_gnss_read_freq_search_space( const void* radio, - lr11xx_gnss_freq_search_space_t* freq_search_space ) -{ - const uint8_t cbuffer[LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_CMD_LENGTH] = { - ( uint8_t )( LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_OC >> 8 ), - ( uint8_t )( LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_OC >> 0 ), - }; - - return ( lr11xx_status_t ) lr11xx_hal_read( radio, cbuffer, LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_CMD_LENGTH, - ( uint8_t* ) freq_search_space, sizeof( uint8_t ) ); -} - -lr11xx_status_t lr11xx_gnss_get_nb_visible_satellites( - const void* context, const lr11xx_gnss_date_t date, - const lr11xx_gnss_solver_assistance_position_t* assistance_position, - const lr11xx_gnss_constellation_t constellation, uint8_t* nb_visible_sv ) -{ - const int16_t latitude = ( ( assistance_position->latitude * 2048 ) / LR11XX_GNSS_SCALING_LATITUDE ); - const int16_t longitude = ( ( assistance_position->longitude * 2048 ) / LR11XX_GNSS_SCALING_LONGITUDE ); - const uint8_t cbuffer[LR11XX_GNSS_GET_SV_VISIBLE_CMD_LENGTH] = { - ( uint8_t )( LR11XX_GNSS_GET_SV_VISIBLE_OC >> 8 ), - ( uint8_t )( LR11XX_GNSS_GET_SV_VISIBLE_OC >> 0 ), - ( uint8_t )( date >> 24 ), - ( uint8_t )( date >> 16 ), - ( uint8_t )( date >> 8 ), - ( uint8_t )( date >> 0 ), - ( uint8_t )( latitude >> 8 ), - ( uint8_t )( latitude >> 0 ), - ( uint8_t )( longitude >> 8 ), - ( uint8_t )( longitude >> 0 ), - ( uint8_t )( constellation - 1 ), - }; - - return ( lr11xx_status_t ) lr11xx_hal_read( context, cbuffer, LR11XX_GNSS_GET_SV_VISIBLE_CMD_LENGTH, nb_visible_sv, - 1 ); -} - -lr11xx_status_t lr11xx_gnss_get_visible_satellites( const void* context, const uint8_t nb_visible_satellites, - lr11xx_gnss_visible_satellite_t* visible_satellite_id_doppler ) -{ - uint8_t result_buffer[12 * 5] = { 0 }; - const uint16_t read_size = nb_visible_satellites * 5; - - const uint8_t cbuffer[LR11XX_GNSS_GET_SV_VISIBLE_DOPPLER_CMD_LENGTH] = { - ( uint8_t )( LR11XX_GNSS_GET_SV_VISIBLE_DOPPLER_OC >> 8 ), - ( uint8_t )( LR11XX_GNSS_GET_SV_VISIBLE_DOPPLER_OC >> 0 ), - }; - - const lr11xx_hal_status_t hal_status = - lr11xx_hal_read( context, cbuffer, LR11XX_GNSS_GET_SV_VISIBLE_DOPPLER_CMD_LENGTH, result_buffer, read_size ); - - if( hal_status == LR11XX_HAL_STATUS_OK ) - { - for( uint8_t index_satellite = 0; index_satellite < nb_visible_satellites; index_satellite++ ) - { - const uint16_t local_result_buffer_index = index_satellite * 5; - lr11xx_gnss_visible_satellite_t* local_satellite_result = &visible_satellite_id_doppler[index_satellite]; - - local_satellite_result->satellite_id = result_buffer[local_result_buffer_index]; - local_satellite_result->doppler = ( int16_t )( ( result_buffer[local_result_buffer_index + 1] << 8 ) + - ( result_buffer[local_result_buffer_index + 2] << 0 ) ); - local_satellite_result->doppler_error = - ( int16_t )( ( result_buffer[local_result_buffer_index + 3] << 8 ) + - ( result_buffer[local_result_buffer_index + 4] << 0 ) ); - } - } - - return ( lr11xx_status_t ) hal_status; -} - -/* - * ----------------------------------------------------------------------------- - * --- PRIVATE FUNCTIONS DEFINITION -------------------------------------------- - */ - -/* --- EOF ------------------------------------------------------------------ */ \ No newline at end of file diff --git a/geolocation_middleware/gnss/src/lr11xx_driver_extension.h b/geolocation_middleware/gnss/src/lr11xx_driver_extension.h deleted file mode 100644 index c81b114..0000000 --- a/geolocation_middleware/gnss/src/lr11xx_driver_extension.h +++ /dev/null @@ -1,140 +0,0 @@ -/*! - * @file lr11xx_driver_extension.h - * - * @brief driver extension for LR11XX - * - * The Clear BSD License - * Copyright Semtech Corporation 2021. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted (subject to the limitations in the disclaimer - * below) provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * * Neither the name of the Semtech corporation nor the - * names of its contributors may be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY - * THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND - * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT - * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ - -#ifndef LR11XX_DRIVER_EXTENSION_H -#define LR11XX_DRIVER_EXTENSION_H - -#ifdef __cplusplus -extern "C" { -#endif - -/* - * ----------------------------------------------------------------------------- - * --- DEPENDENCIES ------------------------------------------------------------ - */ - -#include "lr11xx_types.h" -#include "lr11xx_gnss_types.h" - -/* - * ----------------------------------------------------------------------------- - * --- PUBLIC MACROS ----------------------------------------------------------- - */ - -/* - * ----------------------------------------------------------------------------- - * --- PUBLIC CONSTANTS -------------------------------------------------------- - */ - -/* - * ----------------------------------------------------------------------------- - * --- PUBLIC TYPES ------------------------------------------------------------ - */ - -/*! - * @brief Structure for information about visible SV - */ -typedef struct lr11xx_gnss_visible_satellite_s -{ - lr11xx_gnss_satellite_id_t satellite_id; //!< SV ID - int16_t doppler; //!< SV doppler in Hz - int16_t doppler_error; //!< SV doppler error - step of 125Hz -} lr11xx_gnss_visible_satellite_t; - -/* - * ----------------------------------------------------------------------------- - * --- PUBLIC FUNCTIONS PROTOTYPES --------------------------------------------- - */ - -/*! - * @brief Function to read the frequency search space around the Doppler frequency - * - * @param [in] radio Radio abstraction - * @param [out] freq_search_space Frequency search space configuration read from the chip - * - * @returns Operation status - */ -lr11xx_status_t lr11xx_gnss_read_freq_search_space( const void* radio, - lr11xx_gnss_freq_search_space_t* freq_search_space ); - -/*! - * @brief Function to set the frequency search space around the Doppler frequency - * - * @param [in] radio Radio abstraction - * @param [in] freq_search_space Frequency search space configuration to be applied - * - * @returns Operation status - */ -lr11xx_status_t lr11xx_gnss_set_freq_search_space( const void* radio, - const lr11xx_gnss_freq_search_space_t freq_search_space ); - -/** - * @brief Return the theoretical number of visible satellites based on the given parameters. - * - * @param [in] context Chip implementation context - * @param [in] date The actual date of scan. Its format is the number of seconds elapsed since January the 6th 1980 - * 00:00:00 with leap seconds included. - * @param [in] assistance_position, latitude 12 bits and longitude 12 bits - * @param [in] constellation Bit mask of the constellations to use. See @ref lr11xx_gnss_constellation_t for - * the possible values - * @param [out] nb_visible_sv thoeretical number of visible satellites - * - * @returns Operation status - */ -lr11xx_status_t lr11xx_gnss_get_nb_visible_satellites( - const void* context, const lr11xx_gnss_date_t date, - const lr11xx_gnss_solver_assistance_position_t* assistance_position, - const lr11xx_gnss_constellation_t constellation, uint8_t* nb_visible_sv ); - -/** - * @brief Return the doppler information of theoretical visible satellites, this function shall be called after - * lr11xx_gnss_get_nb_visible_satellites function. - * - * @param [in] context Chip implementation context - * @param [in] nb_visible_satellites number of visible satellites returned by lr11xx_gnss_get_nb_visible_satellites - * function, - * @param [out] visible_satellite_id_doppler Doppler information of each satellite. - * - * @returns Operation status - */ -lr11xx_status_t lr11xx_gnss_get_visible_satellites( const void* context, const uint8_t nb_visible_satellites, - lr11xx_gnss_visible_satellite_t* visible_satellite_id_doppler ); - -#ifdef __cplusplus -} -#endif - -#endif // LR11XX_DRIVER_EXTENSION_H - -/* --- EOF ------------------------------------------------------------------ */ \ No newline at end of file diff --git a/geolocation_middleware/wifi/src/wifi_helpers.c b/geolocation_middleware/wifi/src/wifi_helpers.c index ac03443..c1553ba 100644 --- a/geolocation_middleware/wifi/src/wifi_helpers.c +++ b/geolocation_middleware/wifi/src/wifi_helpers.c @@ -74,6 +74,8 @@ static wifi_settings_t settings = { 0 }; * --- PRIVATE VARIABLES ------------------------------------------------------- */ +static lr11xx_wifi_basic_complete_result_t wifi_results_mac_addr[WIFI_MAX_RESULTS]; + /* * ----------------------------------------------------------------------------- * --- PRIVATE FUNCTIONS DECLARATION ------------------------------------------- @@ -141,11 +143,12 @@ void smtc_wifi_scan_ended( void ) bool smtc_wifi_get_results( const void* radio_context, wifi_scan_all_result_t* wifi_results ) { - lr11xx_wifi_basic_complete_result_t wifi_results_mac_addr[WIFI_MAX_RESULTS] = { 0 }; - uint8_t nb_results; - uint8_t max_nb_results; - uint8_t result_index = 0; - lr11xx_status_t status = LR11XX_STATUS_OK; + uint8_t nb_results; + uint8_t max_nb_results; + uint8_t result_index = 0; + lr11xx_status_t status = LR11XX_STATUS_OK; + + memset( wifi_results_mac_addr, 0, sizeof wifi_results_mac_addr ); status = lr11xx_wifi_get_nb_results( radio_context, &nb_results ); if( status != LR11XX_STATUS_OK ) diff --git a/geolocation_middleware/wifi/src/wifi_middleware.c b/geolocation_middleware/wifi/src/wifi_middleware.c index 7f5d72b..ef0e073 100644 --- a/geolocation_middleware/wifi/src/wifi_middleware.c +++ b/geolocation_middleware/wifi/src/wifi_middleware.c @@ -436,7 +436,10 @@ mw_return_code_t wifi_mw_get_event_data_scan_done( wifi_mw_event_data_scan_done_ } } -void wifi_mw_set_port( uint8_t port ) { lorawan_port = port; } +void wifi_mw_set_port( uint8_t port ) +{ + lorawan_port = port; +} void wifi_mw_send_bypass( bool no_send ) { @@ -446,7 +449,10 @@ void wifi_mw_send_bypass( bool no_send ) send_bypass = no_send; } -void wifi_mw_set_payload_format( wifi_mw_payload_format_t format ) { payload_format = format; } +void wifi_mw_set_payload_format( wifi_mw_payload_format_t format ) +{ + payload_format = format; +} void wifi_mw_display_results( const wifi_mw_event_data_scan_done_t* data ) { @@ -500,7 +506,19 @@ mw_return_code_t wifi_mw_get_event_data_terminated( wifi_mw_event_data_terminate } } -void wifi_mw_clear_pending_events( void ) { pending_events = 0; } +void wifi_mw_display_terminated_results( const wifi_mw_event_data_terminated_t* data ) +{ + if( data != NULL ) + { + MW_DBG_TRACE_PRINTF( "TERMINATED info:\n" ); + MW_DBG_TRACE_PRINTF( "-- number of scans sent: %u\n", data->nb_scans_sent ); + } +} + +void wifi_mw_clear_pending_events( void ) +{ + pending_events = 0; +} /* * ----------------------------------------------------------------------------- @@ -687,7 +705,10 @@ static bool wifi_mw_send_results( void ) return true; } -static void wifi_mw_reset_results( void ) { memset( &wifi_results, 0, sizeof wifi_results ); } +static void wifi_mw_reset_results( void ) +{ + memset( &wifi_results, 0, sizeof wifi_results ); +} static void wifi_mw_tx_done_callback( void ) { diff --git a/geolocation_middleware/wifi/src/wifi_middleware.h b/geolocation_middleware/wifi/src/wifi_middleware.h index 8c31122..de9b517 100644 --- a/geolocation_middleware/wifi/src/wifi_middleware.h +++ b/geolocation_middleware/wifi/src/wifi_middleware.h @@ -225,6 +225,13 @@ void wifi_mw_set_payload_format( wifi_mw_payload_format_t format ); */ void wifi_mw_display_results( const wifi_mw_event_data_scan_done_t* data ); +/** + * @brief Print the results of the WIFI_MW_EVENT_TERMINATED event + * + * @param [in] data Sequence results to be printed on the console + */ +void wifi_mw_display_terminated_results( const wifi_mw_event_data_terminated_t* data ); + #ifdef __cplusplus } #endif diff --git a/geolocation_middleware/wifi/src/wifi_version.h b/geolocation_middleware/wifi/src/wifi_version.h index 929a111..7937640 100644 --- a/geolocation_middleware/wifi/src/wifi_version.h +++ b/geolocation_middleware/wifi/src/wifi_version.h @@ -56,7 +56,7 @@ extern "C" { * --- PUBLIC TYPES ------------------------------------------------------------ */ #define WIFI_MW_VERSION_MAJOR 2 -#define WIFI_MW_VERSION_MINOR 0 +#define WIFI_MW_VERSION_MINOR 1 #define WIFI_MW_VERSION_PATCH 0 /* diff --git a/lora_basics_modem/lora_basics_modem/CHANGELOG.md b/lora_basics_modem/lora_basics_modem/CHANGELOG.md index c6fb7f4..5580907 100644 --- a/lora_basics_modem/lora_basics_modem/CHANGELOG.md +++ b/lora_basics_modem/lora_basics_modem/CHANGELOG.md @@ -4,6 +4,38 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [v3.3.0] 2023-05-31 + +### Added + +* [general] Support of LR1121 radio (target: lr1121) +* [makefile] Provide a way to change any LBM define values in make command (use `EXTRAFLAGS` ) +* [utilities] Add a porting on NUCLEO-L073 board using LL drivers for minimal flash usage +* [utilities] Add a porting tool in main examples to help during mcu porting + +### Changed + +* [lr11xx_driver] Update to version `v2.3.0` +* [sx126x_driver] Update to version `v2.2.0` +* [makefile] Default Regional Parameters option is now RP2-1.0.3 LoRaWAN® Regional Parameters (previous was RP2-1.0.1) +* [utilities] Add response code assert in exti example +* [utilities] Remove temperature from exti example and replace it with 32b counter +* [utilities] Remove unused implementations and calls of uart4 related functions in smtc_hal_l4 +* [modem] Add randomness before any modem task that need to uplink something +* [alarm] Clamp alarm timer to 864000s ie 10 days +* [stack] Set minimal default reception window size to 16ms instead of 6 ms to avoid ping slots issue in FSK (can be changed be overriding `MIN_RX_WINDOW_DURATION_MS` define) + +### Fixed + +* Issue [#5](https://github.com/Lora-net/SWL2001/issues/5): Correct typo on MCU_FLAGS in makefile +* Issue [#6](https://github.com/Lora-net/SWL2001/issues/6): Example does not override EUI and Keys in case code is built with `CRYPTO=LR11XX_WITH_CREDENTIALS` +* Issue [#7](https://github.com/Lora-net/SWL2001/issues/7): Remove ARM-specific flag from common.mk +* Issue [#9](https://github.com/Lora-net/SWL2001/issues/9): Fix size error in smtc_secure_element_get_pin() +* [LBT] Fix lbt issue when tcxo startup delay is greater than default `RP_MARGIN_DELAY` value (8ms) +* [LRFHSS] Correct tx done timestamp with known bit padding delay to avoid issue with following rx windows (principally seen on US and AU regions) +* [AU915/US915] Fix LoRaWAN Link Adr Request issue (channel mask control case 5 missing impact on 500kHz bank) +* [utilities] In exti example, fix evaluation kit blue button missing pin in irq configuration + ## [v3.2.4] 2022-08-23 ### Added @@ -38,8 +70,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), * [LBT] Moved log print after enqueued the sniffing task in Radio Planer to avoid to add a delays * [ADR] In case a MAC command `link_adr_req` with a new channel mask is received, it is now accepted if the custom datarate profile is enabled and configured with the highest datarate of the corresponding region * [LFU/Stream] In case of reception of rejoin request from DAS, reset LFU and stream services properly -*[ClockSyncService/MAC] Fixed an issue where the Clock Synchronization Service was not reloaded when DeviceTimeAns was not received -*[DeviceTimeReq/MAC] Fixed an issue where the GPS epoch time became invalid if DeviceTimeAns not received +* [ClockSyncService/MAC] Fixed an issue where the Clock Synchronization Service was not reloaded when DeviceTimeAns was not received +* [DeviceTimeReq/MAC] Fixed an issue where the GPS epoch time became invalid if DeviceTimeAns not received ## [v3.1.7] 2022-04-22 diff --git a/lora_basics_modem/lora_basics_modem/Makefile b/lora_basics_modem/lora_basics_modem/Makefile old mode 100644 new mode 100755 index 37f8bec..d6ad748 --- a/lora_basics_modem/lora_basics_modem/Makefile +++ b/lora_basics_modem/lora_basics_modem/Makefile @@ -33,7 +33,7 @@ LOG_MEM ?= yes RADIO ?= nc #MCU - Must be provided by user -MCU_FLAGS =? nc +MCU_FLAGS ?= nc #----------------------------------------------------------------------------- # Internal LBM features management @@ -72,7 +72,7 @@ USE_GNSS ?= yes # default action: print help #----------------------------------------------------------------------------- help: - $(call echo_help_b, "Available TARGETs: sx128x lr1110 lr1120 sx1261 sx1262 sx1268") + $(call echo_help_b, "Available TARGETs: sx128x lr1110 lr1120 lr1121 sx1261 sx1262 sx1268") $(call echo_help, "") $(call echo_help_b, "-------------------------------- Clean -------------------------------------") $(call echo_help, " * make clean_ : clean basic_modem for a given target") @@ -81,7 +81,7 @@ help: $(call echo_help_b, "----------------------------- Compilation ----------------------------------") $(call echo_help, " * make basic_modem_ MCU_FLAGS=xxx : build basic_modem on a given target with chosen mcu flags") $(call echo_help, " * MCU_FLAGS are mandatory. Ex for stm32l4:") - $(call echo_help, " * MCU_FLAGS=\"-mcpu=cortex-m4 -mthumb -mfpu=fpv4-sp-d16 -mfloat-abi=hard\"") + $(call echo_help, " * MCU_FLAGS=\"-mcpu=cortex-m4 -mthumb -mabi=aapcs -mfpu=fpv4-sp-d16 -mfloat-abi=hard\"") $(call echo_help, "") $(call echo_help_b, "---------------------- Optional build parameters ---------------------------") $(call echo_help, " * REGION=xxx : choose which region should be compiled (default: all)") @@ -96,7 +96,7 @@ help: $(call echo_help, " * - RU_864") $(call echo_help, " * - US_915") $(call echo_help, " * - WW_2G4 (to be used only for lr1120 and sx128x targets)") - $(call echo_help, " * RP_VERSION=xxx : choose wich regional paramerter version should be compiled (default: RP2_101) ") + $(call echo_help, " * RP_VERSION=xxx : choose wich regional paramerter version should be compiled (default: RP2_103) ") $(call echo_help, " * - RP2_101") $(call echo_help, " * - RP2_103 (LR-FHSS support)") $(call echo_help, " * CRYPTO=xxx : choose which crypto should be compiled (default: SOFT)") @@ -125,6 +125,10 @@ ifeq ($(RADIO),lr1120) -include makefiles/lr11xx.mk endif +ifeq ($(RADIO),lr1121) +-include makefiles/lr11xx.mk +endif + ifeq ($(RADIO),sx1261) -include makefiles/sx126x.mk endif @@ -148,7 +152,7 @@ endif .PHONY: FORCE FORCE: -all: basic_modem_sx128x basic_modem_lr1110 basic_modem_lr1120 basic_modem_sx1261 basic_modem_sx1262 +all: basic_modem_sx128x basic_modem_lr1110 basic_modem_lr1120 basic_modem_lr1121 basic_modem_sx1261 basic_modem_sx1262 #----------------------------------------------------------------------------- # Clean @@ -165,6 +169,9 @@ clean_lr1110: clean_lr1120: $(MAKE) clean_target RADIO=lr1120 +clean_lr1121: + $(MAKE) clean_target RADIO=lr1121 + clean_sx1261: $(MAKE) clean_target RADIO=sx1261 @@ -186,6 +193,9 @@ basic_modem_lr1110: basic_modem_lr1120: $(MAKE) basic_modem RADIO=lr1120 $(MTHREAD_FLAG) +basic_modem_lr1121: + $(MAKE) basic_modem RADIO=lr1121 $(MTHREAD_FLAG) + basic_modem_sx1261: $(MAKE) basic_modem RADIO=sx1261 $(MTHREAD_FLAG) diff --git a/lora_basics_modem/lora_basics_modem/README.md b/lora_basics_modem/lora_basics_modem/README.md index 2ce4358..2bdfaf5 100644 --- a/lora_basics_modem/lora_basics_modem/README.md +++ b/lora_basics_modem/lora_basics_modem/README.md @@ -10,7 +10,7 @@ The LoRaWAN version that is currently implemented in LoRa Basics Modem is v1.0.4 LoRa Basics Modem supports the following LoRaWAN regions: -* AS_923 (AS923-1, AS923-2, AS923-3) +* AS_923 (AS923-1, AS923-2, AS923-3, AS923-4) * AU_915 * CN_470 * CN_470_RP_1_0 @@ -24,7 +24,7 @@ LoRa Basics Modem supports an emulation of LoRaWAN protocol for the 2.4GHz globa ### LoRaWAN regional parameters -Default regional parameters version supported by LoRa Basics Modem is rp2-1.0.1. It is possible to switch to rp2-1.0.3 at compile time. +Default regional parameters version supported by LoRa Basics Modem is rp2-1.0.3. It is possible to switch back to rp2-1.0.1 at compile time. ### LoRaWAN class @@ -41,7 +41,7 @@ LoRa Basics Modem supports the following services: * Large files upload * ROSE Streaming * Application-Layer Clock synchronization -* Almanac Update +* Almanac Update for LoRa Edge ## LoRa Basics Modem API @@ -61,8 +61,9 @@ The Hardware Abstraction Layer of LoRa Basics Modem is defined in the `smtc_mode LoRa Basics Modem supports the following transceivers: -* LR1110 with firmware 0x0307. -* LR1120 with firmware 0x0101 +* LR1110 with firmware 0x0308. +* LR1120 with firmware 0x0102 +* LR1121 with firmware 0x0102 * SX1261 * SX1262 * SX1280 @@ -73,10 +74,11 @@ LoRa Basics Modem supports the following transceivers: * [LFU] In case LoRa Basics Modem is acting in US915 region with datarate DR0, files smaller than 13 bytes are not properly sent and cannot be reconstructed on LoRa Cloud side * [charge] Values returned by `smtc_modem_get_charge()` for regions CN470 and CN470_RP1 are not accurate * [charge] Values returned by `smtc_modem_get_charge()` for the LR-FHSS based datarate are not accurate +* [time] In case ALC_SYNC time service is used, when a valid time is received, the generated `SMTC_MODEM_EVENT_TIME` event will show a ghost missed event. ## Disclaimer -This software has been extensively tested when targeting LR1110 / LR1120 / SX1261 / SX1262 / SX1280 / SX1281 for LoRaWAN regions mentioned in [this paragraph](#lorawan-region). For all other combinations of features this software shall be considered an Engineering Sample. +This software has been extensively tested when targeting LR1110 / LR1120 / LR1121 / SX1261 / SX1262 / SX1280 / SX1281 for LoRaWAN regions mentioned in [this paragraph](#lorawan-region). For all other combinations of features this software shall be considered an Engineering Sample. Modem trace prints can only be used for debug purpose and shall be deactivated for production release. diff --git a/lora_basics_modem/lora_basics_modem/lora_basics_modem_version.h b/lora_basics_modem/lora_basics_modem/lora_basics_modem_version.h index 7fd50ff..a2323b7 100644 --- a/lora_basics_modem/lora_basics_modem/lora_basics_modem_version.h +++ b/lora_basics_modem/lora_basics_modem/lora_basics_modem_version.h @@ -56,8 +56,8 @@ extern "C" { * --- PUBLIC TYPES ------------------------------------------------------------ */ #define LORA_BASICS_MODEM_FW_VERSION_MAJOR 3 -#define LORA_BASICS_MODEM_FW_VERSION_MINOR 2 -#define LORA_BASICS_MODEM_FW_VERSION_PATCH 4 +#define LORA_BASICS_MODEM_FW_VERSION_MINOR 3 +#define LORA_BASICS_MODEM_FW_VERSION_PATCH 0 /* * ----------------------------------------------------------------------------- diff --git a/lora_basics_modem/lora_basics_modem/makefiles/common.mk b/lora_basics_modem/lora_basics_modem/makefiles/common.mk index 15bb2c5..7200c0c 100644 --- a/lora_basics_modem/lora_basics_modem/makefiles/common.mk +++ b/lora_basics_modem/lora_basics_modem/makefiles/common.mk @@ -99,6 +99,17 @@ BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_lr11xx_crypto_with_cred endif # LR11XX_WITH_CREDENTIALS endif # lr1120 +ifeq ($(RADIO),lr1121) +ifeq ($(CRYPTO),LR11XX) +TARGET_MODEM := $(TARGET_MODEM)_lr11xx_crypto +BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_lr11xx_crypto +endif # LR11XX +ifeq ($(CRYPTO),LR11XX_WITH_CREDENTIALS) +TARGET_MODEM := $(TARGET_MODEM)_lr11xx_crypto_with_cred +BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_lr11xx_crypto_with_cred +endif # LR11XX_WITH_CREDENTIALS +endif # lr1121 + ifeq ($(MIDDLEWARE),yes) TARGET_MODEM := $(TARGET_MODEM)_middleware BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_middleware @@ -178,7 +189,6 @@ WFLAG += \ -Wno-unused-parameter \ -Wpedantic \ -fomit-frame-pointer \ - -mabi=aapcs \ -fno-unroll-loops \ -ffast-math \ -ftree-vectorize \ @@ -266,8 +276,9 @@ COMMON_C_DEFS += \ -DADD_SMTC_ALC_SYNC endif +EXTRAFLAGS ?= -CFLAGS += -fno-builtin $(MCU_FLAGS) $(BOARD_C_DEFS) $(COMMON_C_DEFS) $(MODEM_C_DEFS) $(BOARD_C_INCLUDES) $(COMMON_C_INCLUDES) $(MODEM_C_INCLUDES) $(OPT) $(WFLAG) -MMD -MP -MF"$(@:%.o=%.d)" +CFLAGS += -fno-builtin $(MCU_FLAGS) $(BOARD_C_DEFS) $(COMMON_C_DEFS) $(MODEM_C_DEFS) $(EXTRAFLAGS) $(BOARD_C_INCLUDES) $(COMMON_C_INCLUDES) $(MODEM_C_INCLUDES) $(OPT) $(WFLAG) -MMD -MP -MF"$(@:%.o=%.d)" CFLAGS += -falign-functions=4 CFLAGS += -std=c17 diff --git a/lora_basics_modem/lora_basics_modem/makefiles/lr11xx.mk b/lora_basics_modem/lora_basics_modem/makefiles/lr11xx.mk index 23a702f..b3cefdc 100644 --- a/lora_basics_modem/lora_basics_modem/makefiles/lr11xx.mk +++ b/lora_basics_modem/lora_basics_modem/makefiles/lr11xx.mk @@ -7,17 +7,25 @@ endif ifeq ($(RADIO),lr1120) TARGET = lr1120 endif - +ifeq ($(RADIO),lr1121) +TARGET = lr1121 +endif #----------------------------------------------------------------------------- # Common sources #----------------------------------------------------------------------------- -ifeq ($(USE_GNSS),yes) -SMTC_MODEM_SERVICES_C_SOURCES += \ - smtc_modem_core/smtc_modem_services/src/almanac_update/almanac_update.c -endif - +ifeq ($(RADIO),lr1121) +USE_GNSS=no +RADIO_DRIVER_C_SOURCES += \ + smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_bootloader.c\ + smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_crypto_engine.c\ + smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_driver_version.c\ + smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_radio.c\ + smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_regmem.c\ + smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_system.c\ + smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_lr_fhss.c +else RADIO_DRIVER_C_SOURCES += \ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_bootloader.c\ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_crypto_engine.c\ @@ -31,6 +39,11 @@ ifeq ($(USE_GNSS),yes) RADIO_DRIVER_C_SOURCES += \ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_gnss.c endif +ifeq ($(USE_GNSS),yes) +SMTC_MODEM_SERVICES_C_SOURCES += \ + smtc_modem_core/smtc_modem_services/src/almanac_update/almanac_update.c +endif +endif SMTC_RAL_C_SOURCES += \ smtc_modem_core/smtc_ral/src/ral_lr11xx.c @@ -82,12 +95,8 @@ endif # soft_crypto #----------------------------------------------------------------------------- MODEM_C_DEFS += \ -DLR11XX\ - -DLR11XX_TRANSCEIVER - -ifeq ($(RADIO),lr1120) -MODEM_C_DEFS += \ - -DLR1120 -endif + -DLR11XX_TRANSCEIVER\ + -DLR11XX_DISABLE_WARNINGS ifeq ($(CRYPTO),LR11XX) MODEM_C_DEFS += \ diff --git a/lora_basics_modem/lora_basics_modem/makefiles/regions.mk b/lora_basics_modem/lora_basics_modem/makefiles/regions.mk index b4db64e..6719a08 100644 --- a/lora_basics_modem/lora_basics_modem/makefiles/regions.mk +++ b/lora_basics_modem/lora_basics_modem/makefiles/regions.mk @@ -37,7 +37,7 @@ endif # REGION #----------------------------------------------------------------------------- ifndef RP_VERSION -MODEM_C_DEFS += -DRP2_101 +MODEM_C_DEFS += -DRP2_103 endif ifeq ($(RP_VERSION),RP2_103) diff --git a/lora_basics_modem/lora_basics_modem/smtc_modem_api/doxygen.config b/lora_basics_modem/lora_basics_modem/smtc_modem_api/doxygen.config deleted file mode 100644 index 85fc6dc..0000000 --- a/lora_basics_modem/lora_basics_modem/smtc_modem_api/doxygen.config +++ /dev/null @@ -1,2494 +0,0 @@ -# Doxyfile 1.8.13 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "SMTC Modem API" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = "Generic Modem API description" - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = build_doc - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 0. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 0 - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = ./ - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = NO - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse-libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /