MX8650 library for Arduino and ESP

[styropyr0]

This library facilitates communication with the MX8650 mouse controller, allowing for reading and writing data to its internal registers. It is essential to refer to the MX8650 datasheet before transferring data to the sensor registers.

Author: Saurav Sajeev

[github-actions]

A problem was found with your submission https://github.com/styropyr0/MX8650

❌ ERROR: The repository has no tags. You need to create a release or tag that matches the version value in the library's library.properties file.

[github-actions]

Thanks for your interest in contributing to the Arduino Library Manager index @styropyr0
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

[styropyr0]

@ArduinoBot

[github-actions]

Hello! I'm checking your submission again.

[github-actions]

A problem was found with your submission https://github.com/styropyr0/MX8650

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

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

[github-actions]

Thanks for your interest in contributing to the Arduino Library Manager index @styropyr0
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

[styropyr0]

@ArduinoBot

[github-actions]

Hello! I'm checking your submission again.

[github-actions]

A problem was found with your submission https://github.com/styropyr0/MX8650

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

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

[github-actions]

Thanks for your interest in contributing to the Arduino Library Manager index @styropyr0
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

[styropyr0]

@ArduinoBot

[github-actions]

Hello! I'm checking your submission again.

[github-actions]

Arduino Lint has suggestions for possible improvements to https://github.com/styropyr0/MX8650:

Linting library in MX8650
INFO: No header file found matching library name (MX8650_Mouse_sensor_library.h). Best practices are for primary header 
      filename to match library name.                                                                                   
      See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format            
      (Rule LS008)                                                                                                      
WARNING: library.properties name value MX8650 Mouse sensor library is longer than the recommended length of 16          
         characters.                                                                                                    
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP010)                                                                                                   
WARNING: library.properties name MX8650 Mouse sensor library 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: Library name MX8650 Mouse sensor library contains "library". This is superfluous.                     
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
         (Rule LP016)                                                                                          
WARNING: Invalid category field value Mouse/Mouse Controller in library.properties                             
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
         (Rule LP038)                                                                                          
WARNING: Missing architectures field in library.properties                                                     
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
         (Rule LP043)                                                                                          
WARNING: No license file found.                                                                                                                 
         See:                                                                                                                                   
         https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository
         (Rule LD002)                                                                                                                           
WARNING: No example sketches found. Please provide examples.                                      
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples
         (Rule LD004)                                                                             

Linter results for project: 0 ERRORS, 7 WARNINGS

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

[github-actions]

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/styropyr0/MX8650/

[styropyr0]

@ArduinoBot

[per1234]

Hello @styropyr0. The automated system here only operates on open pull requests. Since your submission was already accepted and the pull request merged, the bot won't pay any more attention to this pull request.

But this human is happy to provide assistance. Was there something you needed from the bot?

[styropyr0]

Hello @per1234 ,
Thank you for the response. This was my first time publishing libraries to Arduino. I think I have made mistakes somewhere. It is showing me an error that for both the libraries I have published, the header files are not found. Think I didn't provide the header file's name as the commit message or something? You could help me by removing those two libraries which I have added and give me some suggestions if I have missed anything. I will just read and understand all the steps clearly, and publish it again.

[per1234]

It is showing me an error that for both the libraries I have published, the header files are not found.

Are you referring to this part of the bot's comment?:

INFO: No header file found matching library name (MX8650_Mouse_sensor_library.h). Best practices are for primary header 
      filename to match library name.                                                                                   
      See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format            
      (Rule LS008) 

If so, this is not an error. It is only telling you that your library does not follow the best practices of the primary header filename matching the sanitized library name.

The library name is defined by the name property in the library's library.properties metadata file:

https://github.com/styropyr0/MX8650/blob/main/library.properties#L1

name=MX8650 Mouse sensor library

Best practices would be for the library to have a primary header file matching the library name, with spaces replaced by underscores: MX8650_Mouse_sensor_library.h.

The reason this is considered a best practice is because in the case where multiple libraries contain a header file matching an #include directive in the sketch program, the Arduino sketch build system uses the match between the header filename and the library name as a factor in determining which of the libraries is the best choice:

https://arduino.github.io/arduino-cli/latest/sketch-build-process/#library-name-priority

So if you like, you can add a header file to the library named MX8650_Mouse_sensor_library.h. You can do this in a non-breaking manner by leaving the existing header file in the library and simply adding an `#include directive for the other header in the otherwise empty header file:

#include "mx8650.h"

But please note that this is not an error. It is only a suggestion the bot is making in order to encourage library authors to follow best practices. If you decide that you don't want to follow the suggestion, there are no consequences. Your library has already been accepted for inclusion in the Arduino Library Manager and it will remain in Library Manager regardless.

You could help me by removing those two libraries which I have added

It is not necessary. If you want to make improvements to the library, that is completely fine. Just make a new release of the library when you are ready and it will be automatically picked up by the Library Manager system:

https://github.com/arduino/library-registry/blob/main/FAQ.md#how-can-i-publish-a-new-release-once-my-library-is-in-the-list