What are plans for documentation? about hulp HOT 10 CLOSED

Hi @standarddeviant
It's been on my mind for a while. I think it could also be a good place for general ULP programming introduction, tips and guidance.
I've just started with Doxygen + Sphinx + Breathe so expect something to appear soon.

from hulp.

That's great to hear! For context, I'm getting an M5Stick-C very soon and hoping to to continuously read the IMU and wake up the main cores if there's enough motion. I'm comfortable with C, but not assembly; I think HULP could greatly simplify implementing a low-power "wake-up-on-motion" in the ULP. I'll post something if I get it working.

from hulp.

things like SWAPPED_TOUCH_INDEX(x), which exists because of a bug the ESP32 codebase; touch 8 & 9 need to be swapped.

espressif/arduino-esp32#3584

from hulp.

I'm not sure it's worth the trouble at this point, sorry for never completing this.
If there's anything in particular that anyone needs clarified, please don't hesitate to create a new issue.

from hulp.

Sorry, just saw this and asking,
why not going on with development?
Are there any better alternatives?

from hulp.

I wrote several macros inspired by this project a while ago. If I find them, I'll post them.

from hulp.

Hi @macvenez,
I set up Doxygen briefly but got distracted by other things and never saw it though. Back then, HULP usage was even smaller than it is now so I didn't feel a pressing need for docs. It's not ideal, but almost everything is commented in the source.

I personally still use HULP almost every day! Occasionally I'll add bits here and there when I find it lacking. But it's filling a tiny tiny niche, as the ESP32 ULP has been superceded by RISCVs, so I doubt HULP will grow much in future.

As always, if there's a bug, some feature you think would be worth adding, if something is unclear, or if you just want general advice on ULP programming or a ULP code review, please feel free to create an issue.

from hulp.

Thanks for the clarification, I'll start trying out your library to create simple projects that may require the use of the ULP.
I thought while developing I could write some documentation that would have helped me in the first place, but of course I would have shared here, maybe creating a pull request to add documentation.
If I'm not wrong the RISCV ULP can only be found in esp32-S2, right? Is the development on standard esp32 considered dead?

Thanks for everything

from hulp.

If I'm not wrong the RISCV ULP can only be found in esp32-S2, right?

S2, S3, C6, P4... ESP32 will be the only one with only the 'FSM' core.

Is the development on standard esp32 considered dead?

Not entirely sure what you're asking here but ESP32 is very alive in terms of espressif/ESP-IDF support and development (it's still the best of the bunch if you ask me), and HULP only supports ESP32. Far from dead.

from hulp.

Alright thanks, I was just trying to understand correctly in order to get the right board for my next project.

from hulp.