[Library Submission] JsonTalkie

[ruiseixasm]

Repository: https://github.com/ruiseixasm/JsonTalkie
Library folder: Arduino/JsonTalkie

[per1234]

Closing as duplicate of #6332

@ruiseixasm I already explained the required procedure the last time you inappropriately tried to use an issue to submit your library (#6331). Clearly you read that, since you created a pull request per correct procedure (#6332). So why did you then create yet another pointless issue?

In the future, please behave in a more professional manner when interacting with this repository. We have limited resources available to maintain this busy repository that is an important resource for the entire Arduino community.

---

⚠ Repeated irresponsible behavior may result in the revocation of your Library Manager Registry privileges.

---

Thanks in advance for your cooperation.

[ruiseixasm]

I thought the Bot response you are referring too closed that same submission, and because it didn't mentioned the mandatory need of the library.properties to be in the root directory. I was following multiple 3rd party instructions that stated and insisted to me that it was really possible to have the library.properties file in other folders than the repository root one, and only your answer made that definitely clear that wasn't possible to do so.
Sorry if I opened new issues without giving time for your replies. Next time I will make sure they are closed first.
I read all the "must not contain" points, and it isn't stated that I can't place python files inside the library, hoping I'm in the clear in this one.

[per1234]

I was following multiple 3rd party instructions that stated and insisted to me that it was really possible to have the library.properties file in other folders than the repository root one

Would you mind providing a link to those instructions? I would like to try to submit a correction to the author in order to ensure they don't cause problems for other library developers in the future.

it isn't stated that I can't place python files inside the library, hoping I'm in the clear in this one.

That is correct. We do prohibit the presence of .exe files, but Python files are no problem.

It is not a requirement, but if you want to include files that are not directly related to the Arduino library in a library it is best practices to put those files under the extras subfolder of the repository:

https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation

An extras folder can be used by the developer to put documentation or other items to be bundled with the library.

The content of the extras folder is totally ignored by the Arduino development software; you are free to put anything inside.

[ruiseixasm]

I follow the deepseek and chatGPT and both said the same, maybe Copilot would be better. I corrected the folder name extra to extras after realizing the typo BTW.

These were the instructions:

I have a library.properties file inside the folder Arduino/JsonTalkie!

ChatGPT said:
Perfect — that's what Arduino Library Manager needs, as long as you do two things correctly:

✅ Summary Checklist for Your Setup (Arduino/JsonTalkie)
You said:

“I have a library.properties file inside Arduino/JsonTalkie.”

Here’s what you need to do to make that work with Arduino's Library Manager:

✅ 1. Make Sure the Folder Structure is Correct
Your GitHub repo should look like this:

cpp
Copy
Edit
JsonTalkie/
├── Arduino/
│ └── JsonTalkie/
│ ├── library.properties
│ ├── src/
│ │ └── (your .cpp / .h files)
│ └── (optional examples/, README, etc.)
✅ Make sure the src/ folder exists and contains your code.
If your .cpp and .h files are not in a src/ folder, put them there — Arduino requires this.

✅ 2. Tag a GitHub Release
Create a release on GitHub:

Tag: v1.0.0

It must match the version=1.0.0 in your library.properties

📍 Link: https://github.com/ruiseixasm/JsonTalkie/releases

✅ 3. Submit to Arduino Library Registry
Go to:
🔗 https://github.com/arduino/library-registry/issues/new?assignees=&labels=&template=library_submission_request.yml

Fill out:

yaml
Copy
Edit
Repository: https://github.com/ruiseixasm/JsonTalkie
Library folder: Arduino/JsonTalkie
Submit the issue.

✅ 4. What Happens Next
The Arduino bot runs checks.

If it finds any problem (like missing src/, invalid library.properties, etc.), it will leave a comment.

If everything is valid, a human maintainer will approve it, close the issue, and your library will appear in the Arduino IDE Library Manager.

🛠 Common Mistake (Watch Out!)
Arduino requires your actual .cpp and .h code files to be inside a src/ folder — either:

bash
Copy
Edit
Arduino/JsonTalkie/src/
Or:

css
Copy
Edit
Arduino/JsonTalkie/
├── src/
│ └── JsonTalkie.cpp
│ └── JsonTalkie.h
Would you like me to check your GitHub repo for you to confirm it's set up correctly? Just drop me the link.

Also:

But my Library folder is Arduino/JsonTalkie

ChatGPT said:
Thanks for clarifying — that's an important detail.

Since your library is located in the Arduino/JsonTalkie subfolder, you must specify that full path when submitting to the Arduino Library Manager. The Arduino Library Manager does support nested folders, but you need to explicitly tell them where the actual library lives.

✅ Updated Steps for Your Case

1. ✅ Verify Your Folder Structure
   Make sure this is the case:

css
Copy
Edit

├── Arduino
│ └── JsonTalkie
│ ├── library.properties
│ ├── src/
│ └── (your code files)
If so, this is acceptable.

2. ✅ Tag a Release on GitHub
   Go to your repo and create a release matching the version in library.properties.

Tag: v1.0.0

Title: v1.0.0

Description: Initial release

Publish it.

3. ✅ Submit to the Arduino Registry
   Go to:
   🔗 https://github.com/arduino/library-registry/issues/new?assignees=&labels=&template=library_submission_request.yml

And fill in like this:

yaml
Copy
Edit
Repository: https://github.com/ruiseixasm/JsonTalkie
Library folder: Arduino/JsonTalkie
4. ✅ Wait for Review
The Arduino team will run automated checks. If everything is fine (valid library.properties, compilable code, etc.), they will approve it. If not, they will tell you what to fix.

✅ Bonus Tip: Avoid Nesting Too Deeply
Although nested folders are supported, a flatter structure (library at the repo root) makes it easier to work with and less prone to user confusion. In the future, you might consider restructuring like:

css
Copy
Edit
JsonTalkie/
├── library.properties
├── src/
Then move all your Arduino-specific code there and tag from that root. But you're okay for now with Arduino/JsonTalkie.

Let me know if you’d like help writing the GitHub issue body or want me to review your library.properties.

And this too:

✅ Minimal Requirements for Your Library to Be Accepted
You must have:

A valid library.properties inside the library folder (Arduino/JsonTalkie)

A src/ folder containing:

At least one source file (typically .cpp, or .ino for header-only libraries)

Your header files (.h, .hpp)

Optionally, an examples/ folder with sketches (.ino)

[per1234]

Thanks for the clarification. Unfortunately there isn't anything we can do directly to solve this too frequent problem of "hallucinations" by the LLMs. Hopefully correct information such as what was shared through this discussion might eventually improve the training of future models and so cause them to provide more accurate advice.

I corrected the folder name extra to extras after realizing the typo BTW.

Thanks for making the extra effort to pay attention to the best practices recommendations provided by the bot! The incorrect extra folder name won't result in the release of your library being rejected by the Library Manager system, but it is best to faithfully comply with the Arduino Library Specification to avoid any chance of unexpected problems that might otherwise occur in the future.