diff --git a/LICENSE b/LICENSE index 7bae39ac..f6287eeb 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 - 2025 Andreas Merkle +Copyright (c) 2023 - 2026 Andreas Merkle Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/doc/doxygen/ConvoyFollowerSimDoxyfile b/doc/doxygen/ConvoyFollowerSimDoxyfile index c02431a7..c3a7148e 100644 --- a/doc/doxygen/ConvoyFollowerSimDoxyfile +++ b/doc/doxygen/ConvoyFollowerSimDoxyfile @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/ConvoyFollowerTargetDoxyfile b/doc/doxygen/ConvoyFollowerTargetDoxyfile index 6eded197..726403f2 100644 --- a/doc/doxygen/ConvoyFollowerTargetDoxyfile +++ b/doc/doxygen/ConvoyFollowerTargetDoxyfile @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/ConvoyLeaderSimDoxyfile b/doc/doxygen/ConvoyLeaderSimDoxyfile index 9d1cc356..31f32653 100644 --- a/doc/doxygen/ConvoyLeaderSimDoxyfile +++ b/doc/doxygen/ConvoyLeaderSimDoxyfile @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/ConvoyLeaderTargetDoxyfile b/doc/doxygen/ConvoyLeaderTargetDoxyfile index 6fdb2b99..00c306df 100644 --- a/doc/doxygen/ConvoyLeaderTargetDoxyfile +++ b/doc/doxygen/ConvoyLeaderTargetDoxyfile @@ -2533,7 +2533,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/LineFollowerSimDoxyfile b/doc/doxygen/LineFollowerSimDoxyfile index eabbb567..061283e0 100644 --- a/doc/doxygen/LineFollowerSimDoxyfile +++ b/doc/doxygen/LineFollowerSimDoxyfile @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/LineFollowerTargetDoxyfile b/doc/doxygen/LineFollowerTargetDoxyfile index daed075d..309476a0 100644 --- a/doc/doxygen/LineFollowerTargetDoxyfile +++ b/doc/doxygen/LineFollowerTargetDoxyfile @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/RemoteControlSimDoxyfile b/doc/doxygen/RemoteControlSimDoxyfile index 2a55e6d7..d3974037 100644 --- a/doc/doxygen/RemoteControlSimDoxyfile +++ b/doc/doxygen/RemoteControlSimDoxyfile @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/RemoteControlTargetDoxyfile b/doc/doxygen/RemoteControlTargetDoxyfile index 2b0e138d..f0ec1092 100644 --- a/doc/doxygen/RemoteControlTargetDoxyfile +++ b/doc/doxygen/RemoteControlTargetDoxyfile @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/SensorFusionSimDoxyfile b/doc/doxygen/SensorFusionSimDoxyfile index bba6c2bb..66996ab5 100644 --- a/doc/doxygen/SensorFusionSimDoxyfile +++ b/doc/doxygen/SensorFusionSimDoxyfile @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/SensorFusionTargetDoxyfile b/doc/doxygen/SensorFusionTargetDoxyfile index 16c64921..51d58454 100644 --- a/doc/doxygen/SensorFusionTargetDoxyfile +++ b/doc/doxygen/SensorFusionTargetDoxyfile @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/TurtleSimDoxyfile b/doc/doxygen/TurtleSimDoxyfile index 01eb016f..d5d1c90d 100644 --- a/doc/doxygen/TurtleSimDoxyfile +++ b/doc/doxygen/TurtleSimDoxyfile @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/doxygen/TurtleTargetDoxyfile b/doc/doxygen/TurtleTargetDoxyfile index 59524b2e..edacc244 100644 --- a/doc/doxygen/TurtleTargetDoxyfile +++ b/doc/doxygen/TurtleTargetDoxyfile @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = __attribute__(x)= \ + IRAM_ATTR # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/lib/APPConvoyFollower/src/App.cpp b/lib/APPConvoyFollower/src/App.cpp index ac3cbd4a..fa3b91b2 100644 --- a/lib/APPConvoyFollower/src/App.cpp +++ b/lib/APPConvoyFollower/src/App.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief ConvoyFollower application * @author Andreas Merkle */ @@ -53,6 +54,7 @@ * Macros *****************************************************************************/ +/** Configuration of the logging severity if not previously defined. */ #ifndef CONFIG_LOG_SEVERITY #define CONFIG_LOG_SEVERITY (Logging::LOG_LEVEL_INFO) #endif /* CONFIG_LOG_SEVERITY */ diff --git a/lib/APPConvoyFollower/src/App.h b/lib/APPConvoyFollower/src/App.h index 55ff2e36..0c788034 100644 --- a/lib/APPConvoyFollower/src/App.h +++ b/lib/APPConvoyFollower/src/App.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief ConvoyFollower application * @author Andreas Merkle * diff --git a/lib/APPConvoyFollower/src/DrivingState.cpp b/lib/APPConvoyFollower/src/DrivingState.cpp index 236ea3f2..6bf6e287 100644 --- a/lib/APPConvoyFollower/src/DrivingState.cpp +++ b/lib/APPConvoyFollower/src/DrivingState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Driving state. * @author Gabryel Reyes */ diff --git a/lib/APPConvoyFollower/src/DrivingState.h b/lib/APPConvoyFollower/src/DrivingState.h index 8dbad7c5..6cd6091a 100644 --- a/lib/APPConvoyFollower/src/DrivingState.h +++ b/lib/APPConvoyFollower/src/DrivingState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Driving state. * @author Gabryel Reyes * diff --git a/lib/APPConvoyFollower/src/ErrorState.cpp b/lib/APPConvoyFollower/src/ErrorState.cpp index 79972bf5..eb4effd1 100644 --- a/lib/APPConvoyFollower/src/ErrorState.cpp +++ b/lib/APPConvoyFollower/src/ErrorState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Error State. * @author Gabryel Reyes */ diff --git a/lib/APPConvoyFollower/src/ErrorState.h b/lib/APPConvoyFollower/src/ErrorState.h index 979945b2..734d6024 100644 --- a/lib/APPConvoyFollower/src/ErrorState.h +++ b/lib/APPConvoyFollower/src/ErrorState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Error State. * @author Gabryel Reyes * diff --git a/lib/APPConvoyFollower/src/SerialMuxChannels.h b/lib/APPConvoyFollower/src/SerialMuxChannels.h index b1b75b99..68ea50f1 100644 --- a/lib/APPConvoyFollower/src/SerialMuxChannels.h +++ b/lib/APPConvoyFollower/src/SerialMuxChannels.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Channel structure definition for the SerialMuxProt. * @author Gabryel Reyes * diff --git a/lib/APPConvoyFollower/src/StartupState.cpp b/lib/APPConvoyFollower/src/StartupState.cpp index a4b75a69..62817ffc 100644 --- a/lib/APPConvoyFollower/src/StartupState.cpp +++ b/lib/APPConvoyFollower/src/StartupState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Startup State. * @author Gabryel Reyes */ diff --git a/lib/APPConvoyFollower/src/StartupState.h b/lib/APPConvoyFollower/src/StartupState.h index aa865c66..87cd3042 100644 --- a/lib/APPConvoyFollower/src/StartupState.h +++ b/lib/APPConvoyFollower/src/StartupState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Startup State. * @author Gabryel Reyes * diff --git a/lib/APPConvoyLeader/src/App.cpp b/lib/APPConvoyLeader/src/App.cpp index 442ceaf6..0af73cab 100644 --- a/lib/APPConvoyLeader/src/App.cpp +++ b/lib/APPConvoyLeader/src/App.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief ConvoyLeader application * @author Andreas Merkle */ @@ -53,6 +54,7 @@ * Macros *****************************************************************************/ +/** Configuration of the logging severity if not previously defined. */ #ifndef CONFIG_LOG_SEVERITY #define CONFIG_LOG_SEVERITY (Logging::LOG_LEVEL_INFO) #endif /* CONFIG_LOG_SEVERITY */ diff --git a/lib/APPConvoyLeader/src/App.h b/lib/APPConvoyLeader/src/App.h index d6223edb..1d3635dc 100644 --- a/lib/APPConvoyLeader/src/App.h +++ b/lib/APPConvoyLeader/src/App.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief ConvoyLeader application * @author Andreas Merkle * diff --git a/lib/APPConvoyLeader/src/DrivingState.cpp b/lib/APPConvoyLeader/src/DrivingState.cpp index a90b4c11..f3379530 100644 --- a/lib/APPConvoyLeader/src/DrivingState.cpp +++ b/lib/APPConvoyLeader/src/DrivingState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Driving state. * @author Gabryel Reyes */ diff --git a/lib/APPConvoyLeader/src/DrivingState.h b/lib/APPConvoyLeader/src/DrivingState.h index 98855c30..b6097757 100644 --- a/lib/APPConvoyLeader/src/DrivingState.h +++ b/lib/APPConvoyLeader/src/DrivingState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Driving state. * @author Gabryel Reyes * diff --git a/lib/APPConvoyLeader/src/ErrorState.cpp b/lib/APPConvoyLeader/src/ErrorState.cpp index 79972bf5..eb4effd1 100644 --- a/lib/APPConvoyLeader/src/ErrorState.cpp +++ b/lib/APPConvoyLeader/src/ErrorState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Error State. * @author Gabryel Reyes */ diff --git a/lib/APPConvoyLeader/src/ErrorState.h b/lib/APPConvoyLeader/src/ErrorState.h index 979945b2..734d6024 100644 --- a/lib/APPConvoyLeader/src/ErrorState.h +++ b/lib/APPConvoyLeader/src/ErrorState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Error State. * @author Gabryel Reyes * diff --git a/lib/APPConvoyLeader/src/SerialMuxChannels.h b/lib/APPConvoyLeader/src/SerialMuxChannels.h index b1b75b99..68ea50f1 100644 --- a/lib/APPConvoyLeader/src/SerialMuxChannels.h +++ b/lib/APPConvoyLeader/src/SerialMuxChannels.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Channel structure definition for the SerialMuxProt. * @author Gabryel Reyes * diff --git a/lib/APPConvoyLeader/src/StartupState.cpp b/lib/APPConvoyLeader/src/StartupState.cpp index a4b75a69..62817ffc 100644 --- a/lib/APPConvoyLeader/src/StartupState.cpp +++ b/lib/APPConvoyLeader/src/StartupState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Startup State. * @author Gabryel Reyes */ diff --git a/lib/APPConvoyLeader/src/StartupState.h b/lib/APPConvoyLeader/src/StartupState.h index aa865c66..87cd3042 100644 --- a/lib/APPConvoyLeader/src/StartupState.h +++ b/lib/APPConvoyLeader/src/StartupState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Startup State. * @author Gabryel Reyes * diff --git a/lib/APPLineFollower/src/App.cpp b/lib/APPLineFollower/src/App.cpp index d2e257aa..e3ea668e 100644 --- a/lib/APPLineFollower/src/App.cpp +++ b/lib/APPLineFollower/src/App.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Line follower application * @author Andreas Merkle */ @@ -54,6 +55,7 @@ * Macros *****************************************************************************/ +/** Configuration of the logging severity if not previously defined. */ #ifndef CONFIG_LOG_SEVERITY #define CONFIG_LOG_SEVERITY (Logging::LOG_LEVEL_INFO) #endif /* CONFIG_LOG_SEVERITY */ diff --git a/lib/APPLineFollower/src/App.h b/lib/APPLineFollower/src/App.h index 73fd46ea..cc87132a 100644 --- a/lib/APPLineFollower/src/App.h +++ b/lib/APPLineFollower/src/App.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Line follower application * @author Andreas Merkle * @@ -87,7 +88,6 @@ class App void loop(); private: - /** * Flag for setting initial data through SMP. */ diff --git a/lib/APPLineFollower/src/LineSensors.cpp b/lib/APPLineFollower/src/LineSensors.cpp index 7e73d15b..6114f953 100644 --- a/lib/APPLineFollower/src/LineSensors.cpp +++ b/lib/APPLineFollower/src/LineSensors.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Line sensors * @author Andreas Merkle */ diff --git a/lib/APPLineFollower/src/LineSensors.h b/lib/APPLineFollower/src/LineSensors.h index d197650b..cbfba5bf 100644 --- a/lib/APPLineFollower/src/LineSensors.h +++ b/lib/APPLineFollower/src/LineSensors.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Line sensors * @author Andreas Merkle * diff --git a/lib/APPLineFollower/src/Motors.cpp b/lib/APPLineFollower/src/Motors.cpp index 73201411..1e8fff96 100644 --- a/lib/APPLineFollower/src/Motors.cpp +++ b/lib/APPLineFollower/src/Motors.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Motors * @author Andreas Merkle */ diff --git a/lib/APPLineFollower/src/Motors.h b/lib/APPLineFollower/src/Motors.h index f7637e05..467b0cb9 100644 --- a/lib/APPLineFollower/src/Motors.h +++ b/lib/APPLineFollower/src/Motors.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Motors * @author Andreas Merkle * @@ -108,7 +109,6 @@ class Motors } private: - /** * Serial multiplexer protocol channel provider. */ diff --git a/lib/APPLineFollower/src/RemoteControl.h b/lib/APPLineFollower/src/RemoteControl.h index 166fca5e..86cc46ce 100644 --- a/lib/APPLineFollower/src/RemoteControl.h +++ b/lib/APPLineFollower/src/RemoteControl.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief RemoteControl common constants. * @author Gabryel Reyes * diff --git a/lib/APPLineFollower/src/SerMuxChannelProvider.cpp b/lib/APPLineFollower/src/SerMuxChannelProvider.cpp index b72ac530..2aa0563d 100644 --- a/lib/APPLineFollower/src/SerMuxChannelProvider.cpp +++ b/lib/APPLineFollower/src/SerMuxChannelProvider.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Serial multiplexer channel provider * @author Andreas Merkle */ @@ -90,8 +91,7 @@ const SerMuxChannelProvider::ChannelCfg SerMuxChannelProvider::CHANNEL_CFG[MAX_C /* Not used. */ {nullptr, 0U, nullptr}, {nullptr, 0U, nullptr}, - {nullptr, 0U, nullptr} -}; + {nullptr, 0U, nullptr}}; /****************************************************************************** * Public Methods diff --git a/lib/APPLineFollower/src/SerMuxChannelProvider.h b/lib/APPLineFollower/src/SerMuxChannelProvider.h index 5f037c25..4f021b16 100644 --- a/lib/APPLineFollower/src/SerMuxChannelProvider.h +++ b/lib/APPLineFollower/src/SerMuxChannelProvider.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Serial multiplexer channel provider * @author Andreas Merkle * diff --git a/lib/APPLineFollower/src/SerialMuxChannels.h b/lib/APPLineFollower/src/SerialMuxChannels.h index 58395492..6506430b 100644 --- a/lib/APPLineFollower/src/SerialMuxChannels.h +++ b/lib/APPLineFollower/src/SerialMuxChannels.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Channel structure definition for the SerialMuxProt. * @author Gabryel Reyes * diff --git a/lib/APPLineFollower/src/States/DrivingState.cpp b/lib/APPLineFollower/src/States/DrivingState.cpp index ca0fd4c8..30dfc4ce 100644 --- a/lib/APPLineFollower/src/States/DrivingState.cpp +++ b/lib/APPLineFollower/src/States/DrivingState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Driving state * @author Andreas Merkle */ diff --git a/lib/APPLineFollower/src/States/DrivingState.h b/lib/APPLineFollower/src/States/DrivingState.h index df0daad0..4f37a9b5 100644 --- a/lib/APPLineFollower/src/States/DrivingState.h +++ b/lib/APPLineFollower/src/States/DrivingState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Driving state * @author Andreas Merkle * diff --git a/lib/APPLineFollower/src/States/ErrorState.cpp b/lib/APPLineFollower/src/States/ErrorState.cpp index c7b66a8e..2ad63af9 100644 --- a/lib/APPLineFollower/src/States/ErrorState.cpp +++ b/lib/APPLineFollower/src/States/ErrorState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Error state * @author Andreas Merkle */ @@ -66,7 +67,7 @@ void ErrorState::entry() { LOG_INFO("Error state entered."); - + /* Turn on Red LED to signal fatal error. */ Board::getInstance().getRedLed().enable(true); } diff --git a/lib/APPLineFollower/src/States/ErrorState.h b/lib/APPLineFollower/src/States/ErrorState.h index 28269fbf..6a0298f9 100644 --- a/lib/APPLineFollower/src/States/ErrorState.h +++ b/lib/APPLineFollower/src/States/ErrorState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Error state * @author Andreas Merkle * @@ -90,7 +91,6 @@ class ErrorState : public IState void exit() final; private: - /** * Default constructor. */ diff --git a/lib/APPLineFollower/src/States/LineSensorsCalibrationState.cpp b/lib/APPLineFollower/src/States/LineSensorsCalibrationState.cpp index a459f556..ec4089c2 100644 --- a/lib/APPLineFollower/src/States/LineSensorsCalibrationState.cpp +++ b/lib/APPLineFollower/src/States/LineSensorsCalibrationState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Line sensors calibration state * @author Andreas Merkle */ diff --git a/lib/APPLineFollower/src/States/LineSensorsCalibrationState.h b/lib/APPLineFollower/src/States/LineSensorsCalibrationState.h index d9165177..3596c6ba 100644 --- a/lib/APPLineFollower/src/States/LineSensorsCalibrationState.h +++ b/lib/APPLineFollower/src/States/LineSensorsCalibrationState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Line sensors calibration state * @author Andreas Merkle * diff --git a/lib/APPLineFollower/src/States/ParameterSets.cpp b/lib/APPLineFollower/src/States/ParameterSets.cpp index ccb0c83c..077b6116 100644 --- a/lib/APPLineFollower/src/States/ParameterSets.cpp +++ b/lib/APPLineFollower/src/States/ParameterSets.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Calibration state * @author Andreas Merkle */ diff --git a/lib/APPLineFollower/src/States/ParameterSets.h b/lib/APPLineFollower/src/States/ParameterSets.h index 2f025a64..51609810 100644 --- a/lib/APPLineFollower/src/States/ParameterSets.h +++ b/lib/APPLineFollower/src/States/ParameterSets.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Parameter state * @author Andreas Merkle * diff --git a/lib/APPLineFollower/src/States/ReadyState.cpp b/lib/APPLineFollower/src/States/ReadyState.cpp index aedca115..a87d5af5 100644 --- a/lib/APPLineFollower/src/States/ReadyState.cpp +++ b/lib/APPLineFollower/src/States/ReadyState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Ready state * @author Andreas Merkle */ @@ -98,13 +99,8 @@ void ReadyState::process(StateMachine& sm) char valueStr[10]; /* Print line sensor value on console for debug purposes. */ - LOG_DEBUG("%u, %u, %u, %u, %u, pos=%d", - sensorValues[0], - sensorValues[1], - sensorValues[2], - sensorValues[3], - sensorValues[4], - position); + LOG_DEBUG("%u, %u, %u, %u, %u, pos=%d", sensorValues[0], sensorValues[1], sensorValues[2], sensorValues[3], + sensorValues[4], position); m_timer.restart(); } diff --git a/lib/APPLineFollower/src/States/ReadyState.h b/lib/APPLineFollower/src/States/ReadyState.h index 4b54c0b9..5fdb8d5f 100644 --- a/lib/APPLineFollower/src/States/ReadyState.h +++ b/lib/APPLineFollower/src/States/ReadyState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Ready state * @author Andreas Merkle * diff --git a/lib/APPLineFollower/src/States/ReleaseTrackState.cpp b/lib/APPLineFollower/src/States/ReleaseTrackState.cpp index 201ab924..5dbe62c0 100644 --- a/lib/APPLineFollower/src/States/ReleaseTrackState.cpp +++ b/lib/APPLineFollower/src/States/ReleaseTrackState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Release track state * @author Andreas Merkle */ @@ -81,7 +82,6 @@ void ReleaseTrackState::process(StateMachine& sm) { IButton& button = Board::getInstance().getButton(); - /* Change parameter set? */ if (true == Util::isButtonTriggered(button, m_isButtonPressed)) { diff --git a/lib/APPLineFollower/src/States/ReleaseTrackState.h b/lib/APPLineFollower/src/States/ReleaseTrackState.h index d236ab56..cc23bfba 100644 --- a/lib/APPLineFollower/src/States/ReleaseTrackState.h +++ b/lib/APPLineFollower/src/States/ReleaseTrackState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Release track state * @author Andreas Merkle * diff --git a/lib/APPLineFollower/src/States/StartupState.cpp b/lib/APPLineFollower/src/States/StartupState.cpp index 92a4c46e..16545746 100644 --- a/lib/APPLineFollower/src/States/StartupState.cpp +++ b/lib/APPLineFollower/src/States/StartupState.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Startup state * @author Andreas Merkle */ @@ -81,7 +82,8 @@ void StartupState::process(StateMachine& sm) { LOG_INFO("Synchronization with RU established."); - SerMuxChannelProvider::MaxMotorSpeedFunc maxMotorSpeedFunc = [this](SMPChannelPayload::RspId status, int16_t maxMotorSpeed) -> void + SerMuxChannelProvider::MaxMotorSpeedFunc maxMotorSpeedFunc = [this](SMPChannelPayload::RspId status, + int16_t maxMotorSpeed) -> void { if (nullptr == m_motors) { @@ -95,7 +97,7 @@ void StartupState::process(StateMachine& sm) else if (SMPChannelPayload::RSP_ID_OK == status) { m_motors->setMaxSpeed(maxMotorSpeed); - + LOG_INFO("Press button to start line sensors calibration."); m_subState = SUB_STATE_FINISHED; } diff --git a/lib/APPLineFollower/src/States/StartupState.h b/lib/APPLineFollower/src/States/StartupState.h index 55af69e7..dfc812c7 100644 --- a/lib/APPLineFollower/src/States/StartupState.h +++ b/lib/APPLineFollower/src/States/StartupState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Startup state * @author Andreas Merkle * diff --git a/lib/APPRemoteControl/src/App.cpp b/lib/APPRemoteControl/src/App.cpp index cc12872e..c2e41831 100644 --- a/lib/APPRemoteControl/src/App.cpp +++ b/lib/APPRemoteControl/src/App.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief RemoteControl application * @author Gabryel Reyes */ @@ -49,6 +50,7 @@ * Macros *****************************************************************************/ +/** Configuration of the logging severity if not previously defined. */ #ifndef CONFIG_LOG_SEVERITY #define CONFIG_LOG_SEVERITY (Logging::LOG_LEVEL_INFO) #endif /* CONFIG_LOG_SEVERITY */ diff --git a/lib/APPRemoteControl/src/App.h b/lib/APPRemoteControl/src/App.h index d414815e..4683665c 100644 --- a/lib/APPRemoteControl/src/App.h +++ b/lib/APPRemoteControl/src/App.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief RemoteControl application * @author Gabryel Reyes * @@ -157,11 +158,11 @@ class App /** * Setup the MQTT connection. - * + * * @param[in] clientId The MQTT client id. * @param[in] brokerAddr The address of the MQTT broker. * @param[in] brokerPort The port of the MQTT broker. - * + * * @return true if successful, otherwise false. */ bool setupMqtt(const String& clientId, const String& brokerAddr, uint16_t brokerPort); diff --git a/lib/APPRemoteControl/src/RemoteControl.h b/lib/APPRemoteControl/src/RemoteControl.h index 166fca5e..86cc46ce 100644 --- a/lib/APPRemoteControl/src/RemoteControl.h +++ b/lib/APPRemoteControl/src/RemoteControl.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief RemoteControl common constants. * @author Gabryel Reyes * diff --git a/lib/APPRemoteControl/src/SerialMuxChannels.h b/lib/APPRemoteControl/src/SerialMuxChannels.h index 58395492..6506430b 100644 --- a/lib/APPRemoteControl/src/SerialMuxChannels.h +++ b/lib/APPRemoteControl/src/SerialMuxChannels.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Channel structure definition for the SerialMuxProt. * @author Gabryel Reyes * diff --git a/lib/APPSensorFusion/src/App.cpp b/lib/APPSensorFusion/src/App.cpp index c9385e1b..d60aea7b 100644 --- a/lib/APPSensorFusion/src/App.cpp +++ b/lib/APPSensorFusion/src/App.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief SensorFusion application * @author Juliane Kerpe */ @@ -48,6 +49,7 @@ * Macros *****************************************************************************/ +/** Configuration of the logging severity if not previously defined. */ #ifndef CONFIG_LOG_SEVERITY #define CONFIG_LOG_SEVERITY (Logging::LOG_LEVEL_INFO) #endif /* CONFIG_LOG_SEVERITY */ diff --git a/lib/APPSensorFusion/src/App.h b/lib/APPSensorFusion/src/App.h index 7cd39827..5056bb4f 100644 --- a/lib/APPSensorFusion/src/App.h +++ b/lib/APPSensorFusion/src/App.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief SensorFusion application * @author Juliane Kerpe * diff --git a/lib/APPSensorFusion/src/ExtendedKalmanFilter.cpp b/lib/APPSensorFusion/src/ExtendedKalmanFilter.cpp index 7cf63b2c..c4a7378e 100644 --- a/lib/APPSensorFusion/src/ExtendedKalmanFilter.cpp +++ b/lib/APPSensorFusion/src/ExtendedKalmanFilter.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Implementation of the Extended Kalman Filter * @author Juliane Kerpe */ diff --git a/lib/APPSensorFusion/src/ExtendedKalmanFilter.h b/lib/APPSensorFusion/src/ExtendedKalmanFilter.h index 10c31f09..b53ffdf3 100644 --- a/lib/APPSensorFusion/src/ExtendedKalmanFilter.h +++ b/lib/APPSensorFusion/src/ExtendedKalmanFilter.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Implementation of the Extended Kalman Filter * @author Juliane Kerpe * diff --git a/lib/APPSensorFusion/src/IKalmanFilter.h b/lib/APPSensorFusion/src/IKalmanFilter.h index b141c502..f6bf5339 100644 --- a/lib/APPSensorFusion/src/IKalmanFilter.h +++ b/lib/APPSensorFusion/src/IKalmanFilter.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief Interface Class of a Kalman Filter Implementation + * @file + * @brief Interface Class of a Kalman Filter Implementation * @author Juliane Kerpe * * @addtogroup Application @@ -74,7 +75,7 @@ class IKalmanFilter /** * Prediction of the covariance and the state of the Kalman Filter. - * + * * @param[in] timeStep Measured Time Step in ms. * @param[in] kalmanParameter Input Parameters for the Kalman Filter */ @@ -82,7 +83,7 @@ class IKalmanFilter /** * Update of the covariance and the state of the Kalman Filter. - * + * * @return Estimated Position as a PositionData struct. * */ diff --git a/lib/APPSensorFusion/src/KalmanParameter.h b/lib/APPSensorFusion/src/KalmanParameter.h index e95a7627..b65062f3 100644 --- a/lib/APPSensorFusion/src/KalmanParameter.h +++ b/lib/APPSensorFusion/src/KalmanParameter.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief Struct for Parameter used for a Kalman Filter + * @file + * @brief Struct for Parameter used for a Kalman Filter * @author Juliane Kerpe * * @addtogroup Application diff --git a/lib/APPSensorFusion/src/SensorConstants.h b/lib/APPSensorFusion/src/SensorConstants.h index 29cfc274..843b12dc 100644 --- a/lib/APPSensorFusion/src/SensorConstants.h +++ b/lib/APPSensorFusion/src/SensorConstants.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Sensor specific constants * @author Juliane Kerpe * diff --git a/lib/APPSensorFusion/src/SensorFusion.cpp b/lib/APPSensorFusion/src/SensorFusion.cpp index fc93a17b..37268fe0 100644 --- a/lib/APPSensorFusion/src/SensorFusion.cpp +++ b/lib/APPSensorFusion/src/SensorFusion.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief SensorFusion algorithm * @author Juliane Kerpe */ @@ -133,11 +134,12 @@ void SensorFusion::estimateNewState(const SensorData& newSensorData) /* Perform the Prediction Step and the Update Step of the Kalman Filter. */ m_kalmanFilter.predictionStep(newSensorData.timePeriod, kalmanParameter); - /* The Odometry is not necessarily updated in every time step. Only Perform the Update step if there are new Odometry values available. */ + /* The Odometry is not necessarily updated in every time step. Only Perform the Update step if there are new + * Odometry values available. */ bool newOdometryValues = (euclideanDistance > 0.0F); if (true == newOdometryValues) { - m_estimatedPosition = m_kalmanFilter.updateStep(); + m_estimatedPosition = m_kalmanFilter.updateStep(); m_timeSinceLastOdoUpdate = 0.0F; } } diff --git a/lib/APPSensorFusion/src/SensorFusion.h b/lib/APPSensorFusion/src/SensorFusion.h index 9b794c28..0396a78c 100644 --- a/lib/APPSensorFusion/src/SensorFusion.h +++ b/lib/APPSensorFusion/src/SensorFusion.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Implementation of the Sensor Fusion * @author Juliane Kerpe * diff --git a/lib/APPSensorFusion/src/SerialMuxChannels.h b/lib/APPSensorFusion/src/SerialMuxChannels.h index 0d45957b..414537df 100644 --- a/lib/APPSensorFusion/src/SerialMuxChannels.h +++ b/lib/APPSensorFusion/src/SerialMuxChannels.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -26,7 +26,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief Channel structure definition for the SerialMuxProt. + * @file + * @brief Channel structure definition for the SerialMuxProt. * @author Juliane Kerpe * * @addtogroup Application diff --git a/lib/APPTest/src/App.cpp b/lib/APPTest/src/App.cpp index 560867e8..6d770754 100644 --- a/lib/APPTest/src/App.cpp +++ b/lib/APPTest/src/App.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Test application * @author Andreas Merkle */ @@ -60,12 +61,10 @@ void App::setup() { - } void App::loop() { - } /****************************************************************************** diff --git a/lib/APPTest/src/App.h b/lib/APPTest/src/App.h index 0af6d7fe..2476da4c 100644 --- a/lib/APPTest/src/App.h +++ b/lib/APPTest/src/App.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Test application * @author Andreas Merkle * @@ -82,7 +83,6 @@ class App void loop(); private: - /* Not allowed. */ App(const App& app); /**< Copy construction of an instance. */ App& operator=(const App& app); /**< Assignment of an instance. */ diff --git a/lib/APPTurtle/src/App.cpp b/lib/APPTurtle/src/App.cpp index b716870e..84025951 100644 --- a/lib/APPTurtle/src/App.cpp +++ b/lib/APPTurtle/src/App.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Turtle application. * @author Gabryel Reyes */ @@ -46,6 +47,7 @@ * Macros *****************************************************************************/ +/** Configuration of the logging severity if not previously defined. */ #ifndef CONFIG_LOG_SEVERITY #define CONFIG_LOG_SEVERITY (Logging::LOG_LEVEL_INFO) #endif /* CONFIG_LOG_SEVERITY */ diff --git a/lib/APPTurtle/src/App.h b/lib/APPTurtle/src/App.h index 8fddeacf..6deb2c17 100644 --- a/lib/APPTurtle/src/App.h +++ b/lib/APPTurtle/src/App.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Turtle Application. * @author Gabryel Reyes * diff --git a/lib/APPTurtle/src/CustomRosTransport.h b/lib/APPTurtle/src/CustomRosTransport.h index bbf69d1c..34c699aa 100644 --- a/lib/APPTurtle/src/CustomRosTransport.h +++ b/lib/APPTurtle/src/CustomRosTransport.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Custom Micro-ROS transport class selector. * @author Norbert Schulz * diff --git a/lib/APPTurtle/src/MicroRosClient.cpp b/lib/APPTurtle/src/MicroRosClient.cpp index 6019e2d7..69bbac5d 100644 --- a/lib/APPTurtle/src/MicroRosClient.cpp +++ b/lib/APPTurtle/src/MicroRosClient.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstraction of Micro-ROS Client. * @author Gabryel Reyes */ @@ -171,13 +172,9 @@ bool MicroRosClient::setupCustomTransport(const IPAddress& ipAddress, uint16_t p m_customRosTransport.init(ipAddress, port); - if (RCL_RET_OK != rmw_uros_set_custom_transport( - false, - &m_customRosTransport, - CustomRosTransportBase::open, - CustomRosTransportBase::close, - CustomRosTransportBase::write, - CustomRosTransportBase::read)) + if (RCL_RET_OK != rmw_uros_set_custom_transport(false, &m_customRosTransport, CustomRosTransportBase::open, + CustomRosTransportBase::close, CustomRosTransportBase::write, + CustomRosTransportBase::read)) { LOG_ERROR("Failed to set custom transport for Micro-ROS."); } @@ -288,10 +285,8 @@ void MicroRosClient::waitingForAgentState() if ((false == m_timer.isTimerRunning()) || (true == m_timer.isTimeout())) { String ipAddStr = m_customRosTransport.getIPAddressAsStr(); - LOG_INFO("Ping Micro-ROS agent %s:%s:%u ...", - m_customRosTransport.getProtocolName().c_str(), - ipAddStr.c_str(), - m_customRosTransport.getPort()); + LOG_INFO("Ping Micro-ROS agent %s:%s:%u ...", m_customRosTransport.getProtocolName().c_str(), + ipAddStr.c_str(), m_customRosTransport.getPort()); if (RMW_RET_OK == rmw_uros_ping_agent(MICRO_ROS_AGENT_PING_TIMEOUT, MICRO_ROS_AGENT_PING_ATTEMPTS)) { @@ -314,10 +309,8 @@ void MicroRosClient::connectingState() { String ipAddStr = m_customRosTransport.getIPAddressAsStr(); - LOG_INFO("Connecting to Micro-ROS agent %s:%s:%u ...", - m_customRosTransport.getProtocolName().c_str(), - ipAddStr.c_str(), - m_customRosTransport.getPort()); + LOG_INFO("Connecting to Micro-ROS agent %s:%s:%u ...", m_customRosTransport.getProtocolName().c_str(), + ipAddStr.c_str(), m_customRosTransport.getPort()); if (false == createEntities()) { @@ -325,11 +318,9 @@ void MicroRosClient::connectingState() } else { - LOG_INFO("Connected with Micro-ROS agent %s:%s:%u ...", - m_customRosTransport.getProtocolName().c_str(), - ipAddStr.c_str(), - m_customRosTransport.getPort()); - + LOG_INFO("Connected with Micro-ROS agent %s:%s:%u ...", m_customRosTransport.getProtocolName().c_str(), + ipAddStr.c_str(), m_customRosTransport.getPort()); + subscribe(); /* Periodically verify that the connection is still established. */ diff --git a/lib/APPTurtle/src/MicroRosClient.h b/lib/APPTurtle/src/MicroRosClient.h index c472b623..e91c036c 100644 --- a/lib/APPTurtle/src/MicroRosClient.h +++ b/lib/APPTurtle/src/MicroRosClient.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstraction of Micro-ROS Client. * @author Gabryel Reyes * diff --git a/lib/APPTurtle/src/SerialMuxChannels.h b/lib/APPTurtle/src/SerialMuxChannels.h index 58395492..6506430b 100644 --- a/lib/APPTurtle/src/SerialMuxChannels.h +++ b/lib/APPTurtle/src/SerialMuxChannels.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Channel structure definition for the SerialMuxProt. * @author Gabryel Reyes * diff --git a/lib/APPTurtle/src/Subscriber.h b/lib/APPTurtle/src/Subscriber.h index 58568f16..e46dcf47 100644 --- a/lib/APPTurtle/src/Subscriber.h +++ b/lib/APPTurtle/src/Subscriber.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Subscriber Class. * @author Gabryel Reyes * diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportBase.cpp b/lib/APPTurtle/src/Transports/CustomRosTransportBase.cpp index 8d301891..5e06d259 100644 --- a/lib/APPTurtle/src/Transports/CustomRosTransportBase.cpp +++ b/lib/APPTurtle/src/Transports/CustomRosTransportBase.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Custom Transport class with C-language interface for microros. * @author Norbert Schulz */ @@ -53,7 +54,7 @@ /** * Unwrap pointer to CustomRosTransportBase from uxrCustomTransport structure. - * + * * This is used by the static C-Languge entry points to forward the request * to the matching C++ member function. * @@ -73,26 +74,27 @@ static inline CustomRosTransportBase* toThis(const uxrCustomTransport* transport bool CustomRosTransportBase::open(uxrCustomTransport* transport) { - CustomRosTransportBase * tp = toThis(transport); + CustomRosTransportBase* tp = toThis(transport); return (nullptr != tp) ? tp->open() : false; } bool CustomRosTransportBase::close(uxrCustomTransport* transport) { - CustomRosTransportBase * tp = toThis(transport); + CustomRosTransportBase* tp = toThis(transport); return (nullptr != tp) ? tp->close() : false; } -size_t CustomRosTransportBase::write(uxrCustomTransport* transport, const uint8_t* buffer, size_t size, uint8_t* errorCode) +size_t CustomRosTransportBase::write(uxrCustomTransport* transport, const uint8_t* buffer, size_t size, + uint8_t* errorCode) { - CustomRosTransportBase * tp = toThis(transport); + CustomRosTransportBase* tp = toThis(transport); return (nullptr != tp) ? tp->write(buffer, size, errorCode) : 0U; } size_t CustomRosTransportBase::read(uxrCustomTransport* transport, uint8_t* buffer, size_t size, int timeout, - uint8_t* errorCode) + uint8_t* errorCode) { - CustomRosTransportBase * tp = toThis(transport); + CustomRosTransportBase* tp = toThis(transport); return (nullptr != tp) ? tp->read(buffer, size, timeout, errorCode) : 0U; } @@ -115,7 +117,7 @@ size_t CustomRosTransportBase::read(uxrCustomTransport* transport, uint8_t* buff static inline CustomRosTransportBase* toThis(const uxrCustomTransport* transport) { CustomRosTransportBase* transportClass = nullptr; - + if (nullptr == transport) { LOG_FATAL("Invalid uxrCustomTransport pointer."); diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportBase.h b/lib/APPTurtle/src/Transports/CustomRosTransportBase.h index e3a5f452..0e3adddc 100644 --- a/lib/APPTurtle/src/Transports/CustomRosTransportBase.h +++ b/lib/APPTurtle/src/Transports/CustomRosTransportBase.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Custom Transport class with C-language interface for microros. * @author Norbert Schulz * @@ -165,7 +166,7 @@ class CustomRosTransportBase */ static size_t read(uxrCustomTransport* transport, uint8_t* buffer, size_t size, int timeout, uint8_t* errorCode); - /** + /** * Get protocol name used by this transport. * @return Protocol name */ @@ -214,8 +215,8 @@ class CustomRosTransportBase */ static const int DEFAULT_PORT = 8888; - IPAddress m_address; /**< IP address of the Micro-ROS agent. */ - uint16_t m_port; /**< Port of the Micro-ROS agent. */ + IPAddress m_address; /**< IP address of the Micro-ROS agent. */ + uint16_t m_port; /**< Port of the Micro-ROS agent. */ }; /****************************************************************************** diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportTcp.cpp b/lib/APPTurtle/src/Transports/CustomRosTransportTcp.cpp index 82bc53f4..27f0e955 100644 --- a/lib/APPTurtle/src/Transports/CustomRosTransportTcp.cpp +++ b/lib/APPTurtle/src/Transports/CustomRosTransportTcp.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Custom Micro-ROS transport using TCP over Arduino WifiClient. * @author Norbert Schulz */ @@ -60,14 +61,9 @@ const String CustomRosTransportTcp::m_protocolName("TCP"); -const CustomRosTransportTcp::ReadFunc -CustomRosTransportTcp::m_readFunction[InputState::INPUT_STATE_MAX] = -{ - &CustomRosTransportTcp::readSizePrefix, - &CustomRosTransportTcp::readPendingSizePrefix, - &CustomRosTransportTcp::readPayload, - &CustomRosTransportTcp::readFinish -}; +const CustomRosTransportTcp::ReadFunc CustomRosTransportTcp::m_readFunction[InputState::INPUT_STATE_MAX] = { + &CustomRosTransportTcp::readSizePrefix, &CustomRosTransportTcp::readPendingSizePrefix, + &CustomRosTransportTcp::readPayload, &CustomRosTransportTcp::readFinish}; /****************************************************************************** * Public Methods @@ -163,7 +159,7 @@ size_t CustomRosTransportTcp::read(uint8_t* buffer, size_t size, int timeout, ui ReadFunc stateReadFunc = m_readFunction[m_inputState]; /* Read message portion based on reveiver state. */ - loop = (this->*stateReadFunc)(timeout, errorCode); + loop = (this->*stateReadFunc)(timeout, errorCode); } else { diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportTcp.h b/lib/APPTurtle/src/Transports/CustomRosTransportTcp.h index 55b7d423..56ca3b90 100644 --- a/lib/APPTurtle/src/Transports/CustomRosTransportTcp.h +++ b/lib/APPTurtle/src/Transports/CustomRosTransportTcp.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Custom Micro-ROS transport using TCP over Arduino WifiClient. * @author Norbert Schulz * diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportUdp.cpp b/lib/APPTurtle/src/Transports/CustomRosTransportUdp.cpp index 0d0b0941..56a2f0b5 100644 --- a/lib/APPTurtle/src/Transports/CustomRosTransportUdp.cpp +++ b/lib/APPTurtle/src/Transports/CustomRosTransportUdp.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Custom Micro-ROS transport over UDP. * @author Gabryel Reyes */ @@ -54,12 +55,11 @@ * Prototypes *****************************************************************************/ - /****************************************************************************** * Local Variables *****************************************************************************/ - const String CustomRosTransportUdp::m_protocolName("UDP"); +const String CustomRosTransportUdp::m_protocolName("UDP"); /****************************************************************************** * Public Methods diff --git a/lib/APPTurtle/src/Transports/CustomRosTransportUdp.h b/lib/APPTurtle/src/Transports/CustomRosTransportUdp.h index cb7f7505..782fdf28 100644 --- a/lib/APPTurtle/src/Transports/CustomRosTransportUdp.h +++ b/lib/APPTurtle/src/Transports/CustomRosTransportUdp.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Custom Micro-ROS transport using UDP over Arduino WiFiUdp. * @author Gabryel Reyes * @@ -54,7 +55,7 @@ * Types and Classes *****************************************************************************/ -/** +/** * Map this transport to the class name used in MicroRosClient. * The used transport is a compile time decision and this typedef * avoids the use of ifdef's. @@ -84,7 +85,7 @@ class CustomRosTransportUdp : public CustomRosTransportBase { } - /** + /** * Get protocol name used by this transport. * @return Protocol name */ @@ -131,9 +132,8 @@ class CustomRosTransportUdp : public CustomRosTransportBase */ size_t read(uint8_t* buffer, size_t size, int timeout, uint8_t* errorCode) final; - WiFiUDP m_udpClient; /**< UDP client */ - static const String m_protocolName; /**< This protocol name. */ - + WiFiUDP m_udpClient; /**< UDP client */ + static const String m_protocolName; /**< This protocol name. */ }; /****************************************************************************** diff --git a/lib/HALInterfaces/src/IBattery.h b/lib/HALInterfaces/src/IBattery.h index 71f5c9cb..1f07434e 100644 --- a/lib/HALInterfaces/src/IBattery.h +++ b/lib/HALInterfaces/src/IBattery.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract battery interface * @author Gabryel Reyes * diff --git a/lib/HALInterfaces/src/IBoard.h b/lib/HALInterfaces/src/IBoard.h index 70008bbe..c3d37c30 100644 --- a/lib/HALInterfaces/src/IBoard.h +++ b/lib/HALInterfaces/src/IBoard.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Board interface, which abstracts the physical board * @author Andreas Merkle * diff --git a/lib/HALInterfaces/src/IButton.h b/lib/HALInterfaces/src/IButton.h index 36c90ffc..1dd78514 100644 --- a/lib/HALInterfaces/src/IButton.h +++ b/lib/HALInterfaces/src/IButton.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract button interface * @author Andreas Merkle * diff --git a/lib/HALInterfaces/src/IFileHandler.h b/lib/HALInterfaces/src/IFileHandler.h index 2180e5de..55f78cbe 100644 --- a/lib/HALInterfaces/src/IFileHandler.h +++ b/lib/HALInterfaces/src/IFileHandler.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief File Handler Interface + * @file + * @brief File Handler Interface * @author Gabryel Reyes */ diff --git a/lib/HALInterfaces/src/IGps.h b/lib/HALInterfaces/src/IGps.h index 7db10518..0c59d657 100644 --- a/lib/HALInterfaces/src/IGps.h +++ b/lib/HALInterfaces/src/IGps.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief GPS Interface. * @author Gabryel Reyes * diff --git a/lib/HALInterfaces/src/ILed.h b/lib/HALInterfaces/src/ILed.h index c58d11b1..623b9c94 100644 --- a/lib/HALInterfaces/src/ILed.h +++ b/lib/HALInterfaces/src/ILed.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract LED interface * @author Andreas Merkle * diff --git a/lib/HALInterfaces/src/IMqttClient.h b/lib/HALInterfaces/src/IMqttClient.h index 5d189553..fe1b0092 100644 --- a/lib/HALInterfaces/src/IMqttClient.h +++ b/lib/HALInterfaces/src/IMqttClient.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract MQTT Client interface * @author Andreas Merkle * diff --git a/lib/HALInterfaces/src/INetwork.h b/lib/HALInterfaces/src/INetwork.h index 3bc8a643..cb93e38f 100644 --- a/lib/HALInterfaces/src/INetwork.h +++ b/lib/HALInterfaces/src/INetwork.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract network interface * @author Andreas Merkle * diff --git a/lib/HALInterfaces/src/IRobot.h b/lib/HALInterfaces/src/IRobot.h index 0aa7fb54..d6753be9 100644 --- a/lib/HALInterfaces/src/IRobot.h +++ b/lib/HALInterfaces/src/IRobot.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract robot interface * @author Andreas Merkle * diff --git a/lib/HALSim/src/Battery.cpp b/lib/HALSim/src/Battery.cpp index f9570b08..c9c21e27 100644 --- a/lib/HALSim/src/Battery.cpp +++ b/lib/HALSim/src/Battery.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Battery realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/Battery.h b/lib/HALSim/src/Battery.h index d7303d3b..66806099 100644 --- a/lib/HALSim/src/Battery.h +++ b/lib/HALSim/src/Battery.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Battery realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/Board.cpp b/lib/HALSim/src/Board.cpp index 5f8c9d30..ad5fb616 100644 --- a/lib/HALSim/src/Board.cpp +++ b/lib/HALSim/src/Board.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief The simulation board realization. * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/Board.h b/lib/HALSim/src/Board.h index 81844f46..5ef9c547 100644 --- a/lib/HALSim/src/Board.h +++ b/lib/HALSim/src/Board.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief The simulation board realization. * @author Gabryel Reyes * diff --git a/lib/HALSim/src/ButtonA.cpp b/lib/HALSim/src/ButtonA.cpp index 1fbb316a..d9d8df42 100644 --- a/lib/HALSim/src/ButtonA.cpp +++ b/lib/HALSim/src/ButtonA.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "A" realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/ButtonA.h b/lib/HALSim/src/ButtonA.h index 830e9bd4..c11f7930 100644 --- a/lib/HALSim/src/ButtonA.h +++ b/lib/HALSim/src/ButtonA.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "A" realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/ButtonB.cpp b/lib/HALSim/src/ButtonB.cpp index af991a75..e95e33f6 100644 --- a/lib/HALSim/src/ButtonB.cpp +++ b/lib/HALSim/src/ButtonB.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "B" realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/ButtonB.h b/lib/HALSim/src/ButtonB.h index b0747d60..a730dbe3 100644 --- a/lib/HALSim/src/ButtonB.h +++ b/lib/HALSim/src/ButtonB.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "B" realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/ButtonC.cpp b/lib/HALSim/src/ButtonC.cpp index 914b498d..9b07bb23 100644 --- a/lib/HALSim/src/ButtonC.cpp +++ b/lib/HALSim/src/ButtonC.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "C" realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/ButtonC.h b/lib/HALSim/src/ButtonC.h index 825531c7..76232b5c 100644 --- a/lib/HALSim/src/ButtonC.h +++ b/lib/HALSim/src/ButtonC.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "C" realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/ButtonReset.cpp b/lib/HALSim/src/ButtonReset.cpp index 5cefad74..a60cf72b 100644 --- a/lib/HALSim/src/ButtonReset.cpp +++ b/lib/HALSim/src/ButtonReset.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "Reset" realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/ButtonReset.h b/lib/HALSim/src/ButtonReset.h index c086c4c2..56af965c 100644 --- a/lib/HALSim/src/ButtonReset.h +++ b/lib/HALSim/src/ButtonReset.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "Reset" realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/FileHandler.cpp b/lib/HALSim/src/FileHandler.cpp index 5ed82dcc..dce88f88 100644 --- a/lib/HALSim/src/FileHandler.cpp +++ b/lib/HALSim/src/FileHandler.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief File Handler + * @file + * @brief File Handler * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/FileHandler.h b/lib/HALSim/src/FileHandler.h index 0c3f1265..96299533 100644 --- a/lib/HALSim/src/FileHandler.h +++ b/lib/HALSim/src/FileHandler.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief FileHandler implementation. * @author Gabryel Reyes * diff --git a/lib/HALSim/src/Gps.cpp b/lib/HALSim/src/Gps.cpp index 72c5b1e2..cd070faf 100644 --- a/lib/HALSim/src/Gps.cpp +++ b/lib/HALSim/src/Gps.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Global Positioning Sensor (GPS) module. * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/Gps.h b/lib/HALSim/src/Gps.h index 7840439f..a2a42c7c 100644 --- a/lib/HALSim/src/Gps.h +++ b/lib/HALSim/src/Gps.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Global Positioning Sensor (GPS) module. * @author Gabryel Reyes * diff --git a/lib/HALSim/src/IReceiver.h b/lib/HALSim/src/IReceiver.h index 9dea9fb7..a8d893ba 100644 --- a/lib/HALSim/src/IReceiver.h +++ b/lib/HALSim/src/IReceiver.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,9 +25,10 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract receiver interface * @author Andreas Merkle - * + * * @addtogroup HALInterfaces * * @{ @@ -66,7 +67,7 @@ class IReceiver /** * Set channel which to receive data from. - * + * * @param[in] channel The channel which to use. */ virtual void setChannel(int32_t channel) = 0; @@ -76,7 +77,7 @@ class IReceiver * * @param[in] data Data buffer. * @param[in] size Data buffer size in bytes. - * + * * @return Number of bytes read from stream. */ virtual size_t receive(void* data, size_t size) = 0; diff --git a/lib/HALSim/src/IRobotNative.h b/lib/HALSim/src/IRobotNative.h index 7a567b6b..c5c1a782 100644 --- a/lib/HALSim/src/IRobotNative.h +++ b/lib/HALSim/src/IRobotNative.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract native robot interface * @author Andreas Merkle * diff --git a/lib/HALSim/src/ISender.h b/lib/HALSim/src/ISender.h index 558b226d..85c8bafb 100644 --- a/lib/HALSim/src/ISender.h +++ b/lib/HALSim/src/ISender.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,9 +25,10 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract sender interface * @author Andreas Merkle - * + * * @addtogroup HALInterfaces * * @{ @@ -66,7 +67,7 @@ class ISender /** * Set channel which to send data to. - * + * * @param[in] channel The channel which to use. */ virtual void setChannel(int32_t channel) = 0; @@ -76,7 +77,7 @@ class ISender * * @param[in] data Data buffer * @param[in] size Data buffer size in bytes. - * + * * @return Number of bytes written. */ virtual size_t send(const void* data, size_t size) const = 0; @@ -85,7 +86,7 @@ class ISender * Sends string to the configured channel. * * @param[in] str String which to send. - * + * * @return Number of bytes written. */ virtual size_t send(const char* str) const = 0; diff --git a/lib/HALSim/src/Keyboard.cpp b/lib/HALSim/src/Keyboard.cpp index dfc42e93..27077894 100644 --- a/lib/HALSim/src/Keyboard.cpp +++ b/lib/HALSim/src/Keyboard.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Keyboard realization * @author Andreas Merkle */ diff --git a/lib/HALSim/src/Keyboard.h b/lib/HALSim/src/Keyboard.h index 588d5998..e36627e9 100644 --- a/lib/HALSim/src/Keyboard.h +++ b/lib/HALSim/src/Keyboard.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Keyboard realization * @author Andreas Merkle * diff --git a/lib/HALSim/src/LedA.cpp b/lib/HALSim/src/LedA.cpp index 9272c11d..6d427a4e 100644 --- a/lib/HALSim/src/LedA.cpp +++ b/lib/HALSim/src/LedA.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "A" LED realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/LedA.h b/lib/HALSim/src/LedA.h index 01f9ff2c..33d00d2e 100644 --- a/lib/HALSim/src/LedA.h +++ b/lib/HALSim/src/LedA.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "A" LED realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/LedB.cpp b/lib/HALSim/src/LedB.cpp index c9afb407..16e2a95b 100644 --- a/lib/HALSim/src/LedB.cpp +++ b/lib/HALSim/src/LedB.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "B" LED realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/LedB.h b/lib/HALSim/src/LedB.h index c5a6225f..e255e111 100644 --- a/lib/HALSim/src/LedB.h +++ b/lib/HALSim/src/LedB.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "B" LED realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/LedBlue.cpp b/lib/HALSim/src/LedBlue.cpp index 075d16b7..39389e3b 100644 --- a/lib/HALSim/src/LedBlue.cpp +++ b/lib/HALSim/src/LedBlue.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Blue LED realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/LedBlue.h b/lib/HALSim/src/LedBlue.h index a696245f..c8640b0a 100644 --- a/lib/HALSim/src/LedBlue.h +++ b/lib/HALSim/src/LedBlue.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Blue LED realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/LedC.cpp b/lib/HALSim/src/LedC.cpp index c1dfe5ef..c86fbc7a 100644 --- a/lib/HALSim/src/LedC.cpp +++ b/lib/HALSim/src/LedC.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "C" LED realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/LedC.h b/lib/HALSim/src/LedC.h index 31dfa76f..aef6c591 100644 --- a/lib/HALSim/src/LedC.h +++ b/lib/HALSim/src/LedC.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "C" LED realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/LedGreen.cpp b/lib/HALSim/src/LedGreen.cpp index d8e41869..e913165c 100644 --- a/lib/HALSim/src/LedGreen.cpp +++ b/lib/HALSim/src/LedGreen.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Green LED realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/LedGreen.h b/lib/HALSim/src/LedGreen.h index 7d047ef0..e132a357 100644 --- a/lib/HALSim/src/LedGreen.h +++ b/lib/HALSim/src/LedGreen.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Green LED realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/LedRed.cpp b/lib/HALSim/src/LedRed.cpp index 63ea9281..c9d7a4ad 100644 --- a/lib/HALSim/src/LedRed.cpp +++ b/lib/HALSim/src/LedRed.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Red LED realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/LedRed.h b/lib/HALSim/src/LedRed.h index 5ecd241e..fbc0d51f 100644 --- a/lib/HALSim/src/LedRed.h +++ b/lib/HALSim/src/LedRed.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Red LED realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/MqttClient.cpp b/lib/HALSim/src/MqttClient.cpp index 80c8416a..68d6a62c 100644 --- a/lib/HALSim/src/MqttClient.cpp +++ b/lib/HALSim/src/MqttClient.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief MQTTClient realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/MqttClient.h b/lib/HALSim/src/MqttClient.h index 25338ae8..84927690 100644 --- a/lib/HALSim/src/MqttClient.h +++ b/lib/HALSim/src/MqttClient.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief MQTTClient realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/Network.cpp b/lib/HALSim/src/Network.cpp index bb22b733..59d4b750 100644 --- a/lib/HALSim/src/Network.cpp +++ b/lib/HALSim/src/Network.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Network realization * @author Gabryel Reyes */ diff --git a/lib/HALSim/src/Network.h b/lib/HALSim/src/Network.h index b9c80921..c7aecb85 100644 --- a/lib/HALSim/src/Network.h +++ b/lib/HALSim/src/Network.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Network realization * @author Gabryel Reyes * diff --git a/lib/HALSim/src/Receiver.cpp b/lib/HALSim/src/Receiver.cpp index ea101e53..ff3c7115 100644 --- a/lib/HALSim/src/Receiver.cpp +++ b/lib/HALSim/src/Receiver.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Receiver realization * @author Andreas Merkle */ diff --git a/lib/HALSim/src/Receiver.h b/lib/HALSim/src/Receiver.h index 43b4bd0e..2b9dc5d4 100644 --- a/lib/HALSim/src/Receiver.h +++ b/lib/HALSim/src/Receiver.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Receiver realization * @author Andreas Merkle * @@ -90,7 +91,7 @@ class Receiver : public IReceiver * * @param[in] data Data buffer. * @param[in] size Data buffer size in bytes. - * + * * @return Number of bytes read from stream. */ size_t receive(void* data, size_t size) override; diff --git a/lib/HALSim/src/Robot.cpp b/lib/HALSim/src/Robot.cpp index 874305f1..10be6017 100644 --- a/lib/HALSim/src/Robot.cpp +++ b/lib/HALSim/src/Robot.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Robot realization * @author Andreas Merkle */ diff --git a/lib/HALSim/src/Robot.h b/lib/HALSim/src/Robot.h index fde36b70..8217cf36 100644 --- a/lib/HALSim/src/Robot.h +++ b/lib/HALSim/src/Robot.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Robot realization * @author Andreas Merkle * diff --git a/lib/HALSim/src/RobotDeviceNames.h b/lib/HALSim/src/RobotDeviceNames.h index 30515494..15ddebde 100644 --- a/lib/HALSim/src/RobotDeviceNames.h +++ b/lib/HALSim/src/RobotDeviceNames.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Robot device names in Webots * @author Andreas Merkle * diff --git a/lib/HALSim/src/Sender.cpp b/lib/HALSim/src/Sender.cpp index f12583e2..7528023e 100644 --- a/lib/HALSim/src/Sender.cpp +++ b/lib/HALSim/src/Sender.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Sender realization * @author Andreas Merkle */ diff --git a/lib/HALSim/src/Sender.h b/lib/HALSim/src/Sender.h index 8ab46388..0d4664f8 100644 --- a/lib/HALSim/src/Sender.h +++ b/lib/HALSim/src/Sender.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Sender realization * @author Andreas Merkle * @@ -90,7 +91,7 @@ class Sender : public ISender * * @param[in] data Data buffer. * @param[in] size Data buffer size in bytes. - * + * * @return Number of bytes sent. */ size_t send(const void* data, size_t size) const override; @@ -99,7 +100,7 @@ class Sender : public ISender * Sends string to the configured channel. * * @param[in] str String which to send. - * + * * @return Number of bytes sent. */ size_t send(const char* str) const override; diff --git a/lib/HALSim/src/SimTime.cpp b/lib/HALSim/src/SimTime.cpp index ac406173..1b260c56 100644 --- a/lib/HALSim/src/SimTime.cpp +++ b/lib/HALSim/src/SimTime.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Simulation time * @author Andreas Merkle */ diff --git a/lib/HALSim/src/SimTime.h b/lib/HALSim/src/SimTime.h index 3c45ddf0..5a670cce 100644 --- a/lib/HALSim/src/SimTime.h +++ b/lib/HALSim/src/SimTime.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Simulation time * @author Andreas Merkle * diff --git a/lib/HALSim/src/WebotsSerialDrv.cpp b/lib/HALSim/src/WebotsSerialDrv.cpp index a0d562da..10a267f7 100644 --- a/lib/HALSim/src/WebotsSerialDrv.cpp +++ b/lib/HALSim/src/WebotsSerialDrv.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Webots serial driver * @author Andreas Merkle */ diff --git a/lib/HALSim/src/WebotsSerialDrv.h b/lib/HALSim/src/WebotsSerialDrv.h index 253a79e0..cf4eb47f 100644 --- a/lib/HALSim/src/WebotsSerialDrv.h +++ b/lib/HALSim/src/WebotsSerialDrv.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Webots serial driver * @author Andreas Merkle * diff --git a/lib/HALTargetCommon/src/Battery.cpp b/lib/HALTargetCommon/src/Battery.cpp index d2f5ee3d..a31d765d 100644 --- a/lib/HALTargetCommon/src/Battery.cpp +++ b/lib/HALTargetCommon/src/Battery.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Battery realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/Battery.h b/lib/HALTargetCommon/src/Battery.h index 64ece817..20bdf789 100644 --- a/lib/HALTargetCommon/src/Battery.h +++ b/lib/HALTargetCommon/src/Battery.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Battery realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/Board.cpp b/lib/HALTargetCommon/src/Board.cpp index f3d2d4ae..4fff73a1 100644 --- a/lib/HALTargetCommon/src/Board.cpp +++ b/lib/HALTargetCommon/src/Board.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief The target board realization. * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/Board.h b/lib/HALTargetCommon/src/Board.h index 38ee66e8..73f56416 100644 --- a/lib/HALTargetCommon/src/Board.h +++ b/lib/HALTargetCommon/src/Board.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief The target board realization. * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/ButtonA.cpp b/lib/HALTargetCommon/src/ButtonA.cpp index cecab40d..b4906312 100644 --- a/lib/HALTargetCommon/src/ButtonA.cpp +++ b/lib/HALTargetCommon/src/ButtonA.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "A" realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/ButtonA.h b/lib/HALTargetCommon/src/ButtonA.h index 86e3f40c..ae48239e 100644 --- a/lib/HALTargetCommon/src/ButtonA.h +++ b/lib/HALTargetCommon/src/ButtonA.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "A" realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/ButtonB.cpp b/lib/HALTargetCommon/src/ButtonB.cpp index e180a486..50993456 100644 --- a/lib/HALTargetCommon/src/ButtonB.cpp +++ b/lib/HALTargetCommon/src/ButtonB.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "B" realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/ButtonB.h b/lib/HALTargetCommon/src/ButtonB.h index 82842092..bfd5c1fb 100644 --- a/lib/HALTargetCommon/src/ButtonB.h +++ b/lib/HALTargetCommon/src/ButtonB.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "B" realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/ButtonC.cpp b/lib/HALTargetCommon/src/ButtonC.cpp index 0a477baa..af3e4835 100644 --- a/lib/HALTargetCommon/src/ButtonC.cpp +++ b/lib/HALTargetCommon/src/ButtonC.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "C" realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/ButtonC.h b/lib/HALTargetCommon/src/ButtonC.h index d2575dca..d73762b6 100644 --- a/lib/HALTargetCommon/src/ButtonC.h +++ b/lib/HALTargetCommon/src/ButtonC.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "C" realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/ButtonDrv.cpp b/lib/HALTargetCommon/src/ButtonDrv.cpp index bc45f125..16c1a3ce 100644 --- a/lib/HALTargetCommon/src/ButtonDrv.cpp +++ b/lib/HALTargetCommon/src/ButtonDrv.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2019 - 2025 Andreas Merkle + * Copyright (c) 2019 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button driver * @author Andreas Merkle */ diff --git a/lib/HALTargetCommon/src/ButtonDrv.h b/lib/HALTargetCommon/src/ButtonDrv.h index 1386c5a2..bbb64bbb 100644 --- a/lib/HALTargetCommon/src/ButtonDrv.h +++ b/lib/HALTargetCommon/src/ButtonDrv.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2019 - 2025 Andreas Merkle + * Copyright (c) 2019 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button driver * @author Andreas Merkle * diff --git a/lib/HALTargetCommon/src/ButtonReset.cpp b/lib/HALTargetCommon/src/ButtonReset.cpp index ea85f747..4f577780 100644 --- a/lib/HALTargetCommon/src/ButtonReset.cpp +++ b/lib/HALTargetCommon/src/ButtonReset.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "Reset" realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/ButtonReset.h b/lib/HALTargetCommon/src/ButtonReset.h index ae926150..db5eff10 100644 --- a/lib/HALTargetCommon/src/ButtonReset.h +++ b/lib/HALTargetCommon/src/ButtonReset.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Button "Reset" realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/FileHandler.cpp b/lib/HALTargetCommon/src/FileHandler.cpp index 939312d5..93e3590b 100644 --- a/lib/HALTargetCommon/src/FileHandler.cpp +++ b/lib/HALTargetCommon/src/FileHandler.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief File Handler + * @file + * @brief File Handler * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/FileHandler.h b/lib/HALTargetCommon/src/FileHandler.h index c10c8d58..3694dcb6 100644 --- a/lib/HALTargetCommon/src/FileHandler.h +++ b/lib/HALTargetCommon/src/FileHandler.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief FileHandler implementation. * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/GPIO.cpp b/lib/HALTargetCommon/src/GPIO.cpp index 4077400a..84ab1d1a 100644 --- a/lib/HALTargetCommon/src/GPIO.cpp +++ b/lib/HALTargetCommon/src/GPIO.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief Abstraction of the GPIOs of the device. + * @file + * @brief Abstraction of the GPIOs of the device. * @author Gabryel Reyes */ @@ -118,20 +119,9 @@ const DOutPin GpioPins::ledCPin; *****************************************************************************/ /** A list of all used i/o pins, used for initialization. */ -static const IoPin* ioPinList[] = -{ - &resetButtonPin, - &resetDevicePin, - &infoLedRedPin, - &infoLedGreenPin, - &infoLedBluePin, - &batteryVoltagePin, - &buttonAPin, - &buttonBPin, - &buttonCPin, - &ledAPin, - &ledBPin, - &ledCPin, +static const IoPin* ioPinList[] = { + &resetButtonPin, &resetDevicePin, &infoLedRedPin, &infoLedGreenPin, &infoLedBluePin, &batteryVoltagePin, + &buttonAPin, &buttonBPin, &buttonCPin, &ledAPin, &ledBPin, &ledCPin, }; /****************************************************************************** diff --git a/lib/HALTargetCommon/src/GPIO.h b/lib/HALTargetCommon/src/GPIO.h index da0fa10c..894e4eeb 100644 --- a/lib/HALTargetCommon/src/GPIO.h +++ b/lib/HALTargetCommon/src/GPIO.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstraction of the GPIOs of the device. * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/Io.hpp b/lib/HALTargetCommon/src/Io.hpp index 0ccc004f..4aa70e58 100644 --- a/lib/HALTargetCommon/src/Io.hpp +++ b/lib/HALTargetCommon/src/Io.hpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief I/O abstraction * @author Andreas Merkle * diff --git a/lib/HALTargetCommon/src/LedA.cpp b/lib/HALTargetCommon/src/LedA.cpp index 01b8ad9c..46fc4a86 100644 --- a/lib/HALTargetCommon/src/LedA.cpp +++ b/lib/HALTargetCommon/src/LedA.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "A" LED realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/LedA.h b/lib/HALTargetCommon/src/LedA.h index c23ecd85..dc18fea6 100644 --- a/lib/HALTargetCommon/src/LedA.h +++ b/lib/HALTargetCommon/src/LedA.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "A" LED realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/LedB.cpp b/lib/HALTargetCommon/src/LedB.cpp index 55292ec5..5e2184b0 100644 --- a/lib/HALTargetCommon/src/LedB.cpp +++ b/lib/HALTargetCommon/src/LedB.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "B" LED realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/LedB.h b/lib/HALTargetCommon/src/LedB.h index 2e308a33..a110b724 100644 --- a/lib/HALTargetCommon/src/LedB.h +++ b/lib/HALTargetCommon/src/LedB.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "B" LED realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/LedBlue.cpp b/lib/HALTargetCommon/src/LedBlue.cpp index 2469e65c..19ed8c72 100644 --- a/lib/HALTargetCommon/src/LedBlue.cpp +++ b/lib/HALTargetCommon/src/LedBlue.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Blue LED realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/LedBlue.h b/lib/HALTargetCommon/src/LedBlue.h index 0b8be78b..44c5081d 100644 --- a/lib/HALTargetCommon/src/LedBlue.h +++ b/lib/HALTargetCommon/src/LedBlue.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Blue LED realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/LedC.cpp b/lib/HALTargetCommon/src/LedC.cpp index 7cbfc70b..2acd6375 100644 --- a/lib/HALTargetCommon/src/LedC.cpp +++ b/lib/HALTargetCommon/src/LedC.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "C" LED realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/LedC.h b/lib/HALTargetCommon/src/LedC.h index 8abeea41..ddb7b40b 100644 --- a/lib/HALTargetCommon/src/LedC.h +++ b/lib/HALTargetCommon/src/LedC.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief "C" LED realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/LedGreen.cpp b/lib/HALTargetCommon/src/LedGreen.cpp index 8fb3f3cb..f9d1b691 100644 --- a/lib/HALTargetCommon/src/LedGreen.cpp +++ b/lib/HALTargetCommon/src/LedGreen.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Green LED realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/LedGreen.h b/lib/HALTargetCommon/src/LedGreen.h index b9ba742b..328adeb4 100644 --- a/lib/HALTargetCommon/src/LedGreen.h +++ b/lib/HALTargetCommon/src/LedGreen.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Green LED realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/LedRed.cpp b/lib/HALTargetCommon/src/LedRed.cpp index 4e5e3cae..42d6f6b3 100644 --- a/lib/HALTargetCommon/src/LedRed.cpp +++ b/lib/HALTargetCommon/src/LedRed.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Red LED realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/LedRed.h b/lib/HALTargetCommon/src/LedRed.h index 0a0105f1..c30872a2 100644 --- a/lib/HALTargetCommon/src/LedRed.h +++ b/lib/HALTargetCommon/src/LedRed.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Red LED realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/MqttClient.cpp b/lib/HALTargetCommon/src/MqttClient.cpp index 31d6560b..a55b60e3 100644 --- a/lib/HALTargetCommon/src/MqttClient.cpp +++ b/lib/HALTargetCommon/src/MqttClient.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief MQTTClient realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/MqttClient.h b/lib/HALTargetCommon/src/MqttClient.h index 5cd0ccb3..a1642946 100644 --- a/lib/HALTargetCommon/src/MqttClient.h +++ b/lib/HALTargetCommon/src/MqttClient.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief MQTTClient realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/Network.cpp b/lib/HALTargetCommon/src/Network.cpp index 55894462..69a50715 100644 --- a/lib/HALTargetCommon/src/Network.cpp +++ b/lib/HALTargetCommon/src/Network.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Network realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/Network.h b/lib/HALTargetCommon/src/Network.h index a3871fa5..585d07b1 100644 --- a/lib/HALTargetCommon/src/Network.h +++ b/lib/HALTargetCommon/src/Network.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Network realization * @author Gabryel Reyes * diff --git a/lib/HALTargetCommon/src/Robot.cpp b/lib/HALTargetCommon/src/Robot.cpp index 8865da46..9921b3d2 100644 --- a/lib/HALTargetCommon/src/Robot.cpp +++ b/lib/HALTargetCommon/src/Robot.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Robot realization * @author Gabryel Reyes */ diff --git a/lib/HALTargetCommon/src/Robot.h b/lib/HALTargetCommon/src/Robot.h index 4adbdd64..32fea705 100644 --- a/lib/HALTargetCommon/src/Robot.h +++ b/lib/HALTargetCommon/src/Robot.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Robot realization * @author Gabryel Reyes * diff --git a/lib/HALTargetV1/src/Pin.h b/lib/HALTargetV1/src/Pin.h index 567f0244..92e04351 100644 --- a/lib/HALTargetV1/src/Pin.h +++ b/lib/HALTargetV1/src/Pin.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Pin definition for the target board. * @author Gabryel Reyes * diff --git a/lib/HALTargetV1/src/USBHostDriver.cpp b/lib/HALTargetV1/src/USBHostDriver.cpp index 7328d309..bba32c6e 100644 --- a/lib/HALTargetV1/src/USBHostDriver.cpp +++ b/lib/HALTargetV1/src/USBHostDriver.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstraction and Stream implementation of USB Host * @author Gabryel Reyes */ diff --git a/lib/HALTargetV1/src/USBHostDriver.h b/lib/HALTargetV1/src/USBHostDriver.h index 4422776f..ac612de8 100644 --- a/lib/HALTargetV1/src/USBHostDriver.h +++ b/lib/HALTargetV1/src/USBHostDriver.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstraction and Stream implementation of USB Host * @author Gabryel Reyes * diff --git a/lib/HALTest/src/FileHandler.cpp b/lib/HALTest/src/FileHandler.cpp index b1231244..889c3bd5 100644 --- a/lib/HALTest/src/FileHandler.cpp +++ b/lib/HALTest/src/FileHandler.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief File Handler + * @file + * @brief File Handler * @author Gabryel Reyes */ diff --git a/lib/HALTest/src/FileHandler.h b/lib/HALTest/src/FileHandler.h index 0c3f1265..96299533 100644 --- a/lib/HALTest/src/FileHandler.h +++ b/lib/HALTest/src/FileHandler.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief FileHandler implementation. * @author Gabryel Reyes * diff --git a/lib/HALTest/src/MqttClient.cpp b/lib/HALTest/src/MqttClient.cpp index 1abb8de6..3ffd6e63 100644 --- a/lib/HALTest/src/MqttClient.cpp +++ b/lib/HALTest/src/MqttClient.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief MQTTClient realization * @author Gabryel Reyes */ diff --git a/lib/HALTest/src/MqttClient.h b/lib/HALTest/src/MqttClient.h index cc68e79a..41048202 100644 --- a/lib/HALTest/src/MqttClient.h +++ b/lib/HALTest/src/MqttClient.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief MQTTClient realization * @author Gabryel Reyes * diff --git a/lib/MainNative/src/main.cpp b/lib/MainNative/src/main.cpp index 5e332afa..83942141 100644 --- a/lib/MainNative/src/main.cpp +++ b/lib/MainNative/src/main.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Main entry point * @author Gabryel Reyes */ diff --git a/lib/MainTestNative/src/main.cpp b/lib/MainTestNative/src/main.cpp index cee11abe..4300b8b6 100644 --- a/lib/MainTestNative/src/main.cpp +++ b/lib/MainTestNative/src/main.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Main entry point * @author Gabryel Reyes */ diff --git a/lib/Os/src/CriticalSection.hpp b/lib/Os/src/CriticalSection.hpp index 5c8406bc..112183c7 100644 --- a/lib/Os/src/CriticalSection.hpp +++ b/lib/Os/src/CriticalSection.hpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2019 - 2025 Andreas Merkle + * Copyright (c) 2019 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,9 +25,10 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief freeRTOS critical section wrapper * @author Andreas Merkle - * + * * @addtogroup OPERATING_SYSTEM * * @{ @@ -61,12 +62,10 @@ class CriticalSection { public: - /** * Create critical section wrapper. */ - CriticalSection() : - m_spinlock(portMUX_INITIALIZER_UNLOCKED) + CriticalSection() : m_spinlock(portMUX_INITIALIZER_UNLOCKED) { } @@ -94,12 +93,10 @@ class CriticalSection } private: - - portMUX_TYPE m_spinlock; /**< Spinlock */ + portMUX_TYPE m_spinlock; /**< Spinlock */ CriticalSection(const CriticalSection& CriticalSection); CriticalSection& operator=(const CriticalSection& CriticalSection); - }; /** @@ -109,14 +106,12 @@ class CriticalSection class CriticalSectionGuard { public: - /** * Creates the critical section guard and enters it. - * + * * @param[in] critSec The guard uses this critical section for protection. */ - CriticalSectionGuard(CriticalSection& critSec) : - m_criticalSection(critSec) + CriticalSectionGuard(CriticalSection& critSec) : m_criticalSection(critSec) { m_criticalSection.enter(); } @@ -130,19 +125,17 @@ class CriticalSectionGuard } private: - - CriticalSection& m_criticalSection; /**< Critical section used for the guard. */ + CriticalSection& m_criticalSection; /**< Critical section used for the guard. */ CriticalSectionGuard(); CriticalSectionGuard(const CriticalSectionGuard& guard); - CriticalSectionGuard& operator=(const CriticalSectionGuard& guard); - + CriticalSectionGuard& operator=(const CriticalSectionGuard& guard); }; /****************************************************************************** * Functions *****************************************************************************/ -#endif /* CRITICAL_SECTION_HPP */ +#endif /* CRITICAL_SECTION_HPP */ /** @} */ \ No newline at end of file diff --git a/lib/Os/src/Mutex.hpp b/lib/Os/src/Mutex.hpp index 10ab871b..05ed304a 100644 --- a/lib/Os/src/Mutex.hpp +++ b/lib/Os/src/Mutex.hpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2019 - 2025 Andreas Merkle + * Copyright (c) 2019 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,9 +25,10 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief freeRTOS mutex wrapper * @author Andreas Merkle - * + * * @addtogroup OPERATING_SYSTEM * * @{ @@ -61,12 +62,10 @@ class Mutex { public: - /** * Create mutex wrapper. */ - Mutex() : - m_mutexHandle(nullptr) + Mutex() : m_mutexHandle(nullptr) { } @@ -80,7 +79,7 @@ class Mutex /** * Create mutex. - * + * * @return If successful created, it will return true otherwise false. */ bool create() @@ -114,7 +113,7 @@ class Mutex /** * Is mutex allocated? - * + * * @return If mutex is allocated it will return true otherwise false. */ bool isAllocated() const @@ -125,9 +124,9 @@ class Mutex /** * Take the mutex. * If blockTime is portMAX_DELAY, it will wait infinite. - * + * * @param[in] blockTime Max. time in ticks, it shall wait for the mutex. - * + * * @return If mutex is taken, it will return true otherwise false. */ bool take(TickType_t blockTime) @@ -147,7 +146,7 @@ class Mutex /** * Give the mutex. - * + * * @return If mutex is given, it will return true otherwise false. */ bool give() @@ -166,12 +165,10 @@ class Mutex } private: - - SemaphoreHandle_t m_mutexHandle; /**< Mutex handle */ + SemaphoreHandle_t m_mutexHandle; /**< Mutex handle */ Mutex(const Mutex& mutex); Mutex& operator=(const Mutex& mutex); - }; /** @@ -180,12 +177,10 @@ class Mutex class MutexRecursive { public: - /** * Create mutex wrapper. */ - MutexRecursive() : - m_mutexHandle(nullptr) + MutexRecursive() : m_mutexHandle(nullptr) { } @@ -199,7 +194,7 @@ class MutexRecursive /** * Create mutex. - * + * * @return If successful created, it will return true otherwise false. */ bool create() @@ -233,7 +228,7 @@ class MutexRecursive /** * Is mutex allocated? - * + * * @return If mutex is allocated it will return true otherwise false. */ bool isAllocated() const @@ -244,9 +239,9 @@ class MutexRecursive /** * Take the mutex. * If blockTime is portMAX_DELAY, it will wait infinite. - * + * * @param[in] blockTime Max. time in ticks, it shall wait for the mutex. - * + * * @return If mutex is taken, it will return true otherwise false. */ bool take(TickType_t blockTime) @@ -266,7 +261,7 @@ class MutexRecursive /** * Give the mutex. - * + * * @return If mutex is given, it will return true otherwise false. */ bool give() @@ -285,33 +280,29 @@ class MutexRecursive } private: - - SemaphoreHandle_t m_mutexHandle; /**< Mutex handle */ + SemaphoreHandle_t m_mutexHandle; /**< Mutex handle */ MutexRecursive(const MutexRecursive& mutex); MutexRecursive& operator=(const MutexRecursive& mutex); - }; /** * The mutex guard takes the mutex at creation and gives it back during * destruction. - * + * * @tparam T Kind of mutex */ -template < typename T > +template class MutexGuard { public: - /** * Creates the mutex guard and takes the mutex. * It will wait infinite, till it gets it. - * + * * @param[in] mutex The guard uses this mutex for protection. */ - MutexGuard(T& mutex) : - m_mutex(mutex) + MutexGuard(T& mutex) : m_mutex(mutex) { (void)this->m_mutex.take(portMAX_DELAY); } @@ -325,19 +316,17 @@ class MutexGuard } private: - - T& m_mutex; /**< Mutex used for the guard. */ + T& m_mutex; /**< Mutex used for the guard. */ MutexGuard(); MutexGuard(const MutexGuard& guard); - MutexGuard& operator=(const MutexGuard& guard); - + MutexGuard& operator=(const MutexGuard& guard); }; /****************************************************************************** * Functions *****************************************************************************/ -#endif /* MUTEX_HPP */ +#endif /* MUTEX_HPP */ /** @} */ \ No newline at end of file diff --git a/lib/Os/src/Queue.hpp b/lib/Os/src/Queue.hpp index dbff9ad4..ca060dba 100644 --- a/lib/Os/src/Queue.hpp +++ b/lib/Os/src/Queue.hpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2019 - 2025 Andreas Merkle + * Copyright (c) 2019 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief freeRTOS queue wrapper * @author Andreas Merkle * @@ -59,16 +60,14 @@ * * @tparam T Item type */ -template < typename T > +template class Queue { public: - /** * Create queue wrapper. */ - Queue() : - m_queueHandle(nullptr) + Queue() : m_queueHandle(nullptr) { } @@ -206,7 +205,6 @@ class Queue } private: - QueueHandle_t m_queueHandle; /**< Queue handle */ Queue(const Queue& queue); diff --git a/lib/Os/src/Task.hpp b/lib/Os/src/Task.hpp index 64d9547c..c1f97979 100644 --- a/lib/Os/src/Task.hpp +++ b/lib/Os/src/Task.hpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2019 - 2025 Andreas Merkle + * Copyright (c) 2019 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief freeRTOS task wrapper * @author Andreas Merkle * @@ -69,11 +70,10 @@ * * @tparam T */ -template +template class Task { public: - /** * Task function type, which can be used to set a custom task function. * @@ -90,7 +90,8 @@ class Task * @param[in] priority Task priority. Optional, default is 1. * @param[in] core Core on which the task shall run. Optional, default is APP_CPU_NUM. */ - Task(const char* name, uint32_t stackSize = DEFAULT_STACK_SIZE, UBaseType_t priority = DEFAULT_PRIORITY, BaseType_t core = DEFAULT_CORE) : + Task(const char* name, uint32_t stackSize = DEFAULT_STACK_SIZE, UBaseType_t priority = DEFAULT_PRIORITY, + BaseType_t core = DEFAULT_CORE) : m_name(name), m_function(nullptr), m_stackSize(stackSize), @@ -114,7 +115,8 @@ class Task * @param[in] priority Task priority. Optional, default is 1. * @param[in] core Core on which the task shall run. Optional, default is APP_CPU_NUM. */ - Task(const char* name, TaskFunction function, uint32_t stackSize = DEFAULT_STACK_SIZE, UBaseType_t priority = DEFAULT_PRIORITY, BaseType_t core = DEFAULT_CORE) : + Task(const char* name, TaskFunction function, uint32_t stackSize = DEFAULT_STACK_SIZE, + UBaseType_t priority = DEFAULT_PRIORITY, BaseType_t core = DEFAULT_CORE) : m_name(name), m_function(function), m_stackSize(stackSize), @@ -150,7 +152,7 @@ class Task * If the task does not exit within the default timeout, it will be aborted. * * @param[in] timeout Timeout in ms for task stop (optional). - * + * * @return If successful, it will return true otherwise false. */ bool stop(uint32_t timeout = DEFAULT_TIMEOUT); @@ -165,7 +167,7 @@ class Task /** * Default stack size in bytes. */ - static const uint32_t DEFAULT_STACK_SIZE = 4096U; + static const uint32_t DEFAULT_STACK_SIZE = 4096U; /** * Default task priority. @@ -176,16 +178,15 @@ class Task * Default task core, which is the APP CPU core. * This is the default core on which the task shall run. */ - static const BaseType_t DEFAULT_CORE = APP_CPU_NUM; + static const BaseType_t DEFAULT_CORE = APP_CPU_NUM; /** * Default timeout in ms for task stop. * If the task does not stop within this time, it will be aborted. */ - static const uint32_t DEFAULT_TIMEOUT = 2000U; + static const uint32_t DEFAULT_TIMEOUT = 2000U; protected: - /** * The default process method, which can be overridden by the derived class. * @@ -197,7 +198,6 @@ class Task } private: - const char* m_name; /**< Name of the task */ TaskFunction m_function; /**< Task function to be called periodically, if set */ uint32_t m_stackSize; /**< Stack size in bytes */ @@ -211,14 +211,14 @@ class Task /** * Default constructor not allowed. */ - Task() = delete; + Task() = delete; /** * Copy constructor not allowed. * * @param[in] task Task to copy. */ - Task(const Task& task) = delete; + Task(const Task& task) = delete; /** * Assignment operator not allowed. @@ -238,7 +238,7 @@ class Task static void lowLevelTaskFunction(void* parameters); }; -template +template bool Task::start(T* parameters) { bool status = false; @@ -246,8 +246,8 @@ bool Task::start(T* parameters) /* Task not started yet? */ if (nullptr == m_taskHandle) { - m_parameters = parameters; - m_reqExit = false; + m_parameters = parameters; + m_reqExit = false; /* Create a semaphore to signal the task exit, if not created yet. */ m_exitSemaphore = xSemaphoreCreateBinary(); @@ -258,14 +258,8 @@ bool Task::start(T* parameters) if (pdTRUE == xSemaphoreGive(m_exitSemaphore)) { /* Create the task. */ - BaseType_t result = xTaskCreateUniversal( - lowLevelTaskFunction, - m_name, - m_stackSize, - this, - m_priority, - &m_taskHandle, - m_core); + BaseType_t result = xTaskCreateUniversal(lowLevelTaskFunction, m_name, m_stackSize, this, m_priority, + &m_taskHandle, m_core); if (pdPASS == result) { @@ -290,7 +284,7 @@ bool Task::start(T* parameters) return status; } -template +template bool Task::stop(uint32_t timeout) { bool status = false; @@ -315,13 +309,13 @@ bool Task::stop(uint32_t timeout) vSemaphoreDelete(m_exitSemaphore); m_exitSemaphore = nullptr; - status = true; + status = true; } return status; } -template +template bool Task::isRunning() const { bool isRunning = false; @@ -334,13 +328,12 @@ bool Task::isRunning() const return isRunning; } -template +template void Task::lowLevelTaskFunction(void* parameters) { Task* task = static_cast(parameters); - if ((nullptr != task) && - (nullptr != task->m_exitSemaphore)) + if ((nullptr != task) && (nullptr != task->m_exitSemaphore)) { /* Grab the semaphore which is used later to signal that the * task exited. diff --git a/lib/PlatoonService/src/CollisionAvoidance.h b/lib/PlatoonService/src/CollisionAvoidance.h index 732729cd..97111609 100644 --- a/lib/PlatoonService/src/CollisionAvoidance.h +++ b/lib/PlatoonService/src/CollisionAvoidance.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Collision Avoidance Module. * @author Gabryel Reyes * diff --git a/lib/PlatoonService/src/HeadingFinder.cpp b/lib/PlatoonService/src/HeadingFinder.cpp index 8fac6bb6..614bff7f 100644 --- a/lib/PlatoonService/src/HeadingFinder.cpp +++ b/lib/PlatoonService/src/HeadingFinder.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Heading Finder Module * @author Gabryel Reyes */ diff --git a/lib/PlatoonService/src/HeadingFinder.h b/lib/PlatoonService/src/HeadingFinder.h index ba68f6a0..8830f811 100644 --- a/lib/PlatoonService/src/HeadingFinder.h +++ b/lib/PlatoonService/src/HeadingFinder.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Heading Finder Module. * @author Gabryel Reyes * diff --git a/lib/PlatoonService/src/PlatoonUtils.cpp b/lib/PlatoonService/src/PlatoonUtils.cpp index 19f91728..633dbc0e 100644 --- a/lib/PlatoonService/src/PlatoonUtils.cpp +++ b/lib/PlatoonService/src/PlatoonUtils.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Utilities for calculation of waypoints and related quantities. * @author Gabryel Reyes */ diff --git a/lib/PlatoonService/src/PlatoonUtils.h b/lib/PlatoonService/src/PlatoonUtils.h index ffdb66dd..25326a29 100644 --- a/lib/PlatoonService/src/PlatoonUtils.h +++ b/lib/PlatoonService/src/PlatoonUtils.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Utilities for calculation of waypoints and related quantities. * @author Gabryel Reyes * diff --git a/lib/PlatoonService/src/Telemetry.h b/lib/PlatoonService/src/Telemetry.h index 6df10b11..5469bdec 100644 --- a/lib/PlatoonService/src/Telemetry.h +++ b/lib/PlatoonService/src/Telemetry.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Telemetry struct definition. * @author Gabryel Reyes * diff --git a/lib/PlatoonService/src/V2VCommManager.cpp b/lib/PlatoonService/src/V2VCommManager.cpp index 16ed6a91..909e04da 100644 --- a/lib/PlatoonService/src/V2VCommManager.cpp +++ b/lib/PlatoonService/src/V2VCommManager.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Vehicle to Vehicle (V2V) communication manager. * @author Gabryel Reyes */ diff --git a/lib/PlatoonService/src/V2VCommManager.h b/lib/PlatoonService/src/V2VCommManager.h index 1459f1fb..dacfaef7 100644 --- a/lib/PlatoonService/src/V2VCommManager.h +++ b/lib/PlatoonService/src/V2VCommManager.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Vehicle to Vehicle (V2V) communication manager. * @author Gabryel Reyes * diff --git a/lib/PlatoonService/src/V2VEvent.h b/lib/PlatoonService/src/V2VEvent.h index 04ee970c..d91f3643 100644 --- a/lib/PlatoonService/src/V2VEvent.h +++ b/lib/PlatoonService/src/V2VEvent.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief V2V Events definition. * @author Gabryel Reyes * diff --git a/lib/PlatoonService/src/Waypoint.cpp b/lib/PlatoonService/src/Waypoint.cpp index 9620cdc8..452f6b04 100644 --- a/lib/PlatoonService/src/Waypoint.cpp +++ b/lib/PlatoonService/src/Waypoint.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Definition of a Waypoint. * @author Gabryel Reyes */ diff --git a/lib/PlatoonService/src/Waypoint.h b/lib/PlatoonService/src/Waypoint.h index a6adbd32..22746649 100644 --- a/lib/PlatoonService/src/Waypoint.h +++ b/lib/PlatoonService/src/Waypoint.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Definition of a Waypoint. * @author Gabryel Reyes * diff --git a/lib/Service/src/ConfigurationKeys.h b/lib/Service/src/ConfigurationKeys.h index 854a3002..ecd74e19 100644 --- a/lib/Service/src/ConfigurationKeys.h +++ b/lib/Service/src/ConfigurationKeys.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Keys of the JSON structure of the configuration file. * @author Gabryel Reyes * diff --git a/lib/Service/src/IState.h b/lib/Service/src/IState.h index 2d59b46e..f50ab889 100644 --- a/lib/Service/src/IState.h +++ b/lib/Service/src/IState.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Abstract state interface * @author Andreas Merkle * diff --git a/lib/Service/src/PIDController.cpp b/lib/Service/src/PIDController.cpp index bed673f0..42d7a0d6 100644 --- a/lib/Service/src/PIDController.cpp +++ b/lib/Service/src/PIDController.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief PID regulator * @author Andreas Merkle */ diff --git a/lib/Service/src/PIDController.h b/lib/Service/src/PIDController.h index 8f75b020..f7995bbd 100644 --- a/lib/Service/src/PIDController.h +++ b/lib/Service/src/PIDController.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief PID regulator * @author Andreas Merkle * diff --git a/lib/Service/src/SettingsHandler.cpp b/lib/Service/src/SettingsHandler.cpp index d249d8db..10b3ad2c 100644 --- a/lib/Service/src/SettingsHandler.cpp +++ b/lib/Service/src/SettingsHandler.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Settings Handler for loading and managing configuration. * @author Gabryel Reyes */ diff --git a/lib/Service/src/SettingsHandler.h b/lib/Service/src/SettingsHandler.h index 6b7dd6c3..c082dc8f 100644 --- a/lib/Service/src/SettingsHandler.h +++ b/lib/Service/src/SettingsHandler.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Settings Handler for loading and managing configuration. * @author Gabryel Reyes * diff --git a/lib/Service/src/StateMachine.cpp b/lib/Service/src/StateMachine.cpp index 9f8c3dad..404b5cd5 100644 --- a/lib/Service/src/StateMachine.cpp +++ b/lib/Service/src/StateMachine.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Statemachine * @author Andreas Merkle */ diff --git a/lib/Service/src/StateMachine.h b/lib/Service/src/StateMachine.h index 939ea72f..42ff1a4f 100644 --- a/lib/Service/src/StateMachine.h +++ b/lib/Service/src/StateMachine.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Statemachine * @author Andreas Merkle * diff --git a/lib/UDPNative/src/WiFiUdp.cpp b/lib/UDPNative/src/WiFiUdp.cpp index 44954058..0e5c9a83 100644 --- a/lib/UDPNative/src/WiFiUdp.cpp +++ b/lib/UDPNative/src/WiFiUdp.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief UDP Client for Native platform. Emulation of WiFiUDP. * @author Gabryel Reyes */ diff --git a/lib/UDPNative/src/WiFiUdp.h b/lib/UDPNative/src/WiFiUdp.h index d9ee6c1a..335c56ee 100644 --- a/lib/UDPNative/src/WiFiUdp.h +++ b/lib/UDPNative/src/WiFiUdp.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief UDP Client for Native platform. Emulation of WiFiUdp. * @author Gabryel Reyes * diff --git a/lib/Utilities/src/FPMath.cpp b/lib/Utilities/src/FPMath.cpp index 7fa86dbf..a6a5fe35 100644 --- a/lib/Utilities/src/FPMath.cpp +++ b/lib/Utilities/src/FPMath.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Fixpoint math * @author Andreas Merkle */ diff --git a/lib/Utilities/src/FPMath.h b/lib/Utilities/src/FPMath.h index 39409bd4..1737135d 100644 --- a/lib/Utilities/src/FPMath.h +++ b/lib/Utilities/src/FPMath.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Fixpoint math * @author Andreas Merkle * diff --git a/lib/Utilities/src/LogSinkPrinter.cpp b/lib/Utilities/src/LogSinkPrinter.cpp index d59212c4..c037a914 100644 --- a/lib/Utilities/src/LogSinkPrinter.cpp +++ b/lib/Utilities/src/LogSinkPrinter.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Printer log sink * @author Andreas Merkle */ diff --git a/lib/Utilities/src/LogSinkPrinter.h b/lib/Utilities/src/LogSinkPrinter.h index 94572c2d..6defa1a3 100644 --- a/lib/Utilities/src/LogSinkPrinter.h +++ b/lib/Utilities/src/LogSinkPrinter.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Printer log sink * @author Andreas Merkle * diff --git a/lib/Utilities/src/Logging.cpp b/lib/Utilities/src/Logging.cpp index f1311e7d..9ed44f30 100644 --- a/lib/Utilities/src/Logging.cpp +++ b/lib/Utilities/src/Logging.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Logging * @author Yann Le Glaz */ diff --git a/lib/Utilities/src/Logging.h b/lib/Utilities/src/Logging.h index 6b066109..464a91b5 100644 --- a/lib/Utilities/src/Logging.h +++ b/lib/Utilities/src/Logging.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Logging * @author Yann Le Glaz * diff --git a/lib/Utilities/src/MovAvg.hpp b/lib/Utilities/src/MovAvg.hpp index ffe3161b..9c19d9cb 100644 --- a/lib/Utilities/src/MovAvg.hpp +++ b/lib/Utilities/src/MovAvg.hpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Moving average * @author Andreas Merkle * diff --git a/lib/Utilities/src/SimpleTimer.hpp b/lib/Utilities/src/SimpleTimer.hpp index 9e141bde..8bee845f 100644 --- a/lib/Utilities/src/SimpleTimer.hpp +++ b/lib/Utilities/src/SimpleTimer.hpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Simple timer * @author Andreas Merkle * diff --git a/lib/Utilities/src/Util.cpp b/lib/Utilities/src/Util.cpp index 78d8eaf4..9983e67a 100644 --- a/lib/Utilities/src/Util.cpp +++ b/lib/Utilities/src/Util.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Utility * @author Yann Le Glaz */ diff --git a/lib/Utilities/src/Util.h b/lib/Utilities/src/Util.h index 244ef658..5eafaa9e 100644 --- a/lib/Utilities/src/Util.h +++ b/lib/Utilities/src/Util.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Utility * @author Yann Le Glaz * diff --git a/lib/WiFiNative/src/IPAddress.cpp b/lib/WiFiNative/src/IPAddress.cpp index 9ea7a09a..8df6f3ea 100644 --- a/lib/WiFiNative/src/IPAddress.cpp +++ b/lib/WiFiNative/src/IPAddress.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief Implementation of IPAddress + * @file + * @brief Implementation of IPAddress * @author Norbert Schulz */ diff --git a/lib/WiFiNative/src/IPAddress.h b/lib/WiFiNative/src/IPAddress.h index 0f350617..db3171eb 100644 --- a/lib/WiFiNative/src/IPAddress.h +++ b/lib/WiFiNative/src/IPAddress.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief Minimal IPAddress API + * @file + * @brief Minimal IPAddress API * @author Norbert Schulz * * @addtogroup Arduino diff --git a/lib/WiFiNative/src/WiFi.cpp b/lib/WiFiNative/src/WiFi.cpp index 125dd257..0b29a7b7 100644 --- a/lib/WiFiNative/src/WiFi.cpp +++ b/lib/WiFiNative/src/WiFi.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief Mock WiFi class for ArduinoNative + * @file + * @brief Mock WiFi class for ArduinoNative * @author Gabryel Reyes */ diff --git a/lib/WiFiNative/src/WiFi.h b/lib/WiFiNative/src/WiFi.h index 4187da92..99dfd562 100644 --- a/lib/WiFiNative/src/WiFi.h +++ b/lib/WiFiNative/src/WiFi.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief Mock WiFi class for ArduinoNative + * @file + * @brief Mock WiFi class for ArduinoNative * @author Gabryel Reyes */ diff --git a/lib/WiFiNative/src/WiFiClient.h b/lib/WiFiNative/src/WiFiClient.h index 1c4b64cd..95cabac2 100644 --- a/lib/WiFiNative/src/WiFiClient.h +++ b/lib/WiFiNative/src/WiFiClient.h @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Wifi Client for Native platform. Emulation of Arduino WiFiClient. * @author Norbert Schulz * @@ -55,14 +56,13 @@ *****************************************************************************/ /** - * WiFiClient client class compatible with Arduino. - * + * WiFiClient client class compatible with Arduino. + * * Only a subset of API functions is supported, based on the actual demand. */ class WiFiClient { - public: - +public: /** * Default constructor. */ @@ -77,7 +77,7 @@ class WiFiClient /** * Establish a connection. - * + * * @param[in] addr Port number. * @param[in] port Port number. * @return If successful returns 1, otherwise 0. @@ -86,7 +86,7 @@ class WiFiClient /** * Indicate if client is connected. - * + * * @return If successful returns 1, otherwise 0. */ uint8_t connected() const; @@ -101,20 +101,19 @@ class WiFiClient * * The write uses non blocking socket mode, but retries on a * EWOULDBLOCK result. The constants SOCK_WRITE_RETRY and - * SOCK_WRITE_TMO_US define how often to retry and the + * SOCK_WRITE_TMO_US define how often to retry and the * time delay in between. - * + * * @param[in] buffer Byte Array to send. * @param[in] size Length of Buffer. - * + * * @returns Number of bytes written or 0 on error. */ size_t write(const uint8_t* buffer, size_t size); - /** * Check if there are available bytes in the Stream. - * + * * @returns Number of available bytes. */ int available() const; @@ -130,7 +129,7 @@ class WiFiClient int read(uint8_t* buffer, size_t size); private: - static const uint32_t SOCK_WRITE_RETRY = 4U; /**< How often to retry sending. */ + static const uint32_t SOCK_WRITE_RETRY = 4U; /**< How often to retry sending. */ static const uint32_t SOCK_WRITE_TMO_US = 250U; /**< Delay between write attemps. */ }; diff --git a/lib/WiFiNative/src/WifiClient.cpp b/lib/WiFiNative/src/WifiClient.cpp index 690d2d9b..6e1b6481 100644 --- a/lib/WiFiNative/src/WifiClient.cpp +++ b/lib/WiFiNative/src/WifiClient.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief WifiClient class for ArduinoNative. + * @file + * @brief WifiClient class for ArduinoNative. * @author Norbert Schulz */ diff --git a/lib/WiFiNative/src/WifiClientPosix.inl b/lib/WiFiNative/src/WifiClientPosix.inl index cf7bdeb8..b6efd03f 100644 --- a/lib/WiFiNative/src/WifiClientPosix.inl +++ b/lib/WiFiNative/src/WifiClientPosix.inl @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief WifiClient class for ArduinoNative. + * @file + * @brief WifiClient class for ArduinoNative. * @author Norbert Schulz */ @@ -90,7 +91,7 @@ uint8_t WiFiClient::connected() const uint8_t WiFiClient::connect(const IPAddress& addr, uint16_t port) { - uint8_t retval = 0U; + uint8_t retval = 0U; int socketFd = SOCK_INVAL; if (0U != connected()) diff --git a/lib/WiFiNative/src/WifiClientWinsock.inl b/lib/WiFiNative/src/WifiClientWinsock.inl index 347a67f4..f8cf41b9 100644 --- a/lib/WiFiNative/src/WifiClientWinsock.inl +++ b/lib/WiFiNative/src/WifiClientWinsock.inl @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,7 +25,8 @@ DESCRIPTION *******************************************************************************/ /** - * @brief WifiClient class for ArduinoNative (Winwsock 2 variant) + * @file + * @brief WifiClient class for ArduinoNative (Winwsock 2 variant) * @author Norbert Schulz */ diff --git a/scripts/add_os_specific_build_flags.py b/scripts/add_os_specific_build_flags.py index ba2c9ac7..23208666 100644 --- a/scripts/add_os_specific_build_flags.py +++ b/scripts/add_os_specific_build_flags.py @@ -2,7 +2,7 @@ # MIT License # -# Copyright (c) 2023 - 2025 Andreas Merkle +# Copyright (c) 2023 - 2026 Andreas Merkle # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -29,7 +29,7 @@ ################################################################################ import platform -Import("env") # pylint: disable=undefined-variable +Import("env") # pylint: disable=undefined-variable ################################################################################ # Variables @@ -52,4 +52,5 @@ ################################################################################ if OS_PLATFORM_TYPE == OS_PLATFORM_TYPE_WIN: - env.Append(BUILD_FLAGS=WINDOWS_BUILD_FLAGS) # pylint: disable=undefined-variable + env.Append( + BUILD_FLAGS=WINDOWS_BUILD_FLAGS) # pylint: disable=undefined-variable diff --git a/scripts/check_os.py b/scripts/check_os.py index 9741cbca..ee0b5631 100644 --- a/scripts/check_os.py +++ b/scripts/check_os.py @@ -2,7 +2,7 @@ # MIT License # -# Copyright (c) 2022 - 2025 Andreas Merkle (web@blue-andi.de) +# Copyright (c) 2022 - 2026 Andreas Merkle (web@blue-andi.de) # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal diff --git a/scripts/copy_webots_shared_libs.py b/scripts/copy_webots_shared_libs.py index ed27307e..5422c831 100644 --- a/scripts/copy_webots_shared_libs.py +++ b/scripts/copy_webots_shared_libs.py @@ -2,7 +2,7 @@ # MIT License # -# Copyright (c) 2022 - 2025 Andreas Merkle (web@blue-andi.de) +# Copyright (c) 2022 - 2026 Andreas Merkle (web@blue-andi.de) # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -30,7 +30,7 @@ import platform import sys -Import("env") # pylint: disable=undefined-variable +Import("env") # pylint: disable=undefined-variable ################################################################################ # Variables @@ -72,7 +72,7 @@ print(f"OS type {OS_PLATFORM_TYPE} not supported.") sys.exit(1) -PIO_ENV_NAME = env["PIOENV"] # pylint: disable=undefined-variable +PIO_ENV_NAME = env["PIOENV"] # pylint: disable=undefined-variable ################################################################################ # Classes diff --git a/scripts/create_webots_library.py b/scripts/create_webots_library.py index 564a8638..f450de03 100644 --- a/scripts/create_webots_library.py +++ b/scripts/create_webots_library.py @@ -2,7 +2,7 @@ # MIT License # -# Copyright (c) 2022 - 2025 Andreas Merkle (web@blue-andi.de) +# Copyright (c) 2022 - 2026 Andreas Merkle (web@blue-andi.de) # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -36,10 +36,10 @@ # Variables ################################################################################ -src_path_include_c = os.getenv('WEBOTS_HOME') + '/include/controller/c' -src_path_include_cpp = os.getenv('WEBOTS_HOME') + '/include/controller/cpp' -src_path_source = os.getenv('WEBOTS_HOME') + '/src/controller/cpp' -src_path_lib = os.getenv('WEBOTS_HOME') + '/lib/controller/libController' +src_path_include_c = os.getenv('WEBOTS_HOME') + '/include/controller/c' +src_path_include_cpp = os.getenv('WEBOTS_HOME') + '/include/controller/cpp' +src_path_source = os.getenv('WEBOTS_HOME') + '/src/controller/cpp' +src_path_lib = os.getenv('WEBOTS_HOME') + '/lib/controller/libController' OS_PLATFORM_TYPE_WIN = "Windows" OS_PLATFORM_TYPE_LINUX = "Linux" @@ -79,6 +79,7 @@ # Functions ################################################################################ + def copy_path_recursive(src, dst): """Copy all files from the source path to the destination path. @@ -88,10 +89,12 @@ def copy_path_recursive(src, dst): """ try: shutil.copytree(src, dst) - except OSError as exc: # python >2.5 + except OSError as exc: # python >2.5 if exc.errno in (errno.ENOTDIR, errno.EINVAL): shutil.copy(src, dst) - else: raise + else: + raise + def copy_single_file(src, dst): """Copy a single source file to the destination path. @@ -107,6 +110,7 @@ def copy_single_file(src, dst): # Main ################################################################################ + if os.path.exists(DST_PATH) is False: print(f'Create WEBOTS library to {DST_PATH}.') diff --git a/scripts/webots_launcher.py b/scripts/webots_launcher.py index f78a9164..e836a84e 100644 --- a/scripts/webots_launcher.py +++ b/scripts/webots_launcher.py @@ -2,7 +2,7 @@ # MIT License # -# Copyright (c) 2022 - 2025 Andreas Merkle (web@blue-andi.de) +# Copyright (c) 2022 - 2026 Andreas Merkle (web@blue-andi.de) # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal @@ -29,7 +29,7 @@ import sys import platform -Import("env") # pylint: disable=undefined-variable +Import("env") # pylint: disable=undefined-variable ################################################################################ # Variables @@ -39,23 +39,26 @@ OS_PLATFORM_TYPE_MACOS = "Darwin" OS_PLATFORM_TYPE = platform.system() -ROBOT_NAME = env.GetProjectOption("webots_robot_name") # pylint: disable=undefined-variable +ROBOT_NAME = env.GetProjectOption( + "webots_robot_name") # pylint: disable=undefined-variable -ROBOT_SERIAL_RX_CHANNEL = env.GetProjectOption("webots_robot_serial_rx_channel") # pylint: disable=undefined-variable -ROBOT_SERIAL_TX_CHANNEL = env.GetProjectOption("webots_robot_serial_tx_channel") # pylint: disable=undefined-variable +ROBOT_SERIAL_RX_CHANNEL = env.GetProjectOption( + "webots_robot_serial_rx_channel") # pylint: disable=undefined-variable +ROBOT_SERIAL_TX_CHANNEL = env.GetProjectOption( + "webots_robot_serial_tx_channel") # pylint: disable=undefined-variable PROGRAM_PATH = "$BUILD_DIR/" PROGRAM_OPTIONS = '--cfgFilePath "../../../data/config/config.json" ' \ - + '--serialRxCh ' + ROBOT_SERIAL_RX_CHANNEL + ' ' \ - + '--serialTxCh ' + ROBOT_SERIAL_TX_CHANNEL + ' ' \ - + '-v' + + '--serialRxCh ' + ROBOT_SERIAL_RX_CHANNEL + ' ' \ + + '--serialTxCh ' + ROBOT_SERIAL_TX_CHANNEL + ' ' \ + + '-v' WEBOTS_CONTROLLER_OPTIONS = '--robot-name=' + ROBOT_NAME + ' --stdout-redirect' WEBOTS_HOME = os.getenv('WEBOTS_HOME') if OS_PLATFORM_TYPE == OS_PLATFORM_TYPE_WIN: WEBOTS_HOME = WEBOTS_HOME.replace('\\', '/') - WEBOTS_CONTROLLER = "\"" + WEBOTS_CONTROLLER = "\"" WEBOTS_CONTROLLER += f"{WEBOTS_HOME}/msys64/mingw64/bin/webots-controller.exe" WEBOTS_CONTROLLER += "\"" PROGRAM_NAME = "${PROGNAME}.exe" @@ -75,9 +78,9 @@ sys.exit(1) WEBOTS_LAUNCHER_ACTION = WEBOTS_CONTROLLER + ' '\ - + WEBOTS_CONTROLLER_OPTIONS + ' ' \ - + PROGRAM_PATH + PROGRAM_NAME + ' ' \ - + PROGRAM_OPTIONS + + WEBOTS_CONTROLLER_OPTIONS + ' ' \ + + PROGRAM_PATH + PROGRAM_NAME + ' ' \ + + PROGRAM_OPTIONS ################################################################################ # Classes diff --git a/src/main.cpp b/src/main.cpp index dbcdc8bf..7bbc228e 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Main entry point * @author Andreas Merkle */ diff --git a/test/test_IPAddress/test_IPAddress.cpp b/test/test_IPAddress/test_IPAddress.cpp index 1300606b..cc0f5526 100644 --- a/test/test_IPAddress/test_IPAddress.cpp +++ b/test/test_IPAddress/test_IPAddress.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Test (some) IPAddress functions. * @author Norbert Schulz */ @@ -154,12 +155,12 @@ static void testIPAddrString(void) static void testIPAddrOperator(void) { IPAddress ip0; - + TEST_ASSERT_TRUE(ip0 == IPAddress()); - IPAddress ip1(11,12,19,94); - IPAddress ip2(25,04,19,68); - + IPAddress ip1(11, 12, 19, 94); + IPAddress ip2(25, 04, 19, 68); + TEST_ASSERT_TRUE(ip1 != ip2); TEST_ASSERT_FALSE(ip1 == ip2); diff --git a/test/test_PlatoonUtils/test_PlatoonUtils.cpp b/test/test_PlatoonUtils/test_PlatoonUtils.cpp index 467485f9..d46a87ab 100644 --- a/test/test_PlatoonUtils/test_PlatoonUtils.cpp +++ b/test/test_PlatoonUtils/test_PlatoonUtils.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Test PlatoonUtils. * @author Gabryel Reyes */ diff --git a/test/test_Util/test_Util.cpp b/test/test_Util/test_Util.cpp index c5f9dec2..4b4e669c 100644 --- a/test/test_Util/test_Util.cpp +++ b/test/test_Util/test_Util.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Test utility functions. * @author Andreas Merkle */ diff --git a/test/test_WString/test_WString.cpp b/test/test_WString/test_WString.cpp index e941c90e..f858fada 100644 --- a/test/test_WString/test_WString.cpp +++ b/test/test_WString/test_WString.cpp @@ -1,6 +1,6 @@ /* MIT License * - * Copyright (c) 2023 - 2025 Andreas Merkle + * Copyright (c) 2023 - 2026 Andreas Merkle * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -25,6 +25,7 @@ DESCRIPTION *******************************************************************************/ /** + * @file * @brief Test (some) WString functions. * @author Luca Dubies */