Arduino library の作り方 2020

1. ARDUINO LIBRARY
の作り方 2020
常田 裕士

2. Arduino Library
2020/8/26
◦ Arduinoの便利機能いろいろ。
◦ ユーザーからのContributeで現在
3198ライブラリが登録済み。
◦ https://www.arduinolibrari
es.info/ を見るとり色々ある。
◦ Arduinoのライブラリマネージャから
インストールは簡単にできるように
なっている。

3. 自作ライブラリを作る。
◦ ライブラリの中身はC/C++のソース。
◦ コンパイルできれば何でもライブラリにできる。
◦ ~Documents/Arduino/librariesの下に
フォルダを作る。
◦ 中にsrcとexamplesのディレクトリを作る。
◦ library.propertiesのファイルを作る。
◦ srcの中に適当なソースを作って入れる。
◦ 関数1個でも構わない。
◦ ヘッダファイルは作る必要あり。
◦ examplesはサンプルプログラムを入れておく
◦ これもArduinoのキモの一つ。手抜きしない。
2020/8/26

4. library.properties
◦ ライブラリの概要が書いてあるテキストファイル。
◦ これをもとにライブラリマネージャがインストールしてくれる。
◦ 仕様は https://arduino.github.io/arduino-cli/library-specification/
◦ 必要な作業は実質これだけ。
2020/8/26

5. 実例
name=TinyCBOR
version=0.0.1
author=TOKITA Hiroshi, TinyCBOR Contributors
maintainer=TOKITA Hiroshi <tokita.hiroshi@gmail.com>
sentence=Concise Binary Object Representation (CBOR) Library
paragraph=This is a TinyCBOR library and API for arduino. TinyCBOR is industrial strength C/C++
implementation of CBOR by Intel.
category=Other
url=https://github.com/soburi/tinycbor
architectures=*
includes=tinycbor.h
2020/8/26
nameはライブラリ名 Arduino Libraryとしてユニークな名前を付ける
urlは提供元のURLを。githubにしておくと楽
includesで必要なインクルードファイルを指定できる
利用可能なCPU種別をarchitecturesで指定
categoryはライブラリマネージャで決めてるものから選択
Versionはsemantics versionのルールに従うこと v[XX.YY.ZZ]の形式

6. Githubに登録する
◦ ライブラリマネージャで配布するにはGitHubへのリポジトリ登録が必要
◦ Library.propertiesのversionに設定したバージョンに対応するタグをpushする。
◦ タグはversionに書いたバージョンの頭に’v’をつける。
◦ version=0.0.1であれば v0.0.1 のタグを作ってpushする。
◦ タグを作ると、Releaseのところからリポジトリを固めたzipファイルが
ダウンロードできるようになる。こうなればOK.
2020/8/26

7. Issueを切る
◦ 作ったライブラリを登録するために、Arduinoのプロジェクトに
Issueを登録する。
◦ https://github.com/arduino/Arduino/issues/new
◦ 人が書いたのをマネして書く。
◦ Githubへのリンクが必須。
◦ ちゃんとタグ付いてReleaseがあるか、再確認。
◦ しばらくするとIssueが処理されて、不備があればコメント、
問題なければ登録された旨が通知される。
◦ これで登録完了。
◦ 実例 https://github.com/arduino/Arduino/issues/10622
2020/8/26

8. 登録完了
◦👍
2020/8/26

9. やりたかったこと
2020/8/26
OpenThread
IoTivity
TinyCBOR 登録完了
次はこれを登録
本丸

10. おまけ KiCadのライブラリに部品データを登録する。
◦ KiCadのライブラリーは
◦ kicad-symbols(回路図記号)
◦ kicad-footprints(部品データ)
◦ kicad-packages3d(3Dモデル)
◦ kicad-packages3D-source(3Dモデル CADデータ)
◦ に分かれてるので、部品データの作りによっては4つのリポジトリにPull Requestをださなければならない。
2020/8/26

11. ◦ https://github.com/KiCad/kicad-symbols/pull/2910
◦ https://github.com/KiCad/kicad-footprints/pull/2390
◦ https://github.com/KiCad/kicad-packages3D/pull/718
◦ https://github.com/KiCad/kicad-packages3D-source/pull/288
2020/8/26