fixing trunk problems

This commit is contained in:
Jm Casler 2023-07-26 16:58:14 -07:00 committed by Thomas Göttgens
parent e9cbe54eca
commit 794948d7e4
5 changed files with 35 additions and 31 deletions

View File

@ -31,12 +31,12 @@ static void IRAM_ATTR onTimer()
/** /**
* Schedules a hardware callback function to be executed after a specified delay. * Schedules a hardware callback function to be executed after a specified delay.
* *
* @param callback The function to be executed. * @param callback The function to be executed.
* @param param1 The first parameter to be passed to the function. * @param param1 The first parameter to be passed to the function.
* @param param2 The second parameter to be passed to the function. * @param param2 The second parameter to be passed to the function.
* @param delayMsec The delay time in milliseconds before the function is executed. * @param delayMsec The delay time in milliseconds before the function is executed.
* *
* @return True if the function was successfully scheduled, false otherwise. * @return True if the function was successfully scheduled, false otherwise.
*/ */
bool scheduleHWCallback(PendableFunction callback, void *param1, uint32_t param2, uint32_t delayMsec) bool scheduleHWCallback(PendableFunction callback, void *param1, uint32_t param2, uint32_t delayMsec)

View File

@ -1,11 +1,12 @@
/** /**
* @file Power.cpp * @file Power.cpp
* @brief This file contains the implementation of the Power class, which is responsible for managing power-related functionality of the device. * @brief This file contains the implementation of the Power class, which is responsible for managing power-related functionality
* It includes battery level sensing, power management unit (PMU) control, and power state machine management. * of the device. It includes battery level sensing, power management unit (PMU) control, and power state machine management. The
* The Power class is used by the main device class to manage power-related functionality. * Power class is used by the main device class to manage power-related functionality.
* *
* The file also includes implementations of various battery level sensors, such as the AnalogBatteryLevel class, which assumes the battery voltage is attached via a voltage-divider to an analog input. * The file also includes implementations of various battery level sensors, such as the AnalogBatteryLevel class, which assumes
* * the battery voltage is attached via a voltage-divider to an analog input.
*
* This file is part of the Meshtastic project. * This file is part of the Meshtastic project.
* For more information, see: https://meshtastic.org/ * For more information, see: https://meshtastic.org/
*/ */
@ -379,7 +380,7 @@ bool Power::analogInit()
/** /**
* Initializes the Power class. * Initializes the Power class.
* *
* @return true if the setup was successful, false otherwise. * @return true if the setup was successful, false otherwise.
*/ */
bool Power::setup() bool Power::setup()

View File

@ -1,10 +1,10 @@
/** /**
* @file PowerFSM.cpp * @file PowerFSM.cpp
* @brief Implements the finite state machine for power management. * @brief Implements the finite state machine for power management.
* *
* This file contains the implementation of the finite state machine (FSM) for power management. * This file contains the implementation of the finite state machine (FSM) for power management.
* The FSM controls the power states of the device, including SDS (shallow deep sleep), LS (light sleep), * The FSM controls the power states of the device, including SDS (shallow deep sleep), LS (light sleep),
* NB (normal mode), and POWER (powered mode). The FSM also handles transitions between states and * NB (normal mode), and POWER (powered mode). The FSM also handles transitions between states and
* actions to be taken upon entering or exiting each state. * actions to be taken upon entering or exiting each state.
*/ */
#include "PowerFSM.h" #include "PowerFSM.h"

View File

@ -1,10 +1,10 @@
/** /**
* @file memGet.cpp * @file memGet.cpp
* @brief Implementation of MemGet class that provides functions to get memory information. * @brief Implementation of MemGet class that provides functions to get memory information.
* *
* This file contains the implementation of MemGet class that provides functions to get * This file contains the implementation of MemGet class that provides functions to get
* information about free heap, heap size, free psram and psram size. The functions are * information about free heap, heap size, free psram and psram size. The functions are
* implemented for ESP32 and NRF52 architectures. If the platform does not have heap * implemented for ESP32 and NRF52 architectures. If the platform does not have heap
* management function implemented, the functions return UINT32_MAX or 0. * management function implemented, the functions return UINT32_MAX or 0.
*/ */
#include "memGet.h" #include "memGet.h"
@ -60,7 +60,7 @@ uint32_t MemGet::getFreePsram()
/** /**
* @brief Returns the size of the PSRAM memory. * @brief Returns the size of the PSRAM memory.
* *
* @return uint32_t The size of the PSRAM memory. * @return uint32_t The size of the PSRAM memory.
*/ */
uint32_t MemGet::getPsramSize() uint32_t MemGet::getPsramSize()
@ -70,4 +70,4 @@ uint32_t MemGet::getPsramSize()
#else #else
return 0; return 0;
#endif #endif
} }

View File

@ -1,17 +1,20 @@
/** /**
* @file xmodem.cpp * @file xmodem.cpp
* @brief Implementation of XMODEM protocol for Meshtastic devices. * @brief Implementation of XMODEM protocol for Meshtastic devices.
* *
* This file contains the implementation of the XMODEM protocol for Meshtastic devices. It is based on the XMODEM implementation by Georges Menie (www.menie.org) and has been adapted for protobuf encapsulation. * This file contains the implementation of the XMODEM protocol for Meshtastic devices. It is based on the XMODEM implementation
* * by Georges Menie (www.menie.org) and has been adapted for protobuf encapsulation.
* The XMODEM protocol is used for reliable transmission of binary data over a serial connection. This implementation supports both sending and receiving of data. *
* * The XMODEM protocol is used for reliable transmission of binary data over a serial connection. This implementation supports
* The XModemAdapter class provides the main functionality for the protocol, including CRC calculation, packet handling, and control signal sending. * both sending and receiving of data.
* *
* The XModemAdapter class provides the main functionality for the protocol, including CRC calculation, packet handling, and
* control signal sending.
*
* @copyright Copyright (c) 2001-2019 Georges Menie * @copyright Copyright (c) 2001-2019 Georges Menie
* @author * @author
* @author * @author
* @date * @date
*/ */
/*********************************************************************************************************************** /***********************************************************************************************************************
* based on XMODEM implementation by Georges Menie (www.menie.org) * based on XMODEM implementation by Georges Menie (www.menie.org)
@ -53,7 +56,7 @@ XModemAdapter::XModemAdapter() {}
/** /**
* Calculates the CRC-16 CCITT checksum of the given buffer. * Calculates the CRC-16 CCITT checksum of the given buffer.
* *
* @param buffer The buffer to calculate the checksum for. * @param buffer The buffer to calculate the checksum for.
* @param length The length of the buffer. * @param length The length of the buffer.
* @return The calculated checksum. * @return The calculated checksum.
@ -245,4 +248,4 @@ void XModemAdapter::handlePacket(meshtastic_XModem xmodemPacket)
// Unknown control character // Unknown control character
break; break;
} }
} }