2022年1月29日オンラインにて。ROSパッケージを作って公開する話。

1. 自己位置推定
ROSパッケージの作り方
千葉工業大学 上田隆一
2022年1月29日
日本ロボット学会第139回ロボット工学セミナー

2. 本日の話
• 自作の自己位置推定ROSパッケージemclの話
• ROSのパッケージを使う側から作る側にまわるときの話
• 「〇〇を作った××さん」を目指す
• 自己位置推定の仕組みの話・・・は入りきりませんでした・・・
• 赤井先生に期待
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 2

3. ryuichiueda/emcl
• amclの互換（のつもりで作成した）
パッケージ
• amcl
• 移動ロボットの自己位置推定の
ための事実上の標準パッケージ
• Monte Carlo localizationの実装
• 他にランダムリセットやKLDサンプリング
という補助的なアルゴリズム
• CとC++の混在
コードの読解が難しいので簡単なパッケージを
公開して読んでもらう/使ってもらう⇒emcl
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 3

4. emclを使用している様子
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 4
https://youtu.be/mGkNZUbasXo https://youtu.be/O9d1z0c-HyE

5. ROSパッケージを作る
• コードを書く以外にも様々なことが必要
• パッケージの初期化（その他ROSまわりの設定）
• package.xmlの編集とライセンスファイルの準備
• テスト環境の整備
• 以下繰り返し
• コード書く、GitHub等へのpush、READMEを書く
• ROS Wikiで紹介（すみませんやってません！）
• デモを作る
• 宣伝
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 5
自己位置推定の話を聞きたい人が多いのは重々承知ですが
こっちの方が重要かもしれないので主にこちらの話です。

6. ROSのパッケージの作成
• catkinを使っている場合
• catkin_create_pkg hoge_pkg rospy roscpp
• 赤: コマンド
• 緑: 作成するパッケージの名前
• 青: 依存するパッケージの名前
• できたディレクトリに入ってみましょう
$ ls
CMakeLists.txt include package.xml src
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 6
パッケージ単位で
ものごとを考える
注目！

7. package.xmlの編集
• 「パッケージマニフェスト」というもの
• パッケージのあらましを書く
• 名前
• バージョン
• メンテナー（管理している人）
• 必須
• ライセンス
• 作者
• オプション
• 依存するパッケージ
• 書かないと動かないことも
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 7
面倒くさがらずに書く

8. ライセンスの選定
• ライセンス: 利用許諾
• 公開しているパッケージを「利用」してもらうときに、著作者が発行
• 利用: コードやバイナリを製品や他のリポジトリに加える行為
• 人の作ったものの一部を「自分のもの」の一部として提供すること
• 個人的にダウンロードして使うのは「使用」なので「利用」ではない
• ライセンス
• 自分で考えてもよいが、無償のソフトウェアには標準的なものが存在
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 8
戦略的に選定しましょう

9. ライセンスの種類（ざっくりと）
• GNU General Public License（GPL）
• 自分の公開したコードが再利用されたときは、
再利用したコードも公開されてほしい
• GPLのコードを利用したリポジトリを公開したい
• emclはamclのコードを少し使用しているのでこれに該当
（ただし少し条件の異なるLGPL）
• BSDライセンス、MITライセンス
• 自分の公開したコードが再利用されてもコードが隠れて構わない
• いくつか条件があるから守ってほしい
※ROS本体はBSDライセンス
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 9

10. ライセンスの種類（続き）
• Apache License
• 特許も利用してもらいたい
• 企業独自のライセンス
• 他者（他社）による利用を防ぐためのものが多い
• その他重要なこと
• 免責事項がある（利用者から瑕疵を追求されないように）
• 新規利用者ごとに別のライセンスを発行して構わない（著作者の権利）
• 2つ以上のライセンスから利用者に選んでもらうことも可能
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 10

11. 著作権
• ライセンスとは別物
• オリジナルなものを作った人に権利が残る
• そうしないと利用者が「俺のものだ」と宣言可能に
• ライセンスは利用に対するもの
• 既存のものに追加するときは著作者の表記も追加
• 考え方は論文の著者、共著者にほぼ同じ
• 記述した人、記述寸前の具体的なアイデアを提示した人が並ぶ
• ただし企業名になることも
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 11

12. ライセンス、著作権表示の具体例
• 基本
• リポジトリのトップにLICENSE
（or COPYING）というファイルを設置（例: 右図）
• プログラムのファイルの先頭に
著作権とライセンスの表示
• SPDXを使うと便利
• SPDX（The Software Package Data Exchange）
• ファイルの先頭に著作権やライセンスを
表示するためのフォーマット（例: 下図）
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 12
←コレ

13. コードの公開
• ライセンスを決めたらとりあえずコードを公開
• 公開の場はGitHubだけではないが、GitHubが一般的
• 「できてから公開」ではない
• こまめにアップロード（push）
• 少しコードを変えてコンパイルに通ったらpushしたほうがいい
• さらに望ましいのは、テストに通ったら
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 13

14. ソフトウェアのテスト
• ここでは最も基本的な回帰テスト（リグレッションテスト）について
説明
• 回帰テスト: 様々な入力、パラメータに対して適切な出力のリストを作
って、コードがその通りに出力するかを確認
• なぜ回帰テストをするか: あるコードの追加、変更で、思わぬところで
バグが出ることがあるので、それがないかを確認
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 14
入力 引数（正規表現） 出力
a a* a
a a{2} （何も出ない）
abc bc abc
例: grepのテスト テストスクリプト

15. ROSでのソフトウェアテスト
• ロボットのテストはハードが絡んで厄介だが
ROSには様々な準備がある
• rostest
• 使用例: https://github.com/ryuichiueda/pimouse_ros
• Raspberry Piで学ぶROSロボット入門のコード
• rosbag
• センサやロボットの出力を記録
• rostestと組み合わせた使用例（実演）
• ロボットの挙動
• もちろん自前で用意してもよい
• Unix系OSの終了ステータスの理解があれば自作可能
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 15

16. emclのテスト（実演）
• ./test/test_gui.bashに記述
• 何をしているか
• 1. リセットのテスト
• パーティクルの位置を動かしてロボットの位置に戻ってくるか確認
• 2. ナビゲーションのテスト
• emclでロボットが目標まで移動できるかどうか
• トピックの出力で確認
• rostestは使っていない（使ったほうがいいかもしれない）
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 16

17. テストの自動化
• テストを作ってもやらないことがある
• 忘れていて/慌てていて/大丈夫だろうと思ってやらないことも
• GitHubにpushしたらテストを自動で実行
• これで忘れない
• テスト結果を表示することでコードを使う側も安心（or 警戒）
• 以前: 外部のサービスを利用（Travis CI、CircleCI）
• 現在: 外部サービスに加えてGitHubにも機能（GitHub Actions）
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 17
※これらのサービス、ツールはテスト以外にもいろいろ利用可能

18. emclでのGitHub Actionsの設定
• .github/workflows/test.ymlに記述
• 内容（抜粋）
• Ubuntu 18.04を使用
• Dockerで最新の
コミットのコンテナ作成
• コンテナ内でtest/test.bashを
走らせてテスト
• test.ymlを書いておくと、
pushのたびにテストが走る
• 実演
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 18

19. READMEをまじめに書く
• 内容
• なにをするためのものか、デモ、入出力、機能、他に必要なパッケー
ジ、ライセンス、著作権・・・
• 一部はpackage.xmlで代用
• ROSの慣例に従っているものも省略可能（ROSのメリット）
• ROSでは入出力（+パラメータ）が重要
• 中身はブラックボックスなので、そこに何を入れて何を出すかが
ノードのアイデンティティー
• 「入出力をREADMEに→テストを記述→開発」が理想
• 使う人が矛盾を感じないように
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 19

20. ROS wiki
• 自身のパッケージが人に使ってもらえそうな場合、
READMEの他に、ROS wikiにパッケージの情報を記載
• emclはまだです。すみません。
• emclではない例: http://wiki.ros.org/ja/raspicat
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 20

21. デモ作成、宣伝
• 必勝パターンがないが、やっておくとよいこと
• 1人でもいいので使ってもらう
• とにかく動画を撮る
• 反応が薄くても気にしない
• どこでもいいからドキュメントを書いて公開
• 新規性が主張できるなら学会へ
• 学会となじまない内容なら同人誌を書いて売るのが一番良い
• 技術書典など（別に二次元が好きでなくても大丈夫です。）
• どこかのコミュニティーに入る（or 自分で作る）
• 世界的に見える人たちも、結局同じ大学の同窓会だったりする
• オープンソース界隈の行動原理を理解する
• シェル芸勉強会どうでしょう？
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 21

22. もしパッケージを使ってもらえるように
なったら
• すぐには「おいしい思い」はできない
• 自分の名前で仕事をしたスタートラインくらい
• 今後一生にわたって少しずついいことがある
• 転職、登壇、執筆、思い出など
• 早まって変なことをしない
（オンラインサロンを開くとかテンションの高いブログを書くとか）
• 無償で活動する意義を自分なりに整理しておく
• Faker.js事件、Log4j事件
• ひどい問い合わせが来るけどキレない
• 丁寧に好ましい方向に誘導
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 22

23. まとめ
• ROSパッケージを作って使ってもらうまでの話
• 自分の名前で仕事を
• 個人が強くないと企業も甘えてしまって社会が良くならない
• 単にコードを書くだけのシンプルな時代が終わっている
（個人的には悲しい）
• 特にテストが重要
• 「ロボットだから・・・」と言い訳しない（自戒）
• 自己位置推定の話は赤井先生に期待（ごめんなさい）
2022年1月29日 日本ロボット学会第139回ロボット工学セミナー 23