Firmware selector/filter

[Mik-S-UMS]

Is there a way on Github to have some sort of filter to find the right firmware that you require?

The number of options are overwhelming for some people as there are over 550 choices over the Aquila and Ender builds.

Ideally there should be drop down boxes where you can select the chip, board, UBL, options etc and list only those that match. Those could also show a full description of what that firmware does instead of listing something like Aquila_N32_SPRT13_BMP_UBL-ProUI-EX-PLR-05-23.bin (what does EX mean? I don't see if that is explained anywhere)

You could also have a direct download of the display assets instead of needing to download and look though the source code zip file.

If this can't be done on Github maybe some other website can be used to do this and could be kept up to date automatically with Github actions. I know another project I follow uses docusaurus for their documentation.

[classicrocker883]

yea I feel you, it is a bit much. This may take some time to figure out but thanks for the suggestion!

A drop down list may be possible just like the selections in the Issues tab when making a new issue or feature request. This would be great to implement right into the releases. If that isn't possible, then I suppose I could somehow get that to work right through the website I created https://classicrocker883.github.io/ which is already a work in progress.

as for the -EX, it simply stands for Extra Features.
I removed -NoPro, and replaced previously called "ProUI" with ProUI-EX.

because it is all technically ProUI. I was able to migrate some ^{now called} ProUI-EX features into the _formerly -NoPro

I'll prepare a write up about the changes and differences.

I know another project I follow uses docusaurus for their documentation.

can you link to where this project is??

but if anyone knows about or can help with the drop down list, how I can use that in the releases that would be awesome.

otherwise if there are any other changes like with the naming of the files and their features/options I'm open for that.

[Mik-S-UMS]

The other project is Universal Media Server (The UMS in my username)

TBH I don't know anything about docusaurus other than they use it for their knowledge base so don't know if this will be suitable for this purpose but may be worth a look.

You can see the discussion to use it for UMS here

[classicrocker883]

this is all good information! I just don't know where to start to be honest. have you any idea?

[Mik-S-UMS]

Sorry but haven't a clue. All I can suggest is to try out a few demos to see what is suitable.

[classicrocker883]

https://classicrocker883.github.io/about/
hey check it out I figured it out. It works except for a couple things like selecting bed leveling and options I still have to tweak.

[classicrocker883]

YUP! that was it. the stupid comments.

here we go, how about this for now? are there any changes or suggestions?
https://classicrocker883.github.io/firmware-selector

[Mik-S-UMS]

It is working good for me.

For some reason it was starting a download when I never clicked one of the files. What I was doing is clicking in the blank space to deselect the dropdown box. I found that hovering over to the right of the file list outside the box it would show as a link in the status bar and it was this I was accidentally clicking.

For the model box you should mention this pre-selects a common configuration for a particular model and you could add more to this like the C2, S2, S3 etc.

One of the first things to select should be the board/chip type, then screen type (screen could default to DWIN instead of having none) as this is the most important thing to getting the right FW for the printer.
You could have these on a single line too to make it more compact.

Is the 12864 screen is the text screen on the C2? Nothing shows up when choosing this. Does the firmware need to be compiled to use this?

For levelling since you are promoting UBL over BLT then UBL should be the first on the list.

Instead of saying none you could have something like --select-- so you know that none is not a valid option so should not be using it to filter.
It was confusing me a little to why there was none and default in levelling when both would be true if you did not want to use ABL, and in this case using none instead of default would make more sense.

Some options could be check boxes like the ProUI extra features (you could have this next to the screen option), as well as things like MPC, IS etc instead of needing multiple option dropdowns.

[classicrocker883]

ohh nice idea for a checkbox. yeah that would be helpful. and having select instead of none definitely. the 12864 screen is the monochrome LCD like on C2. if you choose this you need to also choose No for ProUI-Ex or HC32. because having those screens can't support the ProUI - that only works on color with encoder knob.

I suppose over in MRiscoC's source code he has implemented some ProUI stuff for those LCD types, but I do not know the extent of changes at the moment.

so I will need to do some rearranging of the selections, have select instead of none, fix the downloads being in the clickable area, checkboxes, and anything else?

how about any changes to layout, colors, icons, pictures, other information?

i could try adding a description box that shows up when you hover on an option.

[Mik-S-UMS]

Tooltips on each option would be helpful for quick reference.

Not sure what pictures would be relevant unless you have an image of some of the addons like BIQU MicroProbe, induction sensor or sprite hotend. Maybe if selecting for a model you could show an image of that printer.

For layout might be better to keep it compact with similar options on the same line.

I was thinking instead of Features it could be ABL type (None, BL/CR Touch, BIQU, Inductive) then have the levelling method (UBL, BLT, MM). I don't know where you would put the sprite option though, maybe a hotend dropdown (Stock, Sprite) which could be also used if you support other thermistor types.

The way is is currently it would look better if the boxes were aligned with each other but this will change when you move things around. whatever you think looks good will do.

Have you thought about where to have this in your release notes? It will have to be something easily seen so it is obvious.

[classicrocker883]

Have you thought about where to have this in your release notes? It will have to be something easily seen so it is obvious.

it may not be possible embedding this inside github besides where it is now on a separate webpage. If I were to upload the code it would be just that, does nothing like:

<html>
<body>
<div>
  <p>This that and another thing</p>
</div>
</body>
<scipt>
/*JS script here*/
</script>
</html>

So, I will have to provide a link to it - I suppose I can screenshot and make it a link so it appears embedded. but sadly there's just no other way. maybe there is but I looked. kind of dumb where you can embed things like pictures, video, sounds, but a simple drop down thing?

the only other thing I can think of is something like Issues > Bug/Feature Request how you can select. but we're looking at way more complex code, so it couldn't work.

The way is is currently it would look better if the boxes were aligned with each other but this will change when you move things around. whatever you think looks good will do.

I have tried aligning the drop boxes vertically, will need to figure that CSS stuff out.

I have made some changes, and still doing some testing and what not. I am so close to where I want it except one little thing where I have got it to work separetly, but trying to get it to fuse and work with the main code is hard.

[classicrocker883]

https://classicrocker883.github.io/firmware-selector

so what does anyone think of this layout? I sort of centered everything. is that a good look? or should it be how it was (left orientated)?

I've made changes so that it updates to the latest release automatically, but you can always select a previous release.

still have to make adjustments for other changes.

[Mik-S-UMS]

I did get that "new version available" message a few times in the past but nothing there now. Refreshing the page does not fix it either.

I opened it in a new container tab and that fixed the layout. Its looking good.

I don't know how cookies would have any effect on this, there is probably some setting or CSS that is causing it. Maybe Github is doing something as it is hosted by them, probably similar to the comments issue.

@yrabbit there is an option in Github settings where you can set the theme.

There is a sync with system but is not on by default (I have not set it) so that could be why it is not being used.

[yrabbit]

I know about this setting and my github is dark, except for your page. Forget it. It's just a glitch that I can live with.

[classicrocker883]

I updated it so it is always dark.
let me know if that works.

I also uploaded it to netlify
see if this works here: - [edit: changed URL name]
https://classicrocker883.netlify.app/
link to Firmware Selector

I made some changes where I can disable cache for the webpage, let me know if this has worked. you should see some changes like a new logo.

[yrabbit]

Yes, now it works :)

[Mik-S-UMS]

Someone on Reddit did not understand the display themes so maybe if the display type is set to DWIN then add a direct link to just the display firmware with preview images of each theme.

[Mik-S-UMS]

Someone mentioned on Reddit that the download link for the DWIN_SET files is not working. I could not remember there was a link for this before so it must be new.

Testing this myself I get a warning from Firefox about a deceptive site and blocks it.

I think the problem is the download link has /HEAD/ that I assume is meant to be replaced with the string of numbers of the hash of the version or something like that. and this is triggering a false positive for malicious code or something.

If I create my own link with https://minhaskamal.github.io/DownGit/#/home it works.
"https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/classicrocker883/MRiscoCProUI/tree/f0d6716cae54983bff4726ea569227537fc5d5be/displayassets/Aquila Display Firmware/Firmware Sets"
(The spaces are messing up the link though so might be better to replace them with %20 but I think it is a problem with Github parsing it in these comments)

I replied with this on Reddit but my post got removed, probably for the same false positive.

[classicrocker883]

Yes i do get the same message for chrome.

[classicrocker883]

I changed the website to https://downgit.github.io/#/home, this has no issues

[Mik-S-UMS]

That is working well for me now.
You could also add this link in the firmware selector right after the .bin files to make it easier for new users to find.

[classicrocker883]

ok I added that to the firmware selector, also updated the readme files a tad in display assets

[classicrocker883]

update: I had to make a couple changes - simple changes just cant be made, first of all they updated "Setup Ruby", so I had to bump up the workflow version, then add alt="..." to each picture used.