Re: [Machinekit] documentation

[schoone...@gmail.com]

There is a lot of documentation, a lot is generic linuxcnc / machinekit but still valid. eg. http://www.machinekit.io/docs/index-user/  will give you block level overview http://www.machinekit.io/docs/index-developer/  will give you details including NML > I have seen machinetalk with ZMQ and protobuf, and the structure seems clear. Glad you think so, few others do :) ringbuffers are just a detail, there is lots of info on the web as to how they work. They can be used for passing asynchronous data, no handshake protocols etc. The accessing client can retrieve what is important to it, either the whole stream or just the last piece of data for instance. The ROS intended jplan uses them https://github.com/machinekit/machinekit/tree/master/src/hal/jplanner Unfortunately the piece of s**t, google customised search engine for the actual docs, has ceased working again. They have undoubtedly changed something in the api again. However you just have to use some intelligent searching Enter in a google search bar - `site:machinekit.io NML` for instance to get pages of hits where NML is mentioned in machinekit docs. The documentation website has been thoroughly harvested by google, because I fed it for weeks to ensure every level was visited regards On 23/10/18 20:52, mngr wrote: Hi, I have made a little project developed around Machinekit and now I have to do a report on the project, I think I will do an introduction to explain what does Machinekit do, and how it works. That kind of documentation is currently lacking, that can be a good occasion to write some of it. In this period I learned something about machinekit and the HAL, but more on the "how to use" rather than "how it works". I heard often talking about ring-buffer and NML, and it is not really clear to me what they are and what they are used for. I have seen machinetalk with ZMQ and protobuf, and the structure seems clear. I tried to look search in the group, or looking in the code, but it is hard... I am not expert enough to write that documentation by myself, can you help me in writing it? First question would be: how do you think it should be structured? mngr -- website: http://www.machinekit.io blog: http://blog.machinekit.io github: https://github.com/machinekit --- You received this message because you are subscribed to the Google Groups "Machinekit" group. To unsubscribe from this group and stop receiving emails from it, send an email to machinekit+unsubscr...@googlegroups.com. Visit this group at https://groups.google.com/group/machinekit. For more options, visit https://groups.google.com/d/optout. -- website: http://www.machinekit.io blog: http://blog.machinekit.io github: https://github.com/machinekit --- You received this message because you are subscribed to the Google Groups "Machinekit" group. To unsubscribe from this group and stop receiving emails from it, send an email to machinekit+unsubscr...@googlegroups.com. Visit this group at https://groups.google.com/group/machinekit. For more options, visit https://groups.google.com/d/optout.