MichaelJonker / HardwareSerialRS485

Arduino Software for RS485 support with collision detection and message handling capabilities
MIT License
107 stars 29 forks source link

@PlatformIO Library Registry manifest file #4

Open valeros opened 8 years ago

valeros commented 8 years ago

Description

MichaelJonker commented 8 years ago

Dear Valeros,

thank you for your interest in this software library and the contribution you propose. I am willing to add the .json file that you propose top add. Could you, however, briefly explain in what environment and for what purposes this .json file is used (maybe provide a few lines that can be added to the documentation). And secondly, what the purpose and effect is of exclude "extras" in line 9. The extras directory contain an example of the boards.txt file that the user has to adapt (see https://github.com/MichaelJonker/HardwareSerialRS485/wiki/user-adaptations). Omitting this directory from the distribution invalidates instructions that are shipped with the distribution.

Sorry for my delayed reply. I did not receive many reaction until recently (i.e. until a bug was fixed with the library manager of the Arduino IDE)

per1234 commented 6 years ago

PlatformIO now allows the use of the existing library.properties file as an alternative to adding a library.json file: http://docs.platformio.org/en/latest/userguide/lib/cmd_register.html#description I think that it makes sense to only have a single metadata file because it's less maintenance. library.properties works for the Arduino IDE and PlatformIO so it's the logical choice.

per1234 commented 6 years ago

In fact, this library is already in the PlatformIO library registry (not added by me): https://platformio.org/lib/show/225/HardwareSerial_RS485