Aquilegia, a complete help system embedded on Duet boards
Posted by PRZ
|
Aquilegia, a complete help system embedded on Duet boards August 20, 2016 03:23PM |
Registered: 8 years ago Posts: 475 |
I propose Aquilegia, a complete help system coupled with DWC (Duet Web Server), the interface of RepRap Firmware, to be installed on the Duet itself.
1/ Presentation
On Wired Duets, the help system files are installed on the SD card and the system propose a complete RepRap Firmware and Duets documentation, including a fast search tool and backlinks.
The documentation is a merge of the documentation of the RepRap Wiki and the Duet3D (DuetWiFi) wiki, with a few added pages which were never published. I also reworked electrical schematics. This documentation is in principle up to date, but I may have missed a few stuff.
It also add an important resource, the RepRap wiki G-code page filtered for codes only applicables to Duet.
Menu collapse on small screens and large images autoresize on small screen, to have nice viewing on smartphones.
When installed on your SD card (On Duet 0.8.5 and Duet 0.6), the help documentation recognise the board (while connected) and select the displayed documentation accordingly.
It is accessible by clicking the added 'Help' button on the DWC navigation bar.
2/ Demonstration
You will find the exact same application installed alone (without DWC) here: [otocoup.com]
This independant version do have a manual selector to choose the applicable board.
Note: You can deep link on a page, paragraph in a page or on a search word, so don't hesitate to make a link about a particular topic.
This web address will stay, but T3P3 may creates own space to serve resources.
3/ Availability
Yet this only available for wired Duets. On the Duet WiFi DWC is integrally installed in the WiFi module and the memory available is a bit short to serve all Aquilegia documentation images. Modifications are needed to the firmware to have it serving resources from the SD card. We are working on that.
Documentation page access is relatively fast, but large images may take time to load from the SD card. It is recommended to replace the original SD card for a faster one (not only for the help system...).
When a permanent resource site will be installed, resources could be served from this site, so you can have documentation permanently up to date.
Till that, you can use my site if you wish (set parameter aqlO.domain in file aql.js), I have sufficient bandwith. In addition to being up to date, it is faster than serving locally from SD card.
4/ Interaction between Aquilegia and DWC
The interaction is minimal, just adding help opening button, opening/closing some blocks and detecting the board. Just a few blocks are added to the HTML as the whole help page is dynamically created. There is some modifications to upload updates files through web interface.
5/ Known troubles or uncertainty
* This was never tested on Safari
* Some display problems on Android browser.
6/ How to install it
The zip file you can find here [otocoup.com] contains:
Files which shall be installed in existing directories:
- /www/js/aql.js the help server
- /www/css/aql.css the css of the help page
- /www/reprap.htm a modified version of DWC adding the help html blocks and help call buttons
- /www/js/model.js a slightly modified version of DWC Javascript for board recognition and file update
- /www/js/viewmodel.js a slightly modified version of DWC Javascript for board recognition
A new directory contains all the resources of Aquilegia, text and images:
- /www/h/
Please note that while in theory this can be installed via FTP, there is a serious bug which make the file listing in FTP uncomplete (it stops at 56th file on images directory). A direct examination of the SD card have shown that, while not listed, all files were properly transferred, but you are in the blind. So I recommend to do direct transfer on the SD card. In any case, any transfer by FTP shall be followed by a board reset (M999) as FTP transfer seems to create troubles in firmware operation.
You can find the DWC fork here [github.com], but you shall not need it as there is no need to reinstall the whole DWC.
7/ Update
All files, notably text file (hlp.txt) and image files (with special file extensions) will be updated through the web interface as other DWC files.
8/ How does it work and where does it came from
This is a completely new application, designed on purpose and programmed from scratch.
You will find details and some history here: [aquilegia.blue]
Edited 1 time(s). Last edit at 08/20/2016 04:35PM by PRZ.
Pierre
- Safety [reprap.org]
- Embedded help system for Duet and RepRap Firmware [forums.reprap.org]
- Enclosed delta printers Lily [rouzeau.net] and Lily Big [rouzeau.net]
- OpenScad delta printer simulator [github.com]
- 3D printing on my site [www.rouzeau.net]
1/ Presentation
On Wired Duets, the help system files are installed on the SD card and the system propose a complete RepRap Firmware and Duets documentation, including a fast search tool and backlinks.
The documentation is a merge of the documentation of the RepRap Wiki and the Duet3D (DuetWiFi) wiki, with a few added pages which were never published. I also reworked electrical schematics. This documentation is in principle up to date, but I may have missed a few stuff.
It also add an important resource, the RepRap wiki G-code page filtered for codes only applicables to Duet.
Menu collapse on small screens and large images autoresize on small screen, to have nice viewing on smartphones.
When installed on your SD card (On Duet 0.8.5 and Duet 0.6), the help documentation recognise the board (while connected) and select the displayed documentation accordingly.
It is accessible by clicking the added 'Help' button on the DWC navigation bar.
2/ Demonstration
You will find the exact same application installed alone (without DWC) here: [otocoup.com]
This independant version do have a manual selector to choose the applicable board.
Note: You can deep link on a page, paragraph in a page or on a search word, so don't hesitate to make a link about a particular topic.
This web address will stay, but T3P3 may creates own space to serve resources.
3/ Availability
Yet this only available for wired Duets. On the Duet WiFi DWC is integrally installed in the WiFi module and the memory available is a bit short to serve all Aquilegia documentation images. Modifications are needed to the firmware to have it serving resources from the SD card. We are working on that.
Documentation page access is relatively fast, but large images may take time to load from the SD card. It is recommended to replace the original SD card for a faster one (not only for the help system...).
When a permanent resource site will be installed, resources could be served from this site, so you can have documentation permanently up to date.
Till that, you can use my site if you wish (set parameter aqlO.domain in file aql.js), I have sufficient bandwith. In addition to being up to date, it is faster than serving locally from SD card.
4/ Interaction between Aquilegia and DWC
The interaction is minimal, just adding help opening button, opening/closing some blocks and detecting the board. Just a few blocks are added to the HTML as the whole help page is dynamically created. There is some modifications to upload updates files through web interface.
5/ Known troubles or uncertainty
* This was never tested on Safari
* Some display problems on Android browser.
6/ How to install it
The zip file you can find here [otocoup.com] contains:
Files which shall be installed in existing directories:
- /www/js/aql.js the help server
- /www/css/aql.css the css of the help page
- /www/reprap.htm a modified version of DWC adding the help html blocks and help call buttons
- /www/js/model.js a slightly modified version of DWC Javascript for board recognition and file update
- /www/js/viewmodel.js a slightly modified version of DWC Javascript for board recognition
A new directory contains all the resources of Aquilegia, text and images:
- /www/h/
Please note that while in theory this can be installed via FTP, there is a serious bug which make the file listing in FTP uncomplete (it stops at 56th file on images directory). A direct examination of the SD card have shown that, while not listed, all files were properly transferred, but you are in the blind. So I recommend to do direct transfer on the SD card. In any case, any transfer by FTP shall be followed by a board reset (M999) as FTP transfer seems to create troubles in firmware operation.
You can find the DWC fork here [github.com], but you shall not need it as there is no need to reinstall the whole DWC.
7/ Update
All files, notably text file (hlp.txt) and image files (with special file extensions) will be updated through the web interface as other DWC files.
8/ How does it work and where does it came from
This is a completely new application, designed on purpose and programmed from scratch.
You will find details and some history here: [aquilegia.blue]
Edited 1 time(s). Last edit at 08/20/2016 04:35PM by PRZ.
Pierre
- Safety [reprap.org]
- Embedded help system for Duet and RepRap Firmware [forums.reprap.org]
- Enclosed delta printers Lily [rouzeau.net] and Lily Big [rouzeau.net]
- OpenScad delta printer simulator [github.com]
- 3D printing on my site [www.rouzeau.net]
|
Re: Aquilegia, a complete help system embedded on Duet boards August 21, 2016 03:07AM |
Registered: 8 years ago Posts: 117 |
|
Re: Aquilegia, a complete help system embedded on Duet boards September 02, 2016 06:32PM |
Registered: 8 years ago Posts: 70 |
|
Re: Aquilegia, a complete help system embedded on Duet boards September 06, 2016 12:38PM |
Registered: 8 years ago Posts: 475 |
An update of Aquilegia (version DWC 1.11). To apply it, load the attached zip file (drag and drop on the button) in the [Settings] page , tab [General]. If you don't see the button, you shall unzoom, as button is hidden for small screens. This is an update, which work only if Aquilegia is already installed.
[otocoup.com]
You need to reload your interface to have the revision - that will be noticeable, there is some color in the titles now. Sometimes, You need to flush you browser cache to get new files.
Apart minor bugs corrections, there is :
- A few pages added or updated from the site Duet3d.com
- G-code page updated according RepRap Wiki update
- A new page on R/C servo operation
- Updated the release note page with Firmware 1.15 and DWC 1.12
- Updated the FAQ
A new version based on DWC 1.12 and capable to be loaded through web interface will be proposed soon, so if you haven't yet loaded Aquilegia, you may prefer to wait this new version.
Edited 1 time(s). Last edit at 09/06/2016 12:39PM by PRZ.
Pierre
- Safety [reprap.org]
- Embedded help system for Duet and RepRap Firmware [forums.reprap.org]
- Enclosed delta printers Lily [rouzeau.net] and Lily Big [rouzeau.net]
- OpenScad delta printer simulator [github.com]
- 3D printing on my site [www.rouzeau.net]
[otocoup.com]
You need to reload your interface to have the revision - that will be noticeable, there is some color in the titles now. Sometimes, You need to flush you browser cache to get new files.
Apart minor bugs corrections, there is :
- A few pages added or updated from the site Duet3d.com
- G-code page updated according RepRap Wiki update
- A new page on R/C servo operation
- Updated the release note page with Firmware 1.15 and DWC 1.12
- Updated the FAQ
A new version based on DWC 1.12 and capable to be loaded through web interface will be proposed soon, so if you haven't yet loaded Aquilegia, you may prefer to wait this new version.
Edited 1 time(s). Last edit at 09/06/2016 12:39PM by PRZ.
Pierre
- Safety [reprap.org]
- Embedded help system for Duet and RepRap Firmware [forums.reprap.org]
- Enclosed delta printers Lily [rouzeau.net] and Lily Big [rouzeau.net]
- OpenScad delta printer simulator [github.com]
- 3D printing on my site [www.rouzeau.net]
|
Re: Aquilegia, a complete help system embedded on Duet boards September 06, 2016 04:50PM |
Registered: 8 years ago Posts: 301 |
I really like the idea of this but think it needs to be merged into the DWC software. I can cope with loading new firmware and new webpages from time to time, but adding a 3rd item to the mix and for me its too much. Far easier just to visit a website for help than load a local copy.
DC42 Kossel 330mm x 2meters
My Thingiverse Creations
DC42 Kossel 330mm x 2meters
My Thingiverse Creations
Sorry, only registered users may post in this forum.