Library Manager FAQ

per1234 edited this page Jul 26, 2018 · 25 revisions

Library Manager overview

The Arduino Library Manager is a feature of the Arduino IDE (Sketch > Include Library > Manage Libraries...) which makes it easy for users to find, install, and update both official and 3rd party libraries. When your library is added to the library list every release/tag version of the library in your repository will automatically be made available for installation via Library Manager. The users can set their preferences to display an update notification when a new version of any installed library on the list is available and easily update to the new version with just a couple clicks. More information:
https://www.arduino.cc/en/Guide/Libraries#toc3

How is the library list generated?

From a list of public Git repos, a job (a small program that runs regularly) fetches every tag, verifies library files and pushes the updated list onto the Arduino download server. Only valid libraries and their tags are published. A library is not valid when:

  • it's not in 1.5 format and in particular it misses a library.properties file (1.5 format folder layout is not required)
  • its version number is not semver compliant
  • it contains .exe files
  • it contains a .development file
  • it contains symlinks
  • our antivirus finds infected files

The job runs every hour. If a new library has been released, you can expect it to be listed within the hour.

How can I add my library to Library Manager?

  • Your library repository must be hosted on a major git-hosting website like GitHub, BitBucket or GitLab (other hosting site may be considered on request).
  • Ensure your library is compliant with 1.5 format (1.5 format folder layout is not required)
  • Your library must not have the same library.properties name value as another library previously added to the Library Manager index.
  • Tag it and push the tag (or create a release if you web hosting offers a way to do it, for example with GitHub "releases")
  • Open an issue on Arduino's GitHub, specifying the URL of the repository from where to download your library. If you have multiple libraries to submit you are welcome to do them all in a single issue.
  • After some days, a member of the Arduino team will add your library to the Library Manager index and close the issue. Shortly after that your library will be available for installation via Library Manager.

How can I publish a new release once my library is in the list?

Ensure you've changed version in your library.properties. Then tag your library once more and push the new tag (or create a release if your web hosting offers a way to do it, for example with GitHub "releases"). Our indexer checks for new releases every hour and will eventually fetch and publish your new release.

Sorry, I did something wrong! How can I change or unpublish an already published library?

In order to change contents of an already published library version, you can recreate its related tag.

In order to unpublish a library version, delete its related tag/release.

Modified or Deleted library versions are processed every Sunday.

How can I change my library's name?

For the sake of continuity, libraries in the Library Manager list are locked in to the name they had at the time they were added to the list. If you wish to change the name it will need to be done manually by request:

  1. Change the name value in your library.properties file and update the version.
  2. Create a release or tag that matches the updated version value in library.properties.
  3. Submit an issue report requesting the name be changed and the URL of your library's repository.

How can I delete a library?

Open your sketchbook "libraries" folder with your OS file explorer (Windows: Explorer, Mac: Finder, Linux: Nautilus, kfiles...) and delete the folder containing your library.

Rationale

No, we don't have a delete button. Libraries managed by the Library Manager are mixed with those you've manually installed, maybe libraries you've written: making a mistake and deleting the wrong library is too easy. That's why trash bins exist. Since the IDE has no knowledge of your trash bin, we didn't implement a "delete" button.

Limitations

Is my Git repo OK?

Your repo is OK if its root folder contains the file library.properties and the rest of the library source code. If your library is stored in a subfolder, your repo is not OK and we can't include your library in the list.

Are Git submodules supported?

No. The library archive distributed by Library Manager will only contain an empty folder where the submodule should be.

Can I add my own URL with my own library list?

No. At the moment, the IDE handles one URL only, and that's written into the code (dev jargon: it's hardcoded), this is a known limitation. However, if you know your way through the code, you can change that URL with another one.

When I install a library that I know depends on another library, will this other library be installed as well?

No, at the moment library dependencies are ignored. Current Library Manager aims at simplifying your life when dealing with installing a single library. If a library depends on another one, you'll have to install both.

Can I install multiple versions of one library and use the proper one in my sketches?

Library Manager installs libraries into your sketchbook "libraries" folder. Since you cannot create two folders with the same name, we can't install two versions of the same library. However, you can switch between library versions, by selecting the appropriate one from the version dropdown that pops up on Library Manager when more than one version is available.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.