Closed tfry-git closed 1 month ago
Memory usage change @ c2f8ace41903d524cd33960aa59606b4509c4687
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -40 - +48 | -0.06 - +0.07 | :green_heart: -20 - -8 | -0.1 - -0.04 |
arduino:avr:mega |
:grey_question: -118 - +88 | -0.05 - +0.03 | :grey_question: -1 - +1 | -0.01 - +0.01 |
arduino:avr:uno |
:grey_question: -110 - +90 | -0.34 - +0.28 | :grey_question: -1 - +1 | -0.05 - +0.05 |
arduino:mbed_giga:giga |
:green_heart: -144 - -72 | -0.01 - -0.0 | :green_heart: -32 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -24 - -8 | -0.07 - -0.02 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -604 - -108 | -0.23 - -0.04 | :green_heart: -24 - -20 | -0.07 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:green_heart: -536 - -8 | -0.03 - -0.0 | :grey_question: -12 - +4 | -0.0 - 0.0 |
teensy:avr:teensy36 |
:grey_question: -308 - +12 | -0.03 - 0.0 | :green_heart: -56 - -48 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
Memory usage change @ 172da016ac39b725fb8612d989a7f5c8afd79557
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -40 - +48 | -0.06 - +0.07 | :green_heart: -20 - -8 | -0.1 - -0.04 |
arduino:avr:mega |
:grey_question: -118 - +88 | -0.05 - +0.03 | :grey_question: -1 - +1 | -0.01 - +0.01 |
arduino:avr:uno |
:grey_question: -110 - +90 | -0.34 - +0.28 | :grey_question: -1 - +1 | -0.05 - +0.05 |
arduino:mbed_giga:giga |
:green_heart: -144 - -72 | -0.01 - -0.0 | :green_heart: -32 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -24 - -8 | -0.07 - -0.02 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -604 - -108 | -0.23 - -0.04 | :green_heart: -24 - -20 | -0.07 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:green_heart: -536 - -8 | -0.03 - -0.0 | :grey_question: -12 - +4 | -0.0 - 0.0 |
teensy:avr:teensy36 |
:grey_question: -308 - +12 | -0.03 - 0.0 | :green_heart: -56 - -48 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
Memory usage change @ 3927ec1f68436a9c465dc65ead859703b8a03339
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -64 - +48 | -0.1 - +0.07 | :green_heart: -24 - -12 | -0.12 - -0.06 |
arduino:avr:mega |
:grey_question: -382 - +172 | -0.15 - +0.07 | :grey_question: -3 - +1 | -0.04 - +0.01 |
arduino:avr:uno |
:grey_question: -374 - +180 | -1.16 - +0.56 | :grey_question: -3 - +1 | -0.15 - +0.05 |
arduino:mbed_giga:giga |
:green_heart: -208 - -72 | -0.01 - -0.0 | :green_heart: -40 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -28 - -8 | -0.09 - -0.02 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -1268 - -116 | -0.48 - -0.04 | :green_heart: -32 - -20 | -0.1 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:green_heart: -552 - -8 | -0.03 - -0.0 | :grey_question: -20 - +4 | -0.01 - 0.0 |
teensy:avr:teensy36 |
:grey_question: -308 - +16 | -0.03 - 0.0 | :green_heart: -56 - -40 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
Memory usage change @ a619093bb895322626e133f0077c5d1f2bb9e8f7
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -64 - +48 | -0.1 - +0.07 | :green_heart: -32 - -12 | -0.16 - -0.06 |
arduino:avr:mega |
:green_heart: -830 - -282 | -0.33 - -0.11 | :green_heart: -50 - -37 | -0.61 - -0.45 |
arduino:avr:uno |
:green_heart: -814 - -266 | -2.52 - -0.82 | :green_heart: -50 - -37 | -2.44 - -1.81 |
arduino:mbed_giga:giga |
:green_heart: -208 - -72 | -0.01 - -0.0 | :green_heart: -40 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -36 - -12 | -0.11 - -0.04 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -1268 - -116 | -0.48 - -0.04 | :green_heart: -36 - -20 | -0.11 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:green_heart: -552 - -8 | -0.03 - -0.0 | :grey_question: -28 - +4 | -0.01 - 0.0 |
teensy:avr:teensy36 |
:grey_question: -316 - +16 | -0.03 - 0.0 | :green_heart: -56 - -48 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
There are a couple of items left at #210 , but those can really be handled, incrementally, as far as I can see. Also, I'm a little afraid, waiting for every box to be truly ticked will cause out-of-proportion delays. So what I'd like to propose is to finally go ahead and make the switch to Mozzi 2.0. (It's a small step in git, but...)
My checklist of stuff that really still needs to be done (please add your items, if any):
I tested generating the docs on my setup, loading extras/doxygen-style/Doxyfile into Doxygen, and it still seems to work OK. You might have to adjust some of the local directory entries, though the only obvious one I see is in "Step 1" on the Doxygen gui, which is the working directory.
(my last attempt was not so very successful. @tomcombriat , have you done that, before?)
Not for Mozzi and I have to say that I am not very experienced with Doxygen, but I can try to help on what @sensorium has done (if changes are needed).
we probably want to preserve the current master as a "Mozzi1" branch, just in case
Yes, I also wanted to suggest that. This can be especially useful for git users wanted to recompile old sketches done with Mozzi1 (like me for instance): people using the Arduino Library Manager can do that easily, but I never found a way to switch from a tag to another. Switching to another branch is super straightforward (but might be worth documenting).
On looking at the generated docs, I didn't find the classes (Oscil, filters etc.). Not sure if it's due to something that's changed in the source files, or in the Doxygen software/config. It's been a while and I'd almost need to start understanding it all over again step by step to work it out... (sorry to be not much help).
Hm the doxygen handling of "groups" seems to have changed (and confuses me). I tried another round with doxygen 1.9.1, and made some adjustments on the way. I'm afraid the resulting structure still has potential for confusion, but on first glance, everything seems to be present.
(We'll also have to second-check the links on the learn pages and Readme. At least some appear to have changed.)
Memory usage change @ 62af5c213ce344ef9010f3eaa18a0ad4a269c950
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -64 - +48 | -0.1 - +0.07 | :green_heart: -32 - -12 | -0.16 - -0.06 |
arduino:avr:mega |
:green_heart: -830 - -282 | -0.33 - -0.11 | :green_heart: -50 - -37 | -0.61 - -0.45 |
arduino:avr:uno |
:green_heart: -814 - -266 | -2.52 - -0.82 | :green_heart: -50 - -37 | -2.44 - -1.81 |
arduino:mbed_giga:giga |
:green_heart: -208 - -72 | -0.01 - -0.0 | :green_heart: -40 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -36 - -12 | -0.11 - -0.04 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -1268 - -116 | -0.48 - -0.04 | :green_heart: -36 - -20 | -0.11 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:green_heart: -552 - -8 | -0.03 - -0.0 | :grey_question: -28 - +4 | -0.01 - 0.0 |
teensy:avr:teensy36 |
:grey_question: -316 - +16 | -0.03 - 0.0 | :green_heart: -56 - -48 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
Ok, I think the API docs and web page may be ready, now. (In doxygen I still had to add some @defgroup
statements. For the web page, I also synced examples, and API, now.
Could you take another close look at docs and page? (https://tfry-git.github.io/Mozzi/)
The state of the API docs is not ideal, IMO, but seems to contain everything, now. Regarding the "learn" section, a tutorial on FixMath is still missing, but I think that can still be added after release.
Memory usage change @ c9af67f6924b7e60708ce882e491a824d0cd9876
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -64 - +48 | -0.1 - +0.07 | :green_heart: -32 - -12 | -0.16 - -0.06 |
arduino:avr:mega |
:green_heart: -830 - -282 | -0.33 - -0.11 | :green_heart: -50 - -37 | -0.61 - -0.45 |
arduino:avr:uno |
:green_heart: -814 - -266 | -2.52 - -0.82 | :green_heart: -50 - -37 | -2.44 - -1.81 |
arduino:mbed_giga:giga |
:green_heart: -208 - -72 | -0.01 - -0.0 | :green_heart: -40 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -36 - -12 | -0.11 - -0.04 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -1268 - -116 | -0.48 - -0.04 | :green_heart: -36 - -20 | -0.11 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:green_heart: -552 - -8 | -0.03 - -0.0 | :grey_question: -28 - +4 | -0.01 - 0.0 |
teensy:avr:teensy36 |
:grey_question: -316 - +16 | -0.03 - 0.0 | :green_heart: -56 - -48 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
Hi, A lot of work has been done! Sorry for being a bit away lately.
I am checking the new things now. I do not have a clear overview of the website yet (for instance I still do not get how to generate the doc from one branch and transfer it to the other…) so I will update a list here and try to implement the changes myself. Everything unticked is what I did not implement, yet.
FixMath
as a non-included dependency on the main pageLearn
section is a good idea as one of them might be forgotten in future updates?Maple
(the first one) and not to STM32duino. Links are correct!MOZZI_OUTPUT_PWM
and not "The default mode is rp2040_pwm .". (really neatpick)The learn/a-simple-sketch/ section (points to the online version at the moment) could do with updating to reflect changes...
By the way, feel free to change whatever you like in the web pages, I recognise how much work has been done and I don't feel the need to keep anything there in its old condition...
@sensorium Are we on the same version? The sketch in the page you referred seems fairly up-to-date to me (except for FixMath actually, and a bit of syntaxic color).
@tomcombriat, yes I must have been viewing the wrong version!
Except some minor details (see previous comment), I think it looks good! I actually kinda like the black theme also ;). Some things could be made even more perfect but I think it is also nice to put it out as minor changes will inevitably occur but it is in a good working and documentation state. I think that we will have to be quite careful in the changelog, the automatic one won't be of much help. Things that need to be in there (probably incomplete list, add items if you see something that got forgotten):
mozzi_config.h
: config is done at the beginning of the sketchesEdit:
I would remove mention to 64536Hz
output frequency in both the git Readme and on the main web page. Last time I tried it would not compile (maybe in a close future though?)
Maybe a stupid question, but why do we have separate cases for in-built DAC and PWM? Usually, one excludes the other and the result is the same: sound straight from the board, maybe, at some point, we could consider merging them in MOZZI_OUTPUT_PWM_DAC
? This might lead to a slight confusion to know if it is a real DAC or PWM but…
If DAC and PWM are mutually exclusive, today, I think that's mostly because we were too lazy to implement a PWM mode for boards that come with a DAC. Yet, having an inbuilt non-DAC mode will sometimes still make a lot of sense, e.g. because the DAC is limited to mono (Teensy 3, SAMD, Uno R4) or 8 bits (ESP32), or tied to specific pins that might be needed for something else.
We do already have a PDM mode in addition to DAC on ESP32, and I don't see anything logically going against both PWM and DAC supported in the same port. Besides, users who simply want "either DAC or PWM on any pin" will generally be good with the default output mode, anyway.
Very good points!
Memory usage change @ 348acd308cb90976d4aab5e15b3e8e80e6e0eaf7
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -64 - +48 | -0.1 - +0.07 | :green_heart: -32 - -12 | -0.16 - -0.06 |
arduino:avr:mega |
:green_heart: -830 - -282 | -0.33 - -0.11 | :green_heart: -50 - -37 | -0.61 - -0.45 |
arduino:avr:uno |
:green_heart: -814 - -266 | -2.52 - -0.82 | :green_heart: -50 - -37 | -2.44 - -1.81 |
arduino:mbed_giga:giga |
:green_heart: -208 - -72 | -0.01 - -0.0 | :green_heart: -40 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -36 - -12 | -0.11 - -0.04 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -1268 - -112 | -0.48 - -0.04 | :green_heart: -36 - -20 | -0.11 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:green_heart: -552 - -8 | -0.03 - -0.0 | :grey_question: -28 - +4 | -0.01 - 0.0 |
teensy:avr:teensy36 |
:grey_question: -312 - +20 | -0.03 - 0.0 | :green_heart: -56 - -48 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
Are we good to go?
When would be a good time? (Probably an official release / announcement should follow shortly after merging)
I'm happy if you're ready to go ahead...
...(whenever you like)
Are we good to go?
I think so! If some details went under the radar we can always fix them as we go.
I think we should make a nice, and clear announcement, emphasing on possible loss of compatibility and the new features. I can try to draft a release that everyone can edit soon if you want!
Memory usage change @ df8bf655236a3ff99c0d86f307b93404ca17b678
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -64 - +48 | -0.1 - +0.07 | :green_heart: -32 - -12 | -0.16 - -0.06 |
arduino:avr:mega |
:green_heart: -830 - -282 | -0.33 - -0.11 | :green_heart: -50 - -37 | -0.61 - -0.45 |
arduino:avr:uno |
:green_heart: -814 - -266 | -2.52 - -0.82 | :green_heart: -50 - -37 | -2.44 - -1.81 |
arduino:mbed_giga:giga |
:green_heart: -208 - -72 | -0.01 - -0.0 | :green_heart: -40 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -36 - -12 | -0.11 - -0.04 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -1268 - -112 | -0.48 - -0.04 | :green_heart: -36 - -20 | -0.11 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:small_red_triangle: +1936 - +2480 | +0.09 - +0.12 | :green_heart: -636 - -604 | -0.24 - -0.23 |
teensy:avr:teensy36 |
:grey_question: -312 - +20 | -0.03 - 0.0 | :green_heart: -56 - -48 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
(Release draft started at: https://github.com/sensorium/Mozzi/releases)
(Release draft started at: https://github.com/sensorium/Mozzi/releases)
Drafty for now, I am writing it as it comes. Please feel free to add/modify/delete. The changelog will come when merged (but might be un-readable).
I changed the genus of mosquitoes as this is a major version, but we can come back to Aedes if you prefer!
Memory usage change @ 2f975be262dc106fa6b10eacaa17cc527d01f42e
Board | flash | % | RAM for global variables | % |
---|---|---|---|---|
STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 |
:grey_question: -64 - +48 | -0.1 - +0.07 | :green_heart: -32 - -12 | -0.16 - -0.06 |
arduino:avr:mega |
:green_heart: -830 - -282 | -0.33 - -0.11 | :green_heart: -50 - -37 | -0.61 - -0.45 |
arduino:avr:uno |
:green_heart: -814 - -266 | -2.52 - -0.82 | :green_heart: -50 - -37 | -2.44 - -1.81 |
arduino:mbed_giga:giga |
:green_heart: -208 - -72 | -0.01 - -0.0 | :green_heart: -40 - -16 | -0.01 - -0.0 |
arduino:renesas_uno:minima |
:green_heart: -532 - 0 | -0.2 - 0.0 | :green_heart: -36 - -12 | -0.11 - -0.04 |
arduino:samd:adafruit_circuitplayground_m0 |
:green_heart: -1268 - -112 | -0.48 - -0.04 | :green_heart: -36 - -20 | -0.11 - -0.06 |
esp8266:esp8266:huzzah |
N/A | N/A | N/A | N/A |
rp2040:rp2040:rpipico |
:small_red_triangle: +1936 - +2480 | +0.09 - +0.12 | :green_heart: -636 - -604 | -0.24 - -0.23 |
teensy:avr:teensy36 |
:grey_question: -312 - +20 | -0.03 - 0.0 | :green_heart: -56 - -48 | -0.02 - -0.02 |
teensy:avr:teensy41 |
N/A | N/A | N/A | N/A |
Hello! Any opinion on the release draft?
Oh, yes, I've been distracted. I had done some small edits to the draft, and am totally fine with it.
Shall I just go ahead and do the merges (this PR, and the website)?
Shall I just go ahead and do the merges (this PR, and the website)?
Yup, I think so :). The changelog can be added to the draft once it is merged.
I'll post the same on the forum once it is done!
Not all pieces are in, yet, but we're getting there. Here's a "master" PR for monitoring the whole change set.
(We can still create and merge "sub"-PRs into the devel/Mozzi2 branch, and they should end up, here).
Notes: