[FEATURE REQUEST]Add grblHAL support : https://github.com/grblHAL

[luc-github]

As started to discuss here grblHAL/ESP32#39

[terjeio]

An initial update for WebUI 3.0 of the grblHAL WebUI plugin is now available. I am testing with a Nucleo STM32F756 board and the plugin should also work with the iMXRT1062 (Teensy 4.x) driver. Note that the ESP32 grblHAL driver does not use the plugin, I will backport the code changes to that later on.

@dresco is working on a STM32H7xx driver that has ethernet and SD card support, it will be possible to use the plugin for this driver when it is updated to use the latest grblHAL core.

[luc-github]

Ok understood - unfortunatly I have no STM boards, neither Teensy 4.x, but I can emulate webserver and board responses in webUI dev mode

I saw the the https://github.com/grblHAL/Plugin_WebUI but I was thinking was same code in https://github.com/grblHAL/ESP32 so I did not realized it was V3 based - I will have a look

[luc-github]

@terjeio you wrote

my plan to contact you about some issues I have encountered

Can you tell which ones ? I can start by these first

I have added the code base to test and build grblHAL webUI bac40f9

I need some confirmation :

• Is grblHal typo correct ? I saw also different writing like GRBLHal and GRBLHAL

• do you have a logo for grblHal ? I have only found
  is there and svg version of it ?

• about github link
  Do you want to go to https://github.com/grblHAL/ ? or target the specific FW like https://github.com/grblHAL/ESP32 or https://github.com/grblHAL/STM32F7xx, in that case it would need extra info in [ESP800] response

• about webUI update
  I see on esp32 version you cannot update the webUI as do not use the maintenance page and directly flashed the webUI,
  is that the same with pluggin ?

I will check what play SD job commands you are using, reading https://github.com/grblHAL/core/wiki/SD-Card-implementation,-a-technical-walktrough it seems $F=<filename but I will double check

• I see extra real time commands: https://github.com/grblHAL/core/wiki/For-sender-developers#single-character-real-time-commands so I need to add them in https://github.com/luc-github/ESP3D-WEBUI/blob/3.0/src/targets/CNC/grblHAL/realCommandsTable.js
  Is that list complete / up to date ?

[terjeio]

Issues encountered:

ESP701 for querying the status of a running job suddenly (randomly) is no longer sent after a running a few. Reloading resumes the querying.

If wrong password is given on login correcting it and resubmitting leads to the USER field in the form data missing.

The default file system is FLASHFS, could this be the first listed in the target supportedFileSystems (in files.js) or perhaps read from the ESP800 response?

ESP3D-WEBUI/src/components/Panels/Files.js

Lines 509 to 512 in bac40f9

	if (useUiContextFn.getValue("autoload") && currentFS == "") {
	currentFS = "FLASH"
	onSelectFS()
	}

I've changed the code above and it seems to work but not sure if this has any side-effects (other than failure if none are specified):

        if (useUiContextFn.getValue("autoload") && currentFS == "") {
            currentFS = files.supported[0].value
            onSelectFS()
        }

Is grblHal typo correct ? I saw also different writing like GRBLHal and GRBLHAL

"grblHAL" is the correct version. The welcome message from the controller is not correct, but I have been reluctant to change it as it may break senders.

do you have a logo for grblHal

There are a few proposals but none has been decided upon. I have to make my mind up...

Do you want to go to https://github.com/grblHAL/ ?

Yes, I have changed this already.

I see on esp32 version you cannot update the webUI as do not use the maintenance page and directly flashed the webUI,
is that the same with pluggin ?

Yes. For the plugin changing this will require a flash filing system. I may add this later. If the WebUI is compiled into the binary then adding index.html.gz to the SD card www folder will override the one from the binary so there is an update path available. More work on this is needed on my end - perhaps adding download of a new version to the www folder as a first step?

I will check what play SD job commands you are using

I am using $F=, I can also use ESP220 (IIRC this is used by WebUI 2.1) but when I check your ESP3D source it seems to me that this (and some other commands) has been repurposed? The commands that may have been reporposed have the help text "??" in this list.

I see extra real time commands: ... Is that list complete / up to date ?

I am not sure it is up to date, I'll have to check. Most can be ignored?
Perhaps the most important change is the new Tool state, it would be great if WebUI could support grblHAL style tool change handling. And yes, this works even when running a job from the SD card.

Here are the preferences and target folder I created:

preferences.zip

grblHAL.zip

---

Should grblHAL get its own firmware target name and id?

Some ideas:

Can WebUI fetch the settings labels from the controller? grblHAL has dynamic settings handling - plugins may add new ones, even user defined plugins. In my sender the settings UI is built from information requested from the controller. I can easily add an ESP command for fetching a json formatted list of setting ids and labels (and even descriptions) in a json formatted response.

On a longer term todo list will it be possible to use the WebUI style settings handling? It will require the support for floats and a flag type where bit 0 controls the enable status for the rest.

[luc-github]

ESP701 for querying the status of a running job

Currently this command is for the ESP3D Gcode host not used for running job, why not use the ? like GRBL_ESP32 ?
I need to see your implementation, originally ESP command are send by http and answer come back by http too, unlike others commands which use websocket, if polling is stopped it means there is a crash that should be visible in dev console or an error in notifications panel

If wrong password is given on login correcting it and resubmitting leads to the USER field in the form data missing.
I need to check but I may did that on purpose to display or not the error message

The default file system is FLASHFS,

This is already the case, no ? Flash is the default because it is the one I know it is present for sure, so not sure what issue you meet

I am using $F=, I can also use ESP220

Yes these commands are used by GRBL_ESP32 which is only supported by WebUI 2.1, and since the GRBL_ESP32 is dropped, I did not maintained them in WebUI 3.0

I am not sure it is up to date, I'll have to check. Most can be ignored

it is just to allow these command to be used by macro using a text descriptor as they are not printable,

I also see some commands : ?,~,!` need to be update by the not printable code to be handled properly in grblHal, so will do

would be great if WebUI could support grblHAL style tool change handling.

You will have to tell me more what you expect for UI and behavior, but I see no issue to support it

target name and id?

The current webUI use grblhal as name, for the ID I did not defined it yet, but because it is not selectable for ESP3D, it is not major issue,
here the current list : https://github.com/luc-github/ESP3D/blob/3.0/esp3d/src/include/defines.h#L28-L36
If you are ok to use ID=80 I will set it, it will be used to be sure WebUI match the target FW

Can WebUI fetch the settings labels from the controller?
currently it is the case, everything is dynamic, these labels are then translated by translation tool to give better look and correct language

So actually you can add any sections / items you want in settings just follow current syntax, if need more type of settings, just need to define type, type constraint, rendering form and should be ok like others types

[luc-github]

Reading your version now

• preferences content has some changes already, polling commands can have difference frequency
• your issue with Flash FS as first is due to the order put in files.js but in latest version of WebUI order is correct
• changed the play command by $F= as you did
• Added all the modes you added

[luc-github]

I have updated and build the index.html.gz according your changes https://github.com/luc-github/ESP3D-WEBUI/blob/3.0/dist/CNC/GRBLHal/index.html.gz

I still need to update the real commands parts

I have also noticed you do not support the one session feature so many webUI can be open at once, is that a choice ? I won't recommend it

[terjeio]

ESP701 for querying the status of a running job

Currently this command is for the ESP3D Gcode host not used for running job, why not use the ? like GRBL_ESP32 ?
I need to see your implementation, originally ESP command are send by http and answer come back by http too, unlike others commands which use websocket, if polling is stopped it means there is a crash that should be visible in dev console or an error in notifications panel

Polling for the real time status continues, only the ESP701 request stops. If I remove the ESP701 request the stream status is not displayed even if it is available in the real-time report. I assume this could be changed to use the real time report instead?

The default file system is FLASHFS,

This is already the case, no ? Flash is the default because it is the one I know it is present for sure, so not sure what issue you meet

It is not present in the controllers using the plugin.

I am using $F=, I can also use ESP220

Yes these commands are used by GRBL_ESP32 which is only supported by WebUI 2.1, and since the GRBL_ESP32 is dropped, I did not maintained them in WebUI 3.0

Ok, this explains it. They should not have been reassigned to a different use then? Or was this a customization made by bdring and his team?

target name and id?

If you are ok to use ID=80 I will set it, it will be used to be sure WebUI match the target FW

If not needed I am ok with using ID=10 as I do not know what it is used for in your code.

Can WebUI fetch the settings labels from the controller?

currently it is the case, everything is dynamic, these labels are then translated by translation tool to give better look and correct language

Ok, what is the ESP command to use for returning those. And to be clear I am talking about the grblHAL settings where those not known by the WebUI does not have useful labels:

preferences content has some changes already, polling commands can have difference frequency

Ok, will update. Sun came out today after a period of rain - so it may take some time. And I will be away for a period starting Tuesday 2nd.

I have also noticed you do not support the one session feature so many webUI can be open at once, is that a choice ?

Definitely not - or at least until an abitration protocol can be added. Only one client should be in control at the time. As a first step I might add support for additional read-only clients - but this is longer term.

[luc-github]

It is not present in the controllers using the plugin.

I need to check if I have added a dependency on ESP800 settings

[ESP800]
{
"cmd": "800",
"status": "ok",
"data": {
 "FWVersion": "3.0.0.a111",
 "FWTarget": "grblhal",
 "FWTargetID": "80",
 "Setup": "Enabled",
 "SDConnection": "direct",
 "SerialProtocol": "raw",
 "Authentication": "Disabled",
 "WebCommunication": "Synchronous",
 "WebSocketIP": "localhost",
 "WebSocketPort": "81",
 "Hostname": "esp3d",
 "WiFiMode": "STA",
 "WebUpdate": "Enabled",
 "FileSystem": "LittleFS",
 "Time": "none",
}
}

grblHAL settings

these are in language pack - they are just translation from commands id : https://github.com/luc-github/ESP3D-WEBUI/blob/3.0/src/targets/CNC/grblHAL/translations/en.json

the one session feature

this feature is actually mostly handled by webUI, the FW just broadcast the last connected ID by websocket , so the old ID webUI automaticaly close - not hard to implement - I may try to do it if you want

I need to setup an esp32 system for grblHal as I am afraid I will do some blind code and may misunderstood some commands

if I replace the plugin files to existing ESP32 code would it work ? any other changes should I do - I can do changes manually and this will let me know also why current version is always in reset error on my board

Or was this a customization made by bdring and his team

In FluidNC they renamed all commands https://github.com/bdring/FluidNC/wiki/FluidNC-Commands-and-Settings

[dresco]

@dresco is working on a STM32H7xx driver that has ethernet and SD card support, it will be possible to use the plugin for this driver when it is updated to use the latest grblHAL core.

Just fyi, have started looking at this. First issue is that I used the STMCubeIDE provided middleware for SD card access (using DMA & SDMMC peripheral) - which uses an older FatFs version. Am looking into what it's going to take to upgrade..

@terjeio should I aim for R0.13c as per F4/F7 etc, or latest R0.14b?

[terjeio]

the one session feature

this feature is actually mostly handled by webUI, the FW just broadcast the last connected ID by websocket , so the old ID webUI automaticaly close - not hard to implement - I may try to do it if you want

Wait... One step at a time please. I have some support issues to clear before I can dig into the details.

if I replace the plugin files to existing ESP32 code would it work ?

No, it is a major refactoring. Ideally I should update the ESP32 driver and the plugin so it could be used directly - I do not like to maintain duplicate code.

why current version is always in reset error on my board

Oops, I forgot to asnwer this, by default grblHAL uses normally closed switches for all inputs. Connect the reset pin to ground and you should be fine.

@dresco - the SD card plugin can work with earlier versions of FatFS, I should have used the version id provided by FatFS but are using the target MCU family for now for detection... If you update aim for the latest version.