0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

PlatformIO にライブラリを登録する

0
Last updated at Posted at 2024-08-12

はじめに

Arduino で開発をするとき、まず最初に自作のタスク風ライブラリやボタンライブラリをプロジェクトにコピーするのですが、この「手作業」をやめてライブラリからインストールできないかな、と思い、調べてみました。

image.png

登録作業

結論から言うと登録作業は割と簡単で、むしろ審査もなしで登録即反映されたのには驚きました。

基本的にはこちらの記事にある通りなので省略しますが、ここや公式サイトに載っていなかった部分を補足したいと思います。

  • ログイン&公開
    ログインはGitHubアカウントではなくPlatformIOアカウントです。特に2回目以降は勘違いしがちなので注意。
> pio account login
  :
> cd .. #ライブラリのフォルダ内にいる場合は階層を移動
> pio package <folder name>
> pio package publish $PWD/<folder name>

 

  • 複数キーワードの登録
    キーワードは
    "keywords": "button,doubleclick,release,hold,chattering,debounce",
    のように、カンマ区切りで並べてダブルクオーテーションで囲めばOKです。
     
  • ChangeLogの追加
    library.jsonにはChangelogを記入する場所がなかったのですが、これはGitHub側でReleasesを作成することによりChangelogに反映されるようです。

Releaseの作成

PlatformIOライブラリへの登録だけであれば不要ですが、Changelogに反映されるようにReleaseを作ってみます。
image.png

  • PlatformIOに登録したコミットにタグをつける
    先ほど登録したGitHubリポジトリの該当コミットにタグをつけます。
    image.png

  • Create a new releaseをクリック
    先ほど登録したGitHubリポジトリの右側にあるReleasedをクリック

  • Draft a new releaseをクリック
    image.png
    +先ほど追加したtagをクリック
    image.png

  • リリースタイトルやリリースノートを記入

  • 先ほど作成した .tar.gzをドラッグ&ドロップ
    image.png

  • Publish release ボタンを押して登録

  • リリースが最新に置き換わる
    image.png

確認

変更からしばらくすると、PlatformIOのChangelogに先ほど作成したReleaseの内容が反映されています。
image.png

以上、おつかれさまでした。

付録

参考記事:PlatformIO のライブラリを登録してみた

今回登録したライブラリ
OpenButton:複数ボタンのRelease/DoubleClick/Hold 等を取得可能
OpenTSS:タスクを用いずタスクライクな時分割処理が可能

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?