flagxor / ueforth

Apache License 2.0
94 stars 27 forks source link

more documentation please #6

Open arblake opened 3 years ago

arblake commented 3 years ago

Brad, I need more help and examples for setting up the web server and pages.

Adrian

flagxor commented 3 years ago

Sorry for the slow reply. Web server is a bit in flux. There's two approaches lightly documented at https://eforth.appspot.com/ The WebServer interface mirrors arduino's WebServer.h Alternatively, in v7.06+ I've added httpd, which implements a web server directly in sockets. Both have some issues and limitations, but my hope is to deprecate the older WebServer interface at some point. For current examples check out these: https://github.com/flagxor/eforth/blob/main/ueforth/esp32/camera_server.fs https://github.com/flagxor/eforth/blob/main/ueforth/posix/web_interface.fs

Apologies for the mess :-)

-BradN

bob-g4bby commented 3 years ago

Also see quite a good glossary of words (I'm the author!) at https://docs.google.com/spreadsheets/d/1UMBc05BkfW7QapvyUZYLIYJR7FAVHONnCJO_BEdAqCg/edit#gid=0

MPETREMANN11 commented 2 years ago

Good evening, On my personal site, I am working to set up documentation as complete as possible regarding ESP32Forth: https://esp32.arduino-forth.com/index/glossaire

bob-g4bby commented 2 years ago

Also see quite a good glossary of words (I'm the author!) at - should have been:- https://docs.google.com/spreadsheets/d/1UMBc05BkfW7QapvyUZYLIYJR7FAVHONnCJO_BEdAqCg/edit#gid=0 The words are grouped by topic e.g. STACK, MATHS etc. so that the new programmer only has a little list to find the word he wants. I am currently trying to figure out how to use the SOCKETS vocabulary - but lack of examples makes it a tall order. Were examples written for test purposes or is this vocabulary still untested? I've written and shared quite a bit of code for ESP32FORTH, but quite a few vocabularies remain too cryptic to be usable, which is a shame. At the same time I quite understand this is the work of one generous man and the project is still in a state of flux.

MPETREMANN11 commented 2 years ago

cryptic to be usable, which is a shame. At the same time I quite understand this is the work of one generous man and the project is

Good Job. On my web site, the documentation is often completed by examples. The documentation is in french and english https://esp32.arduino-forth.com/index/glossaire image

MPETREMANN11 commented 2 years ago

cryptic to be usable, which is a shame. At the same time I quite understand this is the work of one generous man and the project is

Good Job. On my web site, the documentation is often completed by examples. The documentation is in french and english https://esp32.arduino-forth.com/index/glossaire image

And I use highlithing the FORTH source code (writed in PHP). It's explained here: https://esp32.arduino-forth.com/article/highlightFORTHwithPHP

All highlighted code give access to online documentation....

MPETREMANN11 commented 2 years ago

I'm reading the Serial Communication. It's not complete. You omit Seria2.xxxxxx words. If you want to complete your documentation, I suggest you take the explanations on my site without worry.

bob-g4bby commented 2 years ago

Hi Marc, I would like to write some example programs using the SOCKETS vocabulary. I see a small example on your web page Understanding ESP32Forth Socket Management (arduino-forth.com). Do you have more? I would use the test and measurement language Labview on the PC to send and receive arrays of data, then write it up in a small paper. It seems a shame that users cannot transfer high speed data between esp32forth and a PC e.g. audio. The lack of documentation for certain vocabularies holds us back. I shall try to contact Bradley Nelson about it. Regards, Bob On Friday, 5 August 2022 at 21:55:51 BST, PETREMANN Marc @.***> wrote:

I'm reading the Serial Communication. It's not complete. You omit Seria2.xxxxxx words. If you want to complete your documentation, I suggest you take the explanations on my site without worry.

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.Message ID: @.***>

MPETREMANN11 commented 2 years ago

Hi Marc, I would like to write some example programs using the SOCKETS vocabulary....... My mail for direct contact: petremann(at)arduino-forth.com