Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not all gcodes are documented in the wiki #614

Closed
minad opened this issue Feb 15, 2015 · 10 comments
Closed

Not all gcodes are documented in the wiki #614

minad opened this issue Feb 15, 2015 · 10 comments

Comments

@minad
Copy link
Contributor

minad commented Feb 15, 2015

For example M20 is missing. Is there are way to generate this or why is it missing after all?

I also wonder about the format of the output. Are not all of the codes well defined? Marlin obviously uses a different format: http://reprap.org/wiki/G-code#M20:_List_SD_card

@arthurwolf
Copy link
Contributor

I've done a lot of work recently trying to keep the wiki up to date.
If you see anything missing, don't hesitate to add it, it's a wiki.

@minad
Copy link
Contributor Author

minad commented Feb 15, 2015

I know. I just wanted to point it out for people (including me) to work on it. I usually keep issues open for awareness (if they are not completely resolved).

@minad
Copy link
Contributor Author

minad commented Feb 15, 2015

Also the reprap wiki should be kept up to date concerning smoothie. But I would prefer to automatize this 😝 A short ruby or perl script can do wonders here.

@arthurwolf
Copy link
Contributor

I don't think with the way the code is, we can automate it. That'd be nice but I don't think it can be done.

@minad
Copy link
Contributor Author

minad commented Feb 15, 2015

well one can regexp-"parse" for all these ->has_m ->m constructs and get a good heuristical result. This can be done in a few minutes if you don't expect 100% accuracy. I mean at the end such a check-gcode-script could just print missing ones. False positives are no problem. Perfect syncing is not a good idea, I agree. Except if we might add some kind of stupid docstrings to the c++ code i.e. @gcode M20 ... ;)

@minad minad changed the title Not all gcodes are document in the wiki Not all gcodes are documented in the wiki Feb 15, 2015
@arthurwolf
Copy link
Contributor

There has been a lot of work on this a while back, closing this issue for now. Please feel free to re-open or open a new one if you notice anything.

@sorki
Copy link
Contributor

sorki commented Jun 30, 2015

This would be really nice to have as there are undocumented g-codes in code and g-codes for which documentation doesn't match. Implementation can be as simple as parsing comments from source files that would use some simple format like:

# G30 F<mm/s> Z<mm> probe at current point
#   F - probing feedrate
#   Z - height to return to after probing

@arthurwolf
Copy link
Contributor

Unless jim has an idea of why this is a bad idea, I -think- this is a good idea :) But I often miss stuff.

So, yes, if somebody was to add this to the code source, it would be a nice addition, and I could make a script that updates the wiki.

It's a lot of work though, not sure who will do this.

The exact same thing could be done for configuration options ...

@wolfmanjm
Copy link
Contributor

It's not a bad idea, but who is going to edit 100's of files? and then write the script to do it?
Not me :)

@arthurwolf
Copy link
Contributor

I'll write the script, but I most definitely won't edit the files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants