Skip to content

Proposed rename of the library #456

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

Closed
z3t0 opened this issue Apr 23, 2017 · 7 comments
Closed

Proposed rename of the library #456

z3t0 opened this issue Apr 23, 2017 · 7 comments
Labels
Keep Keep issue

Comments

@z3t0
Copy link
Collaborator

z3t0 commented Apr 23, 2017

@shirriff @AnalysIR @bengtmartensson @marcmerlin

Hi all I am thinking of renaming this library to something like InfraredRemote or anything very similar. The intention being to change the file IRremote.h into something else... far too many distributions of arduino (including platformio) ship with RobotIRremote.

Thoughts?

This is a good time for this discussion as I am doing a lot of refactoring in v3 and many new changes are coming in with #437 and alike.

@AnalysIR
Copy link
Contributor

I think there is a lot of value in retaining the existing name in terms of:

  • Search engines
  • Use in existing projects, their descriptions and other online content
  • References & links in existing discussion groups/Forum etc
  • 'Brand'
  • The clever thing about the name is that 'it does what it says on the tin' (reference to a TV ad campaign) ,,, as does your suggestion.
  • & I guess history.....

Having said that, your point is also valid.

Are there any similar examples (with solutions) for other libraries?

How is it handled with forks of IRremote? (like Photon or ESP etc)?

What will happen when someone does the same with any new name.?

Unfortunately, I am not up to date with the requirements for the Arduino library management stuff etc to offer any better suggestion. Presumably having something like IRremoteV3 or IRremote3 or IRremote_Official or Original_IRremote etc would be an issue also.??

So like many things it may be a trade-off. My (not so strong) preference would be to stick with using 'IRremote' as part of any new name unless the issue you mentioned cannot be resolved by other means.

PS: I really don't understand why the creators of robotirremote, don't resolve the issue....'community spirit' etc. etc.

@z3t0
Copy link
Collaborator Author

z3t0 commented Apr 23, 2017

Ideally I am still pushing for removing robotirremote. I have created an issue on platformio and hopefully I can get a response there. The arduino team hasn't gotten back to so I may just try and contact them by email.

@bengtmartensson
Copy link
Contributor

I think AnalysIR has mentioned most of the arguments. Let me add that, as I foresee, it might happen that "we" want to make incompatible changes and therefore indicate this by another name (or version). Like Python3... That might mean pushing yet another name onto the community again...

If another name, how about -- inspired by the twitter name of **** -- realIRremote :-).

@marcmerlin
Copy link
Contributor

Didn't we establish that keeping this called IRRemote would be fine enough as long as the directory you get from git is also called IRRemote and not Arduino-IRRemote?
If the former is the case, at least the arduino IDE knows to get IRRemote.h from the right library.
But yes, the robotirremote stuff should also die :)

@z3t0
Copy link
Collaborator Author

z3t0 commented Apr 23, 2017

Didn't we establish that keeping this called IRRemote would be fine enough as long as the directory you get from git is also called IRRemote and not Arduino-IRRemote?

This doesnt always workout / isn't always ideal. For example I was running CI testing with platformio but had to explicitly delete the RobotIRremote library for the testing to work.

If anything we might just rename the main header file... it would be slightly different to the name of the library but better than renaming the entire library?

@marcmerlin
Copy link
Contributor

I know that it works on arduino IDE if you have IRRemote/IRRemote.h (it will take it over RobotIRremote), but if that's not true for platformIO, then your suggestion to rename the .h file is probably the easiest, yes.

@z3t0
Copy link
Collaborator Author

z3t0 commented Apr 23, 2017

@ArminJo ArminJo closed this as completed Oct 12, 2020
@ArminJo ArminJo added the Keep Keep issue label Dec 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Keep Keep issue
Projects
None yet
Development

No branches or pull requests

5 participants