Re: [Emc-users] Missing Documentation - I think

[Joe Hildreth]

I will be happy to do that.  Did you notice any other discrepancies with the 
man page.  It was a shot from the hip in a way since I am trying to learn and 
document at the same time.  :-)

Joe

- On Apr 6, 2017, at 11:33 AM, Sebastian Kuzminsky s...@highlab.com wrote:

> On Thu, Apr 06, 2017 at 11:25:06AM -0500, Joe Hildreth wrote:
>> I probably should correct that and resubmit it, yes?  Thanks for
>> reading it, hind-sight being 20/20 and all, I probably should have
>> asked you to look it over before submitting it.
> 
> No problem.  It's already a solid step forward, and iterating is how we
> make things better.
> 
> Update your local linuxcnc git clone, then make a new commit that fixes
> the issue, and make another PR and one of us will merge it.
> 
> Ask here or on IRC if any of that is unclear.
> 
> 
> --
> Sebastian Kuzminsky

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Sebastian Kuzminsky]

On Thu, Apr 06, 2017 at 11:25:06AM -0500, Joe Hildreth wrote:
> I probably should correct that and resubmit it, yes?  Thanks for
> reading it, hind-sight being 20/20 and all, I probably should have
> asked you to look it over before submitting it.

No problem.  It's already a solid step forward, and iterating is how we
make things better.

Update your local linuxcnc git clone, then make a new commit that fixes
the issue, and make another PR and one of us will merge it.

Ask here or on IRC if any of that is unclear.


-- 
Sebastian Kuzminsky

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Joe Hildreth]

I probably should correct that and resubmit it, yes?  Thanks for reading it, 
hind-sight being 20/20 and all, I probably should have asked you to look it 
over before submitting it.

Joe

- On Apr 6, 2017, at 11:12 AM, Sebastian Kuzminsky s...@highlab.com wrote:

> On Thu, Apr 06, 2017 at 10:46:56AM -0500, Joe Hildreth wrote:
>> Well, what a learning experience that was.  Have the manpage written,
>> forked the linuxcnc project, added my page, committed and signed,
>> and done a pull request. (With some help from some folks on the devel
>> IRC channel).  At any rate, it shows up in the documentation for 2.7
>> and 2.8-pre so I am happy.  Hopefully, I didn't butcher the manpage
>> up too bad.
> 
> It looks great, thanks!
> 
> A nit-pick about the Description section: it seems to imply that
> hal_manualtoolchange stops the spindle and pauses the program, but it's
> actually Motion that does that, before asking hal_manualtoolchange to
> change tools.
> 
> 
> --
> Sebastian Kuzminsky

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Sebastian Kuzminsky]

On Thu, Apr 06, 2017 at 10:46:56AM -0500, Joe Hildreth wrote:
> Well, what a learning experience that was.  Have the manpage written,
> forked the linuxcnc project, added my page, committed and signed,
> and done a pull request. (With some help from some folks on the devel
> IRC channel).  At any rate, it shows up in the documentation for 2.7
> and 2.8-pre so I am happy.  Hopefully, I didn't butcher the manpage
> up too bad.

It looks great, thanks!

A nit-pick about the Description section: it seems to imply that
hal_manualtoolchange stops the spindle and pauses the program, but it's
actually Motion that does that, before asking hal_manualtoolchange to
change tools.


-- 
Sebastian Kuzminsky

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Joe Hildreth]

Sebastian,

Well, what a learning experience that was.  Have the manpage written, forked 
the linuxcnc project, added my page, committed and signed, and done a pull 
request. (With some help from some folks on the devel IRC channel).  At any 
rate, it shows up in the documentation for 2.7 and 2.8-pre so I am happy.  
Hopefully, I didn't butcher the manpage up too bad.

Thanks for the encouragement.  

Joe

- On Apr 4, 2017, at 7:03 PM, Sebastian Kuzminsky s...@highlab.com wrote:

> On 04/04/2017 05:54 PM, Joe Hildreth wrote:
>> DOH!
>>
>> I guess I should have dug a little more.  Thanks Andy.
>>
>> So would you guys still like me to tackle the man page for the component.  
>> Been
>> reading up on how to construct them, and I am willing to give it a go.
> 
> It would be good to have a manpage for that component, but I think it's
> not urgent.  Your is the first request for information i remember seeing
> about it.
> 
> Writing manpages in roff is rough, but the halstreamer manpage i
> mentioned earlier is written in asciidoc, which is much simpler.
> 
> 
> --
> Sebastian Kuzminsky

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Sebastian Kuzminsky]

On 04/04/2017 05:54 PM, Joe Hildreth wrote:
> DOH!
>
> I guess I should have dug a little more.  Thanks Andy.
>
> So would you guys still like me to tackle the man page for the component.  
> Been reading up on how to construct them, and I am willing to give it a go.

It would be good to have a manpage for that component, but I think it's 
not urgent.  Your is the first request for information i remember seeing 
about it.

Writing manpages in roff is rough, but the halstreamer manpage i 
mentioned earlier is written in asciidoc, which is much simpler.


-- 
Sebastian Kuzminsky

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Joe Hildreth]

DOH!

I guess I should have dug a little more.  Thanks Andy.

So would you guys still like me to tackle the man page for the component.  Been 
reading up on how to construct them, and I am willing to give it a go.

- On Apr 4, 2017, at 6:21 PM, andy pugh bodge...@gmail.com wrote:

> On 4 April 2017 at 19:56, Joe Hildreth  wrote:
>> I am looking through the docs and cannot find a man page for the
>> hal_manualtoolchange userspace component,
> 
> It is hidden:
> http://linuxcnc.org/docs/2.7/html/gui/axis.html#_manual_tool_change
> 
> --
> atp

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Joe Hildreth]

Thanks Dewey that helped a bunch.

- On Apr 4, 2017, at 4:42 PM, Dewey Garrett dgarr...@panix.com wrote:

>> So this tells me what pins are created,
>> the only one I am unsure of is the
>> change_button, can someone explain this one?
> 
> By default, one must click the 'Continue'
> button on the tool change popup gui to
> acknowledge the manual tool change.
> 
> The pin 'hal_manualtoolchange.change_button'
> may be connected through hal to a pin
> wired to a physical hardware button to
> allow acknowledgement by other means.  The
> button could be part of a panel or pendant
> for instance.
> 
> To demonstrate usage from the command line:
> 
> $ sim_pin: hal_manualtoolchange.change_button
> --
> Dewey Garrett

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[andy pugh]

On 4 April 2017 at 19:56, Joe Hildreth  wrote:
> I am looking through the docs and cannot find a man page for the 
> hal_manualtoolchange userspace component,

It is hidden:
http://linuxcnc.org/docs/2.7/html/gui/axis.html#_manual_tool_change

-- 
atp
"A motorcycle is a bicycle with a pandemonium attachment and is
designed for the especial use of mechanical geniuses, daredevils and
lunatics."
— George Fitch, Atlanta Constitution Newspaper, 1916

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Dewey Garrett]

> So this tells me what pins are created,
> the only one I am unsure of is the
> change_button, can someone explain this one?

By default, one must click the 'Continue'
button on the tool change popup gui to
acknowledge the manual tool change.

The pin 'hal_manualtoolchange.change_button'
may be connected through hal to a pin
wired to a physical hardware button to
allow acknowledgement by other means.  The
button could be part of a panel or pendant
for instance.

To demonstrate usage from the command line:

$ sim_pin: hal_manualtoolchange.change_button
-- 
Dewey Garrett


--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Joe Hildreth]

Sebastian,

I will be happy to try to write it.

Joe

- On Apr 4, 2017, at 2:34 PM, Sebastian Kuzminsky s...@highlab.com wrote:

> On 04/04/2017 01:13 PM, Joe Hildreth wrote:
>> Looking at the ha;_manualtoolchange.py file, I see the following:
>>
>> h = hal.component("hal_manualtoolchange")
>> h.newpin("number", hal.HAL_S32, hal.HAL_IN)
>> h.newpin("change", hal.HAL_BIT, hal.HAL_IN)
>> h.newpin("change_button", hal.HAL_BIT, hal.HAL_IN)
>> h.newpin("changed", hal.HAL_BIT, hal.HAL_OUT)
>> h.ready()
>>
>> So this tells me what pins are created, the only one I am unsure of is the
>> change_button, can someone explain this one?
>>
>> I know this seems petty, but I am trying to wrap my head around it enough so 
>> I
>> can teach a few high schoolers what is going on.  Or maybe a little glimpse 
>> of
>> how the parts fit and work together.  Before I can do that, I need to teach
>> myself.
>>
>> My impression is the hal_manualtoolchange component does the following:
>>
>> a) receives the tool number via hal_manualtoolchange.number pin
>> b) receives a command to change the tool via hal_manualtoolchange.change pin
>> c) The component then opens the dialog informing the user to change to tool 
>> #X
>> d) User does the tool change and clicks the okay button.
>> e) the okay button send signal via hal_manualtoolchange.changed
>>
>> am I close?
> 
> You're exactly correct, that's what hal_manualtoolchange does.
> 
> The M6 g-code triggers the tool change operation, and blocks until
> hal_manualtoolchange asserts the .changed pin.
> 
> 
> You're also right that we don't have a manpage for that component.
> Since you know it so well now, why not try writing one?  It's easy and
> fun!  ;-)
> 
> Take a look at docs/src/man/man1/halstreamer.txt for inspiration.
> 
> Some docs on how to check out and modify LinuxCNC and how to contribute
> the changes back to the community can be found here:
> 
> http://linuxcnc.org/docs/devel/html/code/building-linuxcnc.html
> http://linuxcnc.org/docs/devel/html/code/contributing-to-linuxcnc.html
> 
> 
> --
> Sebastian Kuzminsky
> 
> --
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> ___
> Emc-users mailing list
> Emc-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/emc-users

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Sebastian Kuzminsky]

On 04/04/2017 01:13 PM, Joe Hildreth wrote:
> Looking at the ha;_manualtoolchange.py file, I see the following:
>
> h = hal.component("hal_manualtoolchange")
> h.newpin("number", hal.HAL_S32, hal.HAL_IN)
> h.newpin("change", hal.HAL_BIT, hal.HAL_IN)
> h.newpin("change_button", hal.HAL_BIT, hal.HAL_IN)
> h.newpin("changed", hal.HAL_BIT, hal.HAL_OUT)
> h.ready()
>
> So this tells me what pins are created, the only one I am unsure of is the 
> change_button, can someone explain this one?
>
> I know this seems petty, but I am trying to wrap my head around it enough so 
> I can teach a few high schoolers what is going on.  Or maybe a little glimpse 
> of how the parts fit and work together.  Before I can do that, I need to 
> teach myself.
>
> My impression is the hal_manualtoolchange component does the following:
>
> a) receives the tool number via hal_manualtoolchange.number pin
> b) receives a command to change the tool via hal_manualtoolchange.change pin
> c) The component then opens the dialog informing the user to change to tool #X
> d) User does the tool change and clicks the okay button.
> e) the okay button send signal via hal_manualtoolchange.changed
>
> am I close?

You're exactly correct, that's what hal_manualtoolchange does.

The M6 g-code triggers the tool change operation, and blocks until 
hal_manualtoolchange asserts the .changed pin.


You're also right that we don't have a manpage for that component. 
Since you know it so well now, why not try writing one?  It's easy and 
fun!  ;-)

Take a look at docs/src/man/man1/halstreamer.txt for inspiration.

Some docs on how to check out and modify LinuxCNC and how to contribute 
the changes back to the community can be found here:

http://linuxcnc.org/docs/devel/html/code/building-linuxcnc.html
http://linuxcnc.org/docs/devel/html/code/contributing-to-linuxcnc.html


-- 
Sebastian Kuzminsky

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Missing Documentation - I think

[Joe Hildreth]

Looking at the ha;_manualtoolchange.py file, I see the following:

h = hal.component("hal_manualtoolchange")
h.newpin("number", hal.HAL_S32, hal.HAL_IN)
h.newpin("change", hal.HAL_BIT, hal.HAL_IN)
h.newpin("change_button", hal.HAL_BIT, hal.HAL_IN)
h.newpin("changed", hal.HAL_BIT, hal.HAL_OUT)
h.ready()

So this tells me what pins are created, the only one I am unsure of is the 
change_button, can someone explain this one?

I know this seems petty, but I am trying to wrap my head around it enough so I 
can teach a few high schoolers what is going on.  Or maybe a little glimpse of 
how the parts fit and work together.  Before I can do that, I need to teach 
myself.

My impression is the hal_manualtoolchange component does the following:

a) receives the tool number via hal_manualtoolchange.number pin
b) receives a command to change the tool via hal_manualtoolchange.change pin
c) The component then opens the dialog informing the user to change to tool #X
d) User does the tool change and clicks the okay button.
e) the okay button send signal via hal_manualtoolchange.changed

am I close?  

Joe

- On Apr 4, 2017, at 1:56 PM, Joe Hildreth j...@threerivershospital.com 
wrote:

> Hello all,
> 
> I am looking through the docs and cannot find a man page for the
> hal_manualtoolchange userspace component, and only see reference to it in the
> HAL Examples section of the doc. Also missing is the man page for the parport
> rt module. Who do I need to request for these docs, or is it worth the time?
> 
> Thanks for putting up with me folks! :-)
> 
> Joe
> 
> --
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> ___
> Emc-users mailing list
> Emc-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/emc-users

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

[Emc-users] Missing Documentation - I think

[Joe Hildreth]

Hello all, 

I am looking through the docs and cannot find a man page for the 
hal_manualtoolchange userspace component, and only see reference to it in the 
HAL Examples section of the doc. Also missing is the man page for the parport 
rt module. Who do I need to request for these docs, or is it worth the time? 

Thanks for putting up with me folks! :-) 

Joe 

--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users