Re: [Emc-users] Hal file naming conventions

[Todd Zuercher]

For items that aren't easily named, a comment line (#comment) in the hal file 
can be useful.

Todd Zuercher
P. Graham Dunn Inc.
630 Henry Street 
Dalton, Ohio 44618
Phone:  (330)828-2105ext. 2031

-Original Message-
From: David Berndt  
Sent: Thursday, May 14, 2020 12:39 AM
To: emc-users@lists.sourceforge.net
Subject: [Emc-users] Hal file naming conventions

[EXTERNAL EMAIL] Be sure links are safe.

Wondering if anyone cares to share with me a useful naming convention for your 
signals? Do you also use the name parameters to name your components or do you 
just stick with and2.0 thru and2.x?

My hal config works fine, but I worry about anyone that might have to look at 
it after me, or even if I have to look at it again after a year or two.

Apologies if this has come up before, I did a bit of light googling and didn't 
find much on the topic.

-Dave





___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users


___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Hal file naming conventions

[Gene Heskett]

On Thursday 14 May 2020 12:12:26 Roland Jollivet wrote:

> Just add a comment at the top referencing a text file where you have
> it all described?
>
Shirley (or Roland) you jest. It makes far more sense to clutter up your 
hal files with comment blocks for function headers that explain that, I 
find that I am doing more and more of that as its about the only thing 
that makes sense in a reasonable time frame later. But that also gets in 
the way of copy/paste stuff as I come up with new functions that then 
need copied to the other 3 machines since I'm dealing with two lathes, a 
G0704, and a 6040 here. Each of which has its strong points and 
gotcha's.  And there's only one of me to track all that. :(  I need a 
couple clones, but then I'd have to feed them too.

> On Thu, 14 May 2020 at 06:42, David Berndt  wrote:
> > Wondering if anyone cares to share with me a useful naming
> > convention for your signals? Do you also use the name parameters to
> > name your components or do you just stick with and2.0 thru and2.x?
> >
> > My hal config works fine, but I worry about anyone that might have
> > to look
> > at it after me, or even if I have to look at it again after a year
> > or two.
> >
> > Apologies if this has come up before, I did a bit of light googling
> > and didn't find much on the topic.
> >
> > -Dave
> >
> >
> >
> >
> >
> > ___
> > Emc-users mailing list
> > Emc-users@lists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/emc-users
>
> ___
> Emc-users mailing list
> Emc-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/emc-users


Cheers, Gene Heskett
-- 
"There are four boxes to be used in defense of liberty:
 soap, ballot, jury, and ammo. Please use in that order."
-Ed Howdershelt (Author)
If we desire respect for the law, we must first make the law respectable.
 - Louis D. Brandeis
Genes Web page 


___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Hal file naming conventions

[David Berndt]

I guess my biggest issue is I don't name the components themselves. Then  
when I try to describe what a signal is connecting it's connecting some  
terribly named thing, with another terribly named thing, so my signals end  
up not being very usefully named thing like SigNot2And27 or whatever  
nonsense occurs to me at the time. I guess I should start with my  
components and maybe the the rest might fall more into place.




On Thu, 14 May 2020 07:57:55 -0400, andy pugh  wrote:


On Thu, 14 May 2020 at 05:42, David Berndt  wrote:

Wondering if anyone cares to share with me a useful naming convention  
for
your signals? Do you also use the name parameters to name your  
components

or do you just stick with and2.0 thru and2.x?


I like to give them names that include what they are and what they do.

and.sp_intrlk for the spindle interlock, that sort of idea.
I think it is important to leave some clue what the component function  
is.



___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Hal file naming conventions

[andy pugh]

On Thu, 14 May 2020 at 05:42, David Berndt  wrote:

> Wondering if anyone cares to share with me a useful naming convention for
> your signals? Do you also use the name parameters to name your components
> or do you just stick with and2.0 thru and2.x?

I like to give them names that include what they are and what they do.

and.sp_intrlk for the spindle interlock, that sort of idea.
I think it is important to leave some clue what the component function is.

-- 
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, 1912


___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Hal file naming conventions

[Gene Heskett]

On Thursday 14 May 2020 00:39:28 David Berndt wrote:

> Wondering if anyone cares to share with me a useful naming convention
> for your signals? Do you also use the name parameters to name your
> components or do you just stick with and2.0 thru and2.x?
>
> My hal config works fine, but I worry about anyone that might have to
> look at it after me, or even if I have to look at it again after a
> year or two.
>
> Apologies if this has come up before, I did a bit of light googling
> and didn't find much on the topic.
>
> -Dave
>
Its pretty much an individual preference David. I've got some pretty long 
hal files because I'm always figuring out ways to "do it better", and I 
try to use meaningful names for those modules that can be named, but not 
all can be named.  But I've found that going back into it to change 
something a year later, it still takes me quite some time to "get back 
into my own head and figure out what the heck I was doing here", and 
names doesn't seem to be as much help as I thought it was going to be.

OTOH, the wet ram here is also going on 86 yo, and I've had some medical 
problems that have also had an effect on that wet ram that in 1946, 
tested at 147 on the Iowa test, and made a 98 on the AFQT in the middle 
of Korea.  Most notable was a pulmonary embolism when I was 79 & those 
things have about a 2% survival rate, and I am a long time DM-II 
diabetic so I had my heart worked on this past winter after a heart 
attack.  Pacemaker, Bunch of stents and a new Aortic valve.

I think now, that just appending the function its involved in to its 
basic name may be the most helpfull later. But I've not always done 
that, which results in unseemly mutterings later. :(

I agree, there ought to be an obviously better way, but I am not 
convinced I've found it yet.  Rebuilding those modules that cannot be 
named, to allow that would seem to help, but some really are legacy 
modules and how many bugs would be induced doing that today?.  Working 
code I am convinced, ought not to to be played with just for that.

Stay well and safe David.

Cheers, Gene Heskett
-- 
"There are four boxes to be used in defense of liberty:
 soap, ballot, jury, and ammo. Please use in that order."
-Ed Howdershelt (Author)
If we desire respect for the law, we must first make the law respectable.
 - Louis D. Brandeis
Genes Web page 


___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users

Re: [Emc-users] Hal file naming conventions

[Phill Carter]

> On 14 May 2020, at 2:39 pm, David Berndt  wrote:
> 
> Wondering if anyone cares to share with me a useful naming convention for 
> your signals? Do you also use the name parameters to name your components or 
> do you just stick with and2.0 thru and2.x?

FWIW I try to give components a name relating to what they are doing, that 
kinda helps my lack of memory.

Cheers, Phill.

___
Emc-users mailing list
Emc-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-users