DroidKaigi 2018 Room 2 － 2018/02/08 16:50-17:20 発表スライドです

1. USB接続する
アプリを開発した時に
試行錯誤したこと
SmartDrive
Masataka Kono
2018-2-8
DroidKaigi 2018

2. 自己紹介
● Android Engineer
● 株式会社スマートドライブ
● Twitter @mapyo
● GitHub @mapyo
● (Server Side Engineer)

5. We’ re Hiring!
https://www.wantedly.com/companies/smartdrive/projects

6. 質問です

7. USB接続するアプリを
作った事がある方
質問です

8. USB接続するアプリを
これから作る予定がある方
質問です

9. 今日お伝えしたいこと
● これから作る予定のある方
○ 基礎知識
○ 雰囲気
● これから作る予定もない方
○ 雑学として

10. 今日お話すること
● どんなアプリを作ったか？
● USB接続の基礎知識
● アプリ開発した時の事

11. どんなアプリを
作ったか？

13. どんなアプリを作ったか？
● 車のシガーソケットにつけるハードウェア
● センサーが内蔵されている

14. どんなアプリを作ったか？
● ハードウェアのセンサの情報をBLE経由で
スマホにアップ
● スマホ経由でサーバにアップ
サーバ
BLE

15. どんなアプリを作ったか？
● ハードウェアのセンサの情報をBLE経由で
スマホで取得
● スマホ経由でサーバにアップ
サーバ
BLE
USBでも出来るようにし
たい！！

16. USB接続の
基礎知識

17. USB接続の基礎知識
● Accessory modeとHost
mode
● 基本的な使い方
● permission

18. Accessory modeとHost mode
● Accessory mode
○ USB機器からAndroid端末
が電力をもらう
● Host mode
○ USB機器にAndroid端末が
電力を供給する

19. 出典: https://developer.android.com/guide/topics/connectivity/usb/index.html

20. 出典: https://developer.android.com/guide/topics/connectivity/usb/index.html

21. 出典: https://developer.android.com/guide/topics/connectivity/usb/index.html

22. 出典: https://developer.android.com/guide/topics/connectivity/usb/index.html
Accessory modeでやりとりする
アプリを作ったので、こちらにつ
いて説明していきます。
使うAPIも違います。

23. 注意
スマホの機種自体で
Accessory modeをサポートしている
必要があります
※とはいえ、検証した範囲の端末で
はサポートされてない端末はなかっ
た。(Android 5.0以上）

24. Accessory Modeと接続するハード
ウェアの仕様
● Android Open Acessory（AOA）
protocolをサポートする必要あり
● Android Open Accessory
Development Kit（ADK）がAOAの
リファレンス実装
○ Arduinoなどでも動作可能

25. USB接続の基礎知識
● Accessory modeとHost
mode
● 基本的な使い方
● permission

26. USB接続の基礎知識
※ここからはソースコード多め
です。
事前にスライドをアップしてます
ので、そちらも合わせてご確認
下さい。

27. 基本的な使い方
1. USB接続を検知する
2. データのやりとりをする
3. USBの切断を検知する
この流れを実現するサンプルで
説明します

28. USB接続を検知する
● AndroidManifestに追加
● usb-accessoryを書いたxml
を追加

29. AndroidManifestに追加
<activity ...>
<intent-filter>
<action
android:name="android.hardware.usb.action.USB_ACCESS
ORY_ATTACHED" />
</intent-filter>
<meta-data
android:name="android.hardware.usb.action.USB_ACCESS
ORY_ATTACHED"
android:resource="@xml/accessory_filter" />
</activity>

30. AndroidManifestに追加
<activity ...>
<intent-filter>
<action
android:name="android.hardware.usb.action.USB_ACCESS
ORY_ATTACHED" />
</intent-filter>
<meta-data
android:name="android.hardware.usb.action.USB_ACCESS
ORY_ATTACHED"
android:resource="@xml/accessory_filter" />
</activity>

31. AndroidManifestに追加
<activity ...>
<intent-filter>
<action
android:name="android.hardware.usb.action.USB_ACCESS
ORY_ATTACHED" />
</intent-filter>
<meta-data
android:name="android.hardware.usb.action.USB_ACCESS
ORY_ATTACHED"
android:resource="@xml/accessory_filter" />
</activity>

32. AndroidManifestに追加
<activity ...>
<intent-filter>
<action
android:name="android.hardware.usb.action.USB_ACCESS
ORY_ATTACHED" />
</intent-filter>
<meta-data
android:name="android.hardware.usb.action.USB_ACCESS
ORY_ATTACHED"
android:resource="@xml/accessory_filter" />
</activity>
Activityでないと検知出来ない！

33. accessory_filter
<resources>
<usb-accessory
manufacturer="Sample, Inc."
model="DemoKit"
version="1.0"
/>
</resources>
※HW側の設定と一致させる必
要があります。

34. accessory_filter
<resources>
<usb-accessory
manufacturer="Sample, Inc."
model="DemoKit"
version="1.0"
/>
</resources>
manufacturerの指定だけでも
OK！
自社製のデバイスであれば起動
させるというイメージ

35. 設定がうまく行っていると、
USB接続すると次のダイアログが開きます

36. USB接続された時

37. USB接続された時
AndroidManifestで指定した
Activityが起動

38. USB接続された時
ダイアログが出ずにActivityが起
動します

39. USB接続された時
何も起きません。。。

40. 設定がうまくいっていない
もしくは
対応するアプリがインストールされていない
状態でUSB接続した時は次のダイアログが開きま
す

41. 対応したアプリがない時

42. 対応したアプリがない時
HW側で設定可能

43. 対応したアプリがない時
指定したURLが開きます。
アプリの説明のリンクに飛ばす
のが良いでしょう。

44. 基本的な使い方
1. USB接続を検知する
2. データのやりとりをする
3. USBの切断を検知する
この流れを実現するサンプルで
説明します

45. データのやりとりをする 準備
val usbAccessory: UsbAccessory? =
intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY
)
val usbManager =
getSystemService(Context.USB_SERVICE) as UsbManager

46. データのやりとりをする 準備
val usbAccessory: UsbAccessory? =
intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY
)
val usbManager =
getSystemService(Context.USB_SERVICE) as UsbManager
val parcelFileDescriptor =
usbManager.openAccessory(usbAccessory)
val fileDescriptor =
parcelFileDescriptor.fileDescriptor

47. データのやりとりをする 準備
val usbAccessory: UsbAccessory? =
intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY
)
val usbManager =
getSystemService(Context.USB_SERVICE) as UsbManager
val parcelFileDescriptor =
usbManager.openAccessory(usbAccessory)
val fileDescriptor =
parcelFileDescriptor.fileDescriptor
val usbInputStream = FileInputStream(fileDescriptor)
val usbOutputStream =
FileOutputStream(fileDescriptor)

48. データのやりとりをする 送受信
// 文字列を送信する時
val message = "ほげほげ"
val data = message.toByteArray(charset("UTF-8"))
usbOutputStream.write(data)
usbOutputStream.flush()

49. データのやりとりをする 送受信
// 文字列を送信する時
val message = "ほげほげ"
val data = message.toByteArray(charset("UTF-8"))
usbOutputStream.write(data)
usbOutputStream.flush()
// 文字列を受信する時
val byteArray = ByteArray(1024)
usbInputStream.read(byteArray)
val receiveMessage = String(byteArray, 0,
byteArray.size, charset("UTF-8"))

50. ポイント
● ファイルの読み込み／書き込
みのような形でデータの送受
信が可能
● 非同期処理で書く必要あり
● 送信と受信の口が別々

51. 切断を検知する
// BroadcastReceiverで
// UsbManager.ACTION_USB_ACCESSORY_DETACHED
// を受け取る
parcelFileDescriptor.close()

52. USB接続の基礎知識
● Accessory modeとHost
mode
● 基本的な使い方
● permission

53. permission
● USB接続された時のダイアログ
でOKすればpermissionは付与
済
● 接続中のUSB一覧を取得して、
接続する時にpermission要求
が必要。

54. permission
● permissionがないまま接続する
と例外を吐く
● 一般的なAndroidのpermission
と違います

55. permission
1. 接続されているUSBアクセサ
リを取得
2. permissionを要求する
3. permissionの許可を受け取
る
この流れを実現するサンプル

56. 接続されているUSBアクセサリを取得
val usbManager =
getSystemService(Context.USB_SERVICE) as UsbManager
val usbAccessory =
usbManager.accessoryList?.firstOrNull()
if (usbAccessory == null) {
// USBがささっていない
} else {
// USBがささっている
}

57. 接続されているUSBアクセサリを取得
val usbManager =
getSystemService(Context.USB_SERVICE) as UsbManager
val usbAccessory =
usbManager.accessoryList?.firstOrNull()
if (usbAccessory == null) {
// USBがささっていない
} else {
// USBがささっている
}
一見複数接続に対応しているよ
うだが、サポートされるのは、１
度に１接続だけですとドキュメン
トに書いてあった

58. val usbManager =
getSystemService(Context.USB_SERVICE) as UsbManager
val usbAccessory =
usbManager.accessoryList?.firstOrNull()
if (usbAccessory == null) {
// USBがささっていない
} else {
// USBがささっている
}
接続されているUSBアクセサリを取得
permissionが付与されているか
確認し、なければpermission要
求します

59. permissionの確認
if (usbManager.hasPermission(usbAccessory)) {
// データのやり取りをする
} else {
// permissionの要求をする
}

60. permissionの要求
val ACTION_USB_PERMISSION =
"com.android.example.USB_PERMISSION"
val permissionIntent =
PendingIntent.getBroadcast(this, 0,
Intent(ACTION_USB_PERMISSION), 0)
usbManager.requestPermission(usbAccessory,
permissionIntent)

61. permissionの要求
val ACTION_USB_PERMISSION =
"com.android.example.USB_PERMISSION"
val permissionIntent =
PendingIntent.getBroadcast(this, 0,
Intent(ACTION_USB_PERMISSION), 0)
usbManager.requestPermission(usbAccessory,
permissionIntent)
結果を受け取る時に
つかいます

62. permissionの要求をすると
こんなダイアログが出ます

63. permission要求後のダイアログ

64. permission要求後のダイアログ
最初に説明した、
USB接続した時の
ダイアログとけっこうにてます

65. 接続した時
permission
要求した時

66. 接続した時
permission
要求した時

67. permission要求後のダイアログ

68. permission要求後のダイアログ
許可した状態で
ブロードキャストが飛びます

69. permission要求後のダイアログ
拒否した状態で
ブロードキャストが飛びます

70. permission要求後のダイアログ
permission要求だけじゃなくて
ATTACHEDイベントの時も自動
的にActivityが起動するようにな
ります

71. permission要求結果を受け取る
val usbReceiver = object : BroadcastReceiver() {
override fun onReceive(context: Context, intent:
Intent) {
// 中身は次のスライドへ
}
}
}
val filter = IntentFilter(ACTION_USB_PERMISSION)
registerReceiver(usbReceiver, filter)

72. permission要求結果を受け取る
val usbReceiver = object : BroadcastReceiver() {
override fun onReceive(context: Context, intent:
Intent) {
// 中身は次のスライドへ
}
}
}
val filter = IntentFilter(ACTION_USB_PERMISSION)
registerReceiver(usbReceiver, filter)
permission要求した時のアクショ
ンを指定します

73. permission要求結果を受け取る
〜BroadcastReceiverの中身〜
if (ACTION_USB_PERMISSION == intent.action) {
val accessory: UsbAccessory? =
intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY
)
if
(intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_
GRANTED, false)) {
// 許可された
// データのやり取りをする
} else {
// 拒否された
}
}

74. permission要求結果を受け取る
〜BroadcastReceiverの中身〜
if (ACTION_USB_PERMISSION == intent.action) {
val accessory: UsbAccessory? =
intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY
)
if
(intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_
GRANTED, false)) {
// 許可された
// データのやり取りをする
} else {
// 拒否された
}
}

75. USB接続の基礎知識まとめ
● USB Accessoryのページしっかり読みましょう
○ https://developer.android.com/guide/topic
s/connectivity/usb/accessory.html
● ドキュメントだけだとわかりにくかった
● 実際に動かしながら挙動を確かめながら確認し
ていくとわかりやすいです

76. アプリ開発
した時の事

77. アプリ開発した時のこと
● HWが出来てない時の開発の
進め方
● デバッグが大変
● ハマりどころ

78. アプリ開発した時のこと
● HWが出来てない時の開発の
進め方
● デバッグが大変
● ハマりどころ

79. HWが出来てない時の開発の進め方
● そもそもハードがまだ出来てない
● 動くものがないから試せない
● 予想で作るしかない。。。？
USB

80. HWが出来てない時の開発の進め方
どうしよう。。？
ググる。

81. HWが出来てない時の開発の進め方
● AndroidとPCのUSB通信のサンプル
○ http://blog.kotemaru.org/2013/10/0
6/android-usb-adk.html
● androidUSBSample
○ https://github.com/kotemaru/kotem
aru/tree/master/androidUSBSampl
e
● Arudinoで動かすという事例も

82. HWが出来てない時の開発の進め方
PCで動かせる！！
圧倒的感謝！！！！

83. HWが出来てない時の開発の進め方
● PCとUSB接続して作っていく
● AOAの仕組みで動けばよい
● モックを作って動かしていた
USB

84. HWが出来てない時の開発の進め方
PCで動かせるということ
は。。。！！！

85. HWが出来てない時の開発の進め方
今日からみなさんも開発出来ま
すね

86. アプリの開発
● HWが出来てない時の開発の
進め方
● デバッグが大変
● ハマりどころ

87. USB接続してハードウエアと通信してい
る。。。
デバッグが大変
USB

88. デバッグが大変
ん？

89. デバッグが大変
USB接続しているからPCと接
続できない。。。

90. デバッグが大変
Wi-Fi経由でadb接続出来
る！！！

91. デバッグが大変
Wi-Fi経由でadb接続
adb tcpip 5555
adb connect <device-ip-address>:5555

92. デバッグが大変
しかし何故か手元では出来な
かった。。。

93. デバッグが大変
1. デバッグ用のログを細かくファ
イルに保存
2. 後からファイルを参照してデ
バッグする
これで一旦は解決！

94. アプリの開発
● HWが出来てない時の開発の
進め方
● デバッグが大変
● ハマりどころ

95. ハマりどころ その１
Activityでしか接続のイベントを
受けられない

96. Activityでしか接続のイベントを受け
られない
● BroadcastReceiverでは受け
られない！
● 受けようしてた。。
● ドキュメントちゃんと読んでな
かった。。。

97. Activityでしか接続のイベントを受け
られない
でも。。
BroadcastReceiverで受けた
い！

98. Activityでしか接続のイベントを受け
られない
● Serviceで接続する処理書い
てた
● 裏側でUSBでデータやり取り
● 毎回Activity立ち上がってほ
しくない

99. Activityでしか接続のイベントを受け
られない
1. USB接続イベントActivityで受ける
2. 自分でBroadcast Intent作って放つ
3. すぐにActivityはfinish
4. BroadcastReceiverで受ける！

100. ハマりどころ その２
DFUする時に
とある１機種で挙動が違う

101. DFUする時に
とある１機種で挙動が違う
DFUとは？
● Device Firmware Update
● HWの中で動いてるファームを
アップデートする処理のこと

102. DFUする時に
とある１機種で挙動が違う
DFUする時の正常な処理の
流れ

103. DFUする時に
とある機種で挙動が違う
DFUします！
わかりました！

104. DFUする時に
とある機種で挙動が違う
1. 再起動（瞬断）

105. DFUする時に
とある機種で挙動が違う
1. 再起動（瞬断）
2. 切断イベント
close処理
3. 接続イベント
接続処理
データ送信

106. DFUする時に
とある機種で挙動が違う
とある1機種の場合

107. DFUする時に
とある機種で挙動が違う
DFUします！
わかりました！

108. DFUする時に
とある機種で挙動が違う
1. 再起動（瞬断）

109. DFUする時に
とある機種で挙動が違う
1. 再起動（瞬断）
。。。

110. DFUする時に
とある機種で挙動が違う
1. 再起動（瞬断）
。。。
何もイベントが飛んでこな
い。。。

111. DFUする時に
とある機種で挙動が違う
こうやって対応した

112. DFUする時に
とある機種で挙動が違う
DFUします！
わかりました！

113. DFUする時に
とある機種で挙動が違う
1. 再起動（瞬断）

114. DFUする時に
とある機種で挙動が違う
1. 再起動（瞬断）
2. 自分でcolse処理
4. 自分で接続処理
データ送信
3. 数秒待つ。。

115. DFUする時に
とある機種で挙動が違う
1. 再起動（瞬断）
2. 自分でcolse処理
4. 自分で接続処理
データ送信
3. 数秒待つ。。
これをしないと接続出来なくなる！

116. DFUする時に
とある機種で挙動が違う
機種依存的なものは
これ以外にはなかったは
ず。。。！

117. ハマりどころ その３
物理的にはささっているけど、
切断・接続イベントが飛んでくる

119. ケーブルや相性によってはグラグラする
と、切断・接続を繰り返す。。。

120. 物理的にはささっているけど、切断・
接続イベントが飛んでくる
USBケーブルは適切なものを選
びましょう

121. 最後に

122. ● USB接続するアプリの開発が
出来るなんてとてもいい経験
だった。
● なるべく実機で動かさずにテ
ストで動作を担保出来るよう
になるといいですね
最後に

123. ● USB接続するアプリ開発され
た経験のある方はお話したい
です
● スマドラや今日お話したハー
ドにご興味ある方は現物もっ
てきているのでお話しましょう
最後に

124. ご清聴ありがと
うございまし
た！

125. ふろく

126. 参考文献
● USB Host and Accessory
○ https://developer.android.com/guide/topics/connectivity/
usb/index.html
● AOA2.0を実装してみた
○ https://www.slideshare.net/YuuichiAkagawa/aoa20
● AndroidとPCのUSB通信のサンプル
○ http://blog.kotemaru.org/2013/10/06/android-usb-adk.ht
ml
○ https://github.com/kotemaru/kotemaru/tree/master/andr
oidUSBSample

127. ● Android 2.3.4でUSB Accsesoryを使う場合には
別途Google APIs add-on libraryを導入する必要
がありますが、4系以上の端末が殆どだと思いま
すので、省いています
● 本スライドに載せたサンプルコードは説明を完結
にする為に省略している部分があります。null
チェックや例外の処理など、適切に行いましょう。
補足

128. ● 参考文献のURLにPCとスマホでUSB接続するサ
ンプルがありましたが、僕の方でも作っておりま
す。（現在進行形です）
○ https://github.com/mapyo/UsbAccessorySam
ple
補足