random idea, scriptable HTML elements for OBK page - widgets/widget driver - for custom channels?

I've got this idea for tiny, pluggable scriptable widgets for OBK yesterday. OBK already features a hardcoded set of channel types:
https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/channelTypes.md
we also support a custom REST page for displaying channels:
https://www.elektroda.com/rtvforum/topic4040354.html
but we didn't have anything in between....

so my idea is to create a WIDGET driver, that basically allows you to create short custom code snippets in HTML and JS

they are placed on main obk page, in two modes:
- either in refreshed automatically state div
- or before this state div (no auto refresh)

It's already in the main tree, enabled on Windows:

html file:

script:

Result:


I am thinking that maybe it could be used, along with REST interface, to display more custom data. See REST tutorial:
https://www.elektroda.com/rtvforum/topic3971355.html
I am also thinking about adding something like $CH1 support to the said widgets directly, maybe?

source:
https://github.com/openshwprojects/OpenBK7231T_App/blob/main/src/driver/drv_widget.c

Can you give it and try and tell me some feedback, @divadiow , @max4elektroda , @insmod , @DeDaMrAz , @XJ_ ? Watch for bCache setting, I don't think that reading LFS file on each page refresh is really that optimal... still, it's just a read, not a write, so it should not at least wear the flash.

p.kaczmarek2 wrote:

and tell me some feedback

That's a great idea, I've been modifying the code since the beginning to have the "config, restart and other for development and debugging" menu at the top and I was thinking about putting it as a PR, but it lacked the "flexibility". I'm changing everything in the sourcecode yet.
Here you go, that's what I want. That's the right way.

Added after 8 [minutes]:

p.kaczmarek2 wrote:

reading LFS file on each page refresh

I don't know how big scripts users will be able to create, but I can imagine a limit where it will only be in RAM - e.g. up to 2000 kb - which is not a lot.
On the other hand, saving to RAM won't actually add anything anyway, the speed of loading from flash will be enough. Or am I wrong? How much does reading flash vs RAM load on the CPU?

Added after 10 [minutes]:

p.kaczmarek2 wrote:

support to the said widgets directly, maybe

But I think that only we will use it, because the others have it connected somewhere else /HASS/, and the web interface using only during setup or when something goes wrong.
Judging by the questions that sometimes appear, I guess that there will not be many users who would be able to write something themselves.
I would start with the basics - Button, url, text. And then we will see if it attracts attention.

XJ_ wrote:

p.kaczmarek2 wrote:

and tell me some feedback

That's a great idea, I've been modifying the code since the beginning to have the "config, restart and other for development and debugging" menu at the top and I was thinking about putting it as a PR, but it lacked the "flexibility". I'm changing everything in the sourcecode yet.
Here you go, that's what I want. That's the right way.

Windows Simulator makes everything very easily configurable and extendable. If you want to add such a button via Widget, it should be also possible as well.

XJ_ wrote:

I don't know how big scripts users will be able to create, but I can imagine a limit where it will only be in RAM - e.g. up to 2000 kb - which is not a lot.

2000kB of RAM is a typo, I guess? Or you mean flash? BK7231 has 2MB of flash, but most of that is already used by firmware, config, etc, we also need to have space for OTA, we could use it for scripts, but then every OTA would wipe them

XJ_ wrote:

On the other hand, saving to RAM won't actually add anything anyway, the speed of loading from flash will be enough. Or am I wrong? How much does reading flash vs RAM load on the CPU?

RAM can be used for charts driver, but flash read may be slower... so it's a tradeoff.

XJ_ wrote:

But I think that only we will use it, because the others have it connected somewhere else /HASS/, and the web interface using only during setup or when something goes wrong.

ACtually many beginners don't even have HASS, so they will use WWW panel as well, I think.

XJ_ wrote:

Judging by the questions that sometimes appear, I guess that there will not be many users who would be able to write something themselves.
I would start with the basics - Button, url, text. And then we will see if it attracts attention.

I can try to make more examples, I will prepare a tutorial, I've created this topic to get prelimary opinion and feedback.

p.kaczmarek2 wrote:

2000kB of RAM is a typo

Of course, 2000b ;-]

Added after 1 [minutes]:

p.kaczmarek2 wrote:

I can try to make more examples, I will prepare a tutorial,

As usual, you think of everything.

I like the general idea very much, but didn't find the time yet to test ...
If possible, storing the code in RAM would be preferred, but as I said, I didn't actually test it yet.

p.kaczmarek2 wrote:

flash read may be slower.

I know. Speed of reading the flash on such SoC will be somewhere around 1-10MB/s, which is fast enough for these small files. You want to read approximately 1kb every second. Even if it was 10kb, it would be ok.

Added after 5 [minutes]:

>>21328194
I'll try to find time to test it this week, and I'll also test the reading speed from Flash.

Added after 6 [minutes]:

>>21328194
Does anyone have a datasheet for the BK7231? I don't mean the shortened version of Tuya, but the real datasheet. Where is a more detailed description of the registers and so on. Is there even such a thing?

max4elektroda wrote:

If possible, storing the code in RAM would be preferred, but as I said, I didn't actually test it yet.

The worst part would be that often-refreshing state div of OBK main page. The static part is not that crucial.

XJ_ wrote:

I know. Speed of reading the flash on such SoC will be somewhere around 1-10MB/s, which is fast enough for these small files. You want to read approximately 1kb every second. Even if it was 10kb, it would be ok.

It may be also slow when some other part of code tries to access the flash at the same times. I hope the flash mutex is present in the code.... hopefully... well.

XJ_ wrote:

Does anyone have a datasheet for the BK7231? I don't mean the shortened version of Tuya, but the real datasheet. Where is a more detailed description of the registers and so on. Is there even such a thing?

BK7231 datasheet, pinout, programming, specification, wiki (BK7231T, BK7231N)


Maybe this widget method can be also used to create custom radio button/choice options for non-standard TuyaMCU devices

p.kaczmarek2 wrote:

BK7231 datasheet, pinout, programming, specification, wiki (BK7231T, BK7231N)

I already have these, but I didn't mean this. Or I didn't find the information I needed here. For example, there is information about UART flags, but no consequences. Information about flash and ram speed is missing... Or I just didn't found it.

We don't have more, I afraid.


Here is Widget for a single button - save it as "demoAnything.html" and add widget with it:

It will poll channel value on start and then toggle it.

So far I've only found time to test it in Win, it's great.
What I would add for myself is a parameter for the option to display it on all pages. Of course, for my dev menu
It's always at the top, even when you scroll down.



It's just simple html.



I fight against animal suffering. So let's end the suffering of mouse wheels.
Just to explain, it always bothered me a lot when I save a config, or anything else, and then I have to "crazy spin the mouse wheel" to scroll down to the menu to get back to somewhere.

Sure, do you have this flag already implemented and can make a PR, or should I try to propose some implementation on my own?

PS: Today I also did a OpenWeatherMap integration (separate driver)

p.kaczmarek2 wrote:

do you have this flag already implemented

Unfortunately no, I have quite a bit of time /like everyone else these days/. I just wanted to try drv_widget on my html. I don't have time to change the code right now, maybe on the weekend.
If you want, feel free to do it your way, I won't get to it now.

So how do we do that? A simple way? bShowOnAllPages?

Or maybe a wildcard-supporting path string to match so page can tell when to load?

The latter seems better...

p.kaczmarek2 wrote:

PS: Today I also did a OpenWeatherMap integration (separate driver)

I saw it in the changeslist in releases, I'm looking forward to checking it out. You're unstoppable.

Added after 3 [minutes]:

p.kaczmarek2 wrote:

maybe a wildcard-supporting path string to match

yeah, I thought about that too. * for everything, cfg* and so on. I think the wildcard you suggest is great, regex is unnecessary in my opinion.

Added after 3 [minutes]:

>>21331835
I was still thinking about a list, but it would probably be unnecessary to complicate it that much. In reality, most of the things will be needed on the main page, and for the rest a wildcard is best solution.