OpenBK7231T_App icon indicating copy to clipboard operation
OpenBK7231T_App copied to clipboard

Templates and device repository like Tamsota?

Open TommySharpNZ opened this issue 2 years ago • 8 comments

Tasmota has "templates" to let us easy setup specific devices and there is also a very nice directory of all supported devices. Do we have anything like this planned?

TommySharpNZ avatar Jun 30 '22 11:06 TommySharpNZ

The 'templates' are hard coded at the moment as 'quick setup' dropdown options. However, there is also an easier to update webapp (written as a set of Vuejs single pages) which could easily access an external source - maybe a github page or wiki - where additional 'templates' could be stored. If we did it as a wiki, then templates could be publicly contributed....?

btsimonh avatar Jun 30 '22 11:06 btsimonh

@btsimonh this is the way, would you like to implement it? Along with device photos (so everyone know what is what) and links to Elektroda teardowns

openshwprojects avatar Jun 30 '22 14:06 openshwprojects

It seems to me that the webapp provides a method of using web resources easily, and is easier to modify than the source code of the devices. And it saves us storage in the actual device.... I'm sure that if we had a set of github wiki pages with some defined structure, we could easily read them for the data part of the 'template', and link to them for the wordy part (including links to forum teardowns, etc. - I love that part because to be able to confirm that you have the exact same device & circuit adds confidence...). But; we'd need some buy-in from others here with the ability to code in the vuejs webapp - it's a fair platform at the moment - technically it fits but I'm not the greatest when it comes to UI!. s

btsimonh avatar Jun 30 '22 14:06 btsimonh

Tasmota expects you to type/paste in a csv string for the template.... Which is handy for developing and testing templates but easy to stuff up for newbies... So possibly 2 options to pick from a defined list pulled from GitHub and a second advanced option to type in your own?

A repository with a page per device with photos and teardown would be very cool!

TommySharpNZ avatar Jul 01 '22 06:07 TommySharpNZ

There will be lots of teardowns, altough I first write them in polish and then translate. Here is an example one: https://www.elektroda.pl/rtvforum/viewtopic.php?t=3903356&highlight= I made sure that photos are of good enough quality. Translation pending.

"Tasmota expects you to type/paste in a csv string for the template" It should be obvious that the underlying template mechanism will be a CSV string (or something like that), with an extra templates repository available through the App

The repository should have a search function and it should be possible to look for device with multiple keywords (eg. entering the name of chip on board should filter the devices...)

openshwprojects avatar Jul 01 '22 08:07 openshwprojects

Just to add my 2 cents, I'm pretty excited that you've put in all that effort to make it Tasmota-like - thx a lot for that.

To me the use of a customizable template is also key to have this firmware rolled out more widely. I recently bought a few of those Aubess switches and ended up replacing the chip with a pin-compatible ESP on one of them, but wait for a more "plausible" solution for the others, which has arrived now thx to your efforts.

I have a plausible configuration for those switches, but it is obviously tedious to apply it without a template... the other issue is that I believe that (like me) a lot of nerds are experimenting around getting it finally to work, but don't share the information in the form of a full teardown and blog entry... I think it would be great to just have a WIKI page to temporarily collect all this information to not have it lost....

belveder79 avatar Jul 20 '22 12:07 belveder79

I personally think a Repository with some Kind of defined File-Format (like Tasmota) and a custom Frontend like Tasmota because that way someone would review the new templates and it is not that likely that non working or incorrect templates are made. I also already thought about this using github pages and Blazor webassembly but wasn't sure hopw to access the Github files without downloading them.

LuisThe0ne avatar Aug 16 '22 14:08 LuisThe0ne

So if anyone is interested, here would be my concept for this:

A simple device Repository on GitHub (like Tasmota) with a Website built with jekyll (again like Tasmota) and somewhat of a "Install button" that asks you for a IP Address and the redirects you to the Address with some kind of argument like (?template="") and in the WebApp it would be possible to implement the same but with some kind of button event handler or so (Idk what were able to do with Vue.js) that displays the Website on a Iframe but when the Install button is clicked you don't need to enter a IP address.

LuisThe0ne avatar Aug 17 '22 07:08 LuisThe0ne

Let's say it's done, we have a database here: https://github.com/OpenBekenIOT/webapp/blob/gh-pages/devices.json Thank you for all your suggestions. If you have any devices, submit them here: https://github.com/OpenBekenIOT/webapp/blob/gh-pages/devices.json and post a teardown on Elektroda. Thanks!

openshwprojects avatar Oct 04 '22 16:10 openshwprojects