Clarification on what functions map to what modes

[Eqqman]

The STM32L071 has 5 low-power modes: Low-power Run, Sleep, Low-power Sleep, Stop, and Standby. The STM32LowPower library only has 4 modes: Idle, Sleep, DeepSleep, and Shutdown. The code's comments are not consistent in describing what STM mode corresponds to what library mode, leading to confusion on which should be used. I had thought I had found bugs in the library code until I realized it was the comments that were incorrect which had led me to invoke the wrong functions.

In STM32LowPower.cpp:

Line 63 says that Idle = STM Sleep
Line 77 says that Sleep = STM Sleep, conflicting with Idle
Line 91 says that DeepSleep = STM Stop
Line 105 says that Shutdown = STM Standby

Line 128 says that Idle = STM Sleep and Sleep = STM Stop, conflicting with the prior description of Stop
Line 131 says that DeepSleep = STM Standby, which conflicts with the prior description of DeepSleep

If the comments could be revised to clarify these issues it would be appreciated. Note that none of these descriptions claim to invoke Low-power Run or Low-Power sleep, so these descriptions link 4 Arduino functions to only 3 of the 5 STM low-power functions.

[fpistm]

https://github.com/stm32duino/STM32LowPower/blob/master/README.md#hardware-state

[fpistm]

As a first note, this library is based on the Arduino Low Power one for compatibility and thus match the API naming.
So, each STM32 low power mode has been mapped to the Arduino one and the naming is not exactly the same.

https://github.com/stm32duino/STM32LowPower/blob/master/README.md#hardware-state

No conflict, this is really STM32 sleep. The main difference is which regulator is used but both called the HAL_PWR_EnterSLEEPMode.

Line 91 says that DeepSleep = STM Stop
Line 105 says that Shutdown = STM Standby

Same here Arduino API named DeepSleep called HAL_PWR_EnterSTOPMode ans Shutdown the
HAL_PWR_EnterSTANDBYMode.

Line 128 says that Idle = STM Sleep and Sleep = STM Stop, conflicting with the prior description of Stop
Line 131 says that DeepSleep = STM Standby, which conflicts with the prior description of DeepSleep

Yes it seems there is a shift. Do not hesitate to provide a PR to fix that.

Note that none of these descriptions claim to invoke Low-power Run or Low-Power sleep, so these descriptions link 4 Arduino functions to only 3 of the 5 STM low-power functions.

As said, STM32 low power mode has been mapped to the Arduino one and so yes it does not provide all STM low power. Goal of this library is to provide a compatible library not to support all STM32 low power. If you need extra low power mode then you can use HAL/LL directly to fit your needs.

[Eqqman]

Yes, no way to give perfect mapping if the Arduino library and the STM32 don't have the same number of low-power modes. This is just a request to fix the inconsistencies in the comments on how they are mapped.