Skip to content

A lightweight library based on JSON and Network Sockets for Arduino communication and control based configured by a Manifesto. #6332

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 3 commits into from
May 23, 2025

Conversation

ruiseixasm
Copy link
Contributor

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

@github-actions github-actions bot added the topic: submission Add library to the list label May 23, 2025
Copy link
Contributor

A problem was found with your submission https://github.com/ruiseixasm/JsonTalkie

ERROR: Library is missing a library.properties metadata file.

See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata

Copy link
Contributor

Thanks for your interest in contributing to the Arduino Library Manager index @ruiseixasm
Please resolve the error(s) mentioned in the previous comment.

After resolving the issue, trigger this check again by doing one of the following:

  • Commit the required change to the branch you submitted this pull request from.
  • Comment here, mentioning @ArduinoBot in the comment.

NOTE: It is not necessary to open a new pull request. ❗

More information:
https://github.com/arduino/library-registry/blob/main/README.md#if-the-problem-is-with-the-pull-request

@ruiseixasm
Copy link
Contributor Author

The file requested is inside Arduino/JsonTalkie folder!

@ruiseixasm
Copy link
Contributor Author

I added the folder src/ and placed all .hpp header files in it, also, I updated the correct version in the library.properties file. Please @ArduinoBot, take note that all the library files are under the folder Arduino/JsonTalkie!

Copy link
Contributor

Hello! I'm checking your submission again.

Copy link
Contributor

A problem was found with your submission https://github.com/ruiseixasm/JsonTalkie

ERROR: Library is missing a library.properties metadata file.

See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata

Copy link
Contributor

Thanks for your interest in contributing to the Arduino Library Manager index @ruiseixasm
Please resolve the error(s) mentioned in the previous comment.

After resolving the issue, trigger this check again by doing one of the following:

  • Commit the required change to the branch you submitted this pull request from.
  • Comment here, mentioning @ArduinoBot in the comment.

NOTE: It is not necessary to open a new pull request. ❗

More information:
https://github.com/arduino/library-registry/blob/main/README.md#if-the-problem-is-with-the-pull-request

@per1234 per1234 self-assigned this May 23, 2025
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file requested is inside Arduino/JsonTalkie folder!

Hello @ruiseixasm. You neglected to follow step 1 in the instructions:

  1. You may want to first take a look at the requirements for admission into the Arduino Library Manager index. Each submission will be checked for compliance before being accepted.

If you check the requirements, you will see this:

  • The library.properties file must be located in the root of the repository.

So you must move the Arduino library to the root of the current repository if you want to add it to Arduino Library Manager.

If you want to keep a clear separation between the Arduino library and the Python scripts, you could use a separate repository for each of them, with one library dedicated exclusively to the Arduino library, and another dedicated exclusively to the Python code.

@per1234 per1234 added the status: waiting for information More information must be provided before work can proceed label May 23, 2025
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @ruiseixasm. I see you have fixed the error reported by the bot. However, Library Manager works exclusively from Git tags, so the bot won't be able to see the fix you made until you create a new release or tag in the library repository.

If you look at the repository contents at the latest tag, you can see that the version the bot is checking still has the problem:

https://github.com/ruiseixasm/JsonTalkie/tree/1.1.0

(note that the library is still under the Arduino subfolder of the repository at the tagged point in the revision history)

❗ Remember to update the version field in the library's library.properties file as needed before making a release/tag.

Once you have done that, simply mention @ArduinoBot in a comment here to trigger it to run the automated checks again. After those are passing, your library will be automatically added to Library Manager.

If you have any questions or concerns, please let me know.

Regards, Per

@ruiseixasm
Copy link
Contributor Author

@ArduinoBot

Copy link
Contributor

Hello! I'm checking your submission again.

@github-actions github-actions bot removed the status: waiting for information More information must be provided before work can proceed label May 23, 2025
Copy link
Contributor

Arduino Lint has suggestions for possible improvements to https://github.com/ruiseixasm/JsonTalkie:

Linting library in JsonTalkie
WARNING: Potentially misspelled extras folder name found: JsonTalkie/extra                           
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation
         (Rule LS011)                                                                                
WARNING: Sketch(es) found outside examples and extras folders:                                    
           JsonTalkie/extra/Dummy                                                                 
           JsonTalkie/extra/ESP32                                                                 
           JsonTalkie/extra/ESP8266                                                               
           JsonTalkie/extra/EtherCard                                                             
           JsonTalkie/extra/Ethernet                                                              
           JsonTalkie/extra/UIP                                                                   
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples
         (Rule LD003)                                                                             

Linter results for project: 0 ERRORS, 2 WARNINGS

-------------------

Linting sketch in JsonTalkie/examples/ESP32

Linter results for project: no errors or warnings

-------------------

Linting sketch in JsonTalkie/examples/ESP8266

Linter results for project: no errors or warnings

-------------------

Linting sketch in JsonTalkie/examples/Generic_Ethernet

Linter results for project: no errors or warnings

-------------------

Linting sketch in JsonTalkie/examples/Mega_UIP

Linter results for project: no errors or warnings

-------------------

Linting sketch in JsonTalkie/examples/Nano_EtherCard

Linter results for project: no errors or warnings

-------------------

Linter results for projects: 0 ERRORS, 2 WARNINGS

@github-actions github-actions bot merged commit 41a7e87 into arduino:main May 23, 2025
14 checks passed
Copy link
Contributor

Your submission has now been accepted! Thanks for your contribution to the Arduino Library Manager index.

The library(s) will be available for installation via Library Manager within a day's time.

You can check the logs from the Library Manager indexer for your library(s) here:
http://downloads.arduino.cc/libraries/logs/github.com/ruiseixasm/JsonTalkie/

github-actions bot pushed a commit that referenced this pull request May 23, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
topic: submission Add library to the list
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants