Skip to content

Conversation

@malarz-supla
Copy link
Contributor

https://github.com/closedcube/ is dead

I found and fix error in this library.
I worked on other fork of library.

https://github.com/closedcube/ is dead

I found and fix error in this library. 
I worked on other fork of library.
@github-actions
Copy link
Contributor

Hi @malarz-supla.
Your pull request has been detected as something other than a Library Manager submission.
A maintainer will need to review it before it can be merged.

If you intended to submit a library, please check the instructions and update your pull request if necessary:
https://github.com/arduino/library-registry/blob/main/README.md#instructions

@github-actions github-actions bot added the topic: modification Change existing list entry label Jan 29, 2025
@github-actions
Copy link
Contributor

Arduino Lint has suggestions for possible improvements to https://github.com/malarz-supla/ClosedCube_SHT31D_Arduino:

Linting library in ClosedCube_SHT31D_Arduino
WARNING: library.properties name ClosedCube SHT31D contains spaces. Although supported, best practices is to not use    
         spaces.                                                                                                        
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP015)                                                                                                   
WARNING: Unable to load the library.properties url field: 404 Not Found                                        
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
         (Rule LP042)                                                                                          

Linter results for project: 0 ERRORS, 2 WARNINGS

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

Linting sketch in ClosedCube_SHT31D_Arduino/examples/periodicmode

Linter results for project: no errors or warnings

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

Linting sketch in ClosedCube_SHT31D_Arduino/examples/reset

Linter results for project: no errors or warnings

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

Linting sketch in ClosedCube_SHT31D_Arduino/examples/singleshotmode

Linter results for project: no errors or warnings

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

Linting sketch in ClosedCube_SHT31D_Arduino/examples/whoiam

Linter results for project: no errors or warnings

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

Linter results for projects: 0 ERRORS, 2 WARNINGS

@github-actions github-actions bot requested a review from per1234 January 29, 2025 21:51
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 @malarz-supla. Thanks for your interest in contributing to the Arduino Library Manager.

We only change the URLs of libraries when the request is received from or by approval of the library maintainer. So I can not accept your request.

However, you are very welcome to submit your fork of the library to the Arduino Library Manager Registry, leaving the closedcube registration intact.

If you want to do that, please note that each library must have a unique name. The library name is defined by the name property in the library's library.properties metadata file. The name configured for the library in your fork is currently "ClosedCube SHT31D":

https://github.com/malarz-supla/ClosedCube_SHT31D_Arduino/blob/1.5.2/library.properties#L1

name=ClosedCube SHT31D

That name is already taken, so you must change it. I'll provide an overview of the procedure:

  1. Change the value of the name property in your library's library.properties file to a unique name.
    You can search the Arduino IDE Library Manager to check whether a prospective name is available.
  2. Bump the value of the version field in the library's library.properties metadata file.
  3. Create a new release or tag in the library repository.
  4. Follow the instructions here to submit the library to the registry:
    https://github.com/arduino/library-registry#adding-a-library-to-library-manager

I'll continue to monitor this pull request thread, so if you have any questions or concerns, just add a comment on the thread and I'll provide further assistance.

Regards, Per

@per1234 per1234 added topic: URL change Change library repository URL and removed topic: modification Change existing list entry labels Jan 29, 2025
@per1234 per1234 self-assigned this Jan 29, 2025
@per1234 per1234 closed this Jan 29, 2025
@per1234 per1234 added the conclusion: invalid Issue/PR not valid label Jan 29, 2025
@malarz-supla
Copy link
Contributor Author

malarz-supla commented Jan 30, 2025

@per1234
I tried adding a "new" library, but I gave up (see #5850). When I change the name in the library.properties file, the bot also asks to change the library files names. This doesn't make sense. The idea is to replace the unavailable (unpatchable) library with the patched version without changing the sketch code.

There is a small bug in the original ClosedCube library that (at least for me) caused compilation errors. Unfortunately, all ClosedCube repositories are removed/hidden (see https://github.com/closedcube/) and I can't add my patch directly to the library.

I wanted to share the solution, but I think the rules adopted in the Arduino project do not allow for an easy way to do it. The patched library is neither "new" nor "mine". It is still the ClosedCube library and I haven't even looked at most of its code.

@per1234
Copy link
Contributor

per1234 commented Jan 30, 2025

Hi @malarz-supla.

I tried adding a "new" library, but I gave up (see #5850).

You should not be so quick to give up on your endeavors. Encountering difficulties in technical projects is a fact of life. If you want to be successful in this field you must accept that and learn techniques for overcoming such difficulties to finally achieve success.

When I change the name in the library.properties file, the bot also asks to change the library files names. This doesn't make sense.

It makes perfect sense:

#5850 (comment)

ERROR: Prohibited character(s) in library.properties name value: ClosedCube SHT31D (fork)                    
       See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
       (Rule LP011)                                                                                          

You set the value of the name property in your library's metadata to ClosedCube SHT31D (fork). Did you visit the URL provided by the bot? If you had done that, then you would have learned that the ( and ) characters you used in your library name are not permitted by the Arduino Library Specification:

Library names must contain only basic letters (A-Z or a-z) and numbers (0-9), spaces ( ), underscores (_), dots (.) and dashes (-).

You must have realized this because you did remove the invalid characters from the library name:

malarz-supla/ClosedCube_SHT31D_Arduino@3c18733

I think the rules adopted in the Arduino project do not allow for an easy way to do it.

This is false. The changes that are needed in order for you to register your fork of the library are absolutely trivial. Someone who is competent enough to work with an SHT3x I2C digital humidity and temperature sensor should have no trouble achieving this with a little bit of perseverance.

The patched library is neither "new" nor "mine".

You are the maintainer of the library fork. You made the decision to submit the library you maintain. You must take responsibility for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conclusion: invalid Issue/PR not valid topic: URL change Change library repository URL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants