Skip to content

Commit fa90e29

Browse files
TakayukiHoshi1984TakayukiHoshi1984
committed
Merge pull request #18 from TakayukiHoshi1984/modify_readme_files
Modify readme files
2 parents 81ee616 + 8b1b950 commit fa90e29

File tree

2 files changed

+120
-23
lines changed

2 files changed

+120
-23
lines changed

‎README.md

+87-12
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
https://github.com/DeviceConnect/DeviceConnect-Docs/blob/master/readme.ja.md
33

44
# About DeviceConnect WebAPI
5-
"DeviceConnect WebAPI" is WebAPI which operates as a virtual server on a smart phone. It can use easily various wearable devices and an IoT device by unific description from a web browser or an application.
5+
"DeviceConnect WebAPI" is WebAPI which operates as a virtual server on a smart phone. It can use easily various wearable devices and an IoT device by unific description from a web browser or an application.
66

77
# Introduction
88
Device Connect system is a multi-OS, on the run-time environment of multi-platform, provides API (RESTful) for connection to a smart device.<br>
@@ -75,10 +75,10 @@ _Updated some package names of the sample for Android at 2014/10/15._
7575
_Please reinstall by following procedure if you would check this sample again._
7676

7777
```
78-
1. Delete files that are related to the demoWebSite.zip on internal storage.
79-
2. Uninstall a APK of old Manager and plugins.
80-
3. Choose "CLEAR BROWSING DATA..." in "history" on Chrome Browser menu.
81-
4. Choose "Clear" button with "Clear the cache" check box.
78+
1. Delete files that are related to the demoWebSite.zip on internal storage.
79+
2. Uninstall a APK of old Manager and plugins.
80+
3. Choose "CLEAR BROWSING DATA..." in "history" on Chrome Browser menu.
81+
4. Choose "Clear" button with "Clear the cache" check box.
8282
5. Refer to the procedure for "Example for Android" in "Readme.md".
8383
```
8484

@@ -102,161 +102,196 @@ Android root
102102

103103
5.Try the prototype GotAPI behavior from "Launch UI-App".
104104

105-
106105
##About access from the external devices
107106

108107
By adding the parameter of the IP address to the demoWebSite URL, can control the external device by DeviceConnect WebAPI at a local network. However, the following settings are required for terminal on the operation side.
109108

110109
_*Please do not use at network that can not be trusted because there is a security risk._
111110

112-
1. By the procedure as above , set up the DeviceConnect WebAPI to the terminal of the operation target.
111+
1. By the procedure as above , set up the DeviceConnect WebAPI to the terminal of the operation target.
113112

114-
2. Start the DeviceConnectManager from the launcher of Android,and turn off the slide toggle for DeviceConnectManager service.
115-
3. Enable "Allow External IP" checkbox, and turn on the slide toggle for DeviceConnectManager service.
113+
2. Start the DeviceConnectManager from the launcher of Android,and turn off the slide toggle for DeviceConnectManager service.
114+
3. Enable "Allow External IP" checkbox, and turn on the slide toggle for DeviceConnectManager service.
116115

117116
4. Add the IP address of the operation target in URL of demoWebSite on the operation side terminal.
118117
```
119118
e.g. file:///C:/demoWebSite/demo/index.html?ip=192.168.13.3#demo
120119
```
121120

122-
123-
124121
#Supported devices
125122
<table>
126123
<tr>
127124
<td>Manufacturer</td>
128125
<td>Product name</td>
129126
<td>Device type</td>
130127
<td>Plug-in</td>
128+
<td>Android</td>
129+
<td>iOS</td>
131130
<td>Remarks</td>
132131
</tr>
133132
<tr>
134133
<td>SONY</td>
135134
<td>SmartWatchMN2</td>
136135
<td>Watch</td>
137136
<td>MN2/SW2</td>
137+
<td>○</td>
138+
<td>×</td>
138139
<td>Need the app launch on SmartWatch</td>
139140
</tr>
140141
<tr>
141142
<td>SONY</td>
142143
<td>SmartWatchSW2</td>
143144
<td>Watch</td>
144145
<td>MN2/SW2</td>
146+
<td>○</td>
147+
<td>×</td>
145148
<td>Need the app launch on SmartWatch</td>
146149
</tr>
147150
<tr>
148151
<td>Orbotix</td>
149152
<td>Sphero 2.0</td>
150153
<td>Toy</td>
151154
<td>Sphero</td>
155+
<td>○</td>
156+
<td>○</td>
152157
<td></td>
153158
</tr>
154159
<tr>
155160
<td>Game Technologies</td>
156161
<td>DICE+</td>
157162
<td>Toy</td>
158163
<td>DICE+</td>
164+
<td>○</td>
165+
<td>○</td>
159166
<td>Need the firmware for development</td>
160167
</tr>
161168
<tr>
162169
<td>Philips</td>
163170
<td>hue</td>
164171
<td>Light</td>
165172
<td>hue</td>
173+
<td>○</td>
174+
<td>○</td>
166175
<td></td>
167176
</tr>
168177
<tr>
169178
<td>Philips</td>
170179
<td>Bloom Lamp</td>
171180
<td>Light</td>
172181
<td>hue</td>
182+
<td>○</td>
183+
<td>○</td>
173184
<td></td>
174185
</tr>
175186
<tr>
176187
<td>Philips</td>
177188
<td>LightStrips</td>
178189
<td>Light</td>
179190
<td>hue</td>
191+
<td>○</td>
192+
<td>○</td>
180193
<td></td>
181194
</tr>
182195
<tr>
183196
<td>IRKit</td>
184197
<td>IRKit</td>
185198
<td>Infrared remote control</td>
186199
<td>IRKit</td>
200+
<td>○</td>
201+
<td>○</td>
187202
<td></td>
188203
</tr>
189204
<tr>
190205
<td>Epson</td>
191206
<td>Moverio BT-200</td>
192207
<td>Glasses</td>
193208
<td>Android Host</td>
209+
<td>○</td>
210+
<td>×</td>
194211
<td>The future works; Support the extension</td>
195212
</tr>
196213
<tr>
197214
<td>Vuzix</td>
198215
<td>M100 Smart Glass</td>
199216
<td>Glasses</td>
200217
<td>Android Host</td>
218+
<td>○</td>
219+
<td>×</td>
201220
<td>The future works; Support the extension</td>
202221
</tr>
203222
<tr>
204223
<td>WESTUNITIS</td>
205224
<td>Inforod</td>
206225
<td>Glasses</td>
207226
<td>Android Host</td>
227+
<td>○</td>
228+
<td>×</td>
208229
<td>The future works; Support the extension</td>
209230
</tr>
210231
<tr>
211232
<td>SONY</td>
212233
<td>DSC-QX100</td>
213234
<td>Camera</td>
214235
<td>SonyCamera</td>
236+
<td>○</td>
237+
<td>○</td>
215238
<td></td>
216239
</tr>
217240
<tr>
218241
<td>SONY</td>
219242
<td>DSC-QX10</td>
220243
<td>Camera</td>
221244
<td>SonyCamera</td>
245+
<td>○</td>
246+
<td>○</td>
222247
<td></td>
223248
</tr>
224249
<tr>
225250
<td>Pebble</td>
226251
<td>Pebble</td>
227252
<td>Watch</td>
228253
<td>Pebble</td>
254+
<td>○</td>
255+
<td>○</td>
229256
<td></td>
230257
</tr>
231258
<tr>
232259
<td>-</td>
233260
<td>Android Ver4.0</td>
234261
<td>Android</td>
235262
<td>Android Host</td>
263+
<td>○</td>
264+
<td>×</td>
236265
<td></td>
237266
</tr>
238267
<tr>
239268
<td>LG</td>
240269
<td>G Watch</td>
241270
<td>Android Wear</td>
242271
<td>Wear</td>
272+
<td>○</td>
273+
<td>×</td>
243274
<td>Provisional support</td>
244275
</tr>
245276
<tr>
246277
<td>Samsung</td>
247278
<td>Gear Live</td>
248279
<td>Android Wear</td>
249280
<td>Wear</td>
281+
<td>○</td>
282+
<td>×</td>
250283
<td>Provisional support</td>
251284
</tr>
252285
<tr>
253286
<td>Google</td>
254287
<td>ChromeCast</td>
255288
<td>ChromeCast</td>
256289
<td>Chromecast</td>
290+
<td>○</td>
291+
<td>○</td>
257292
<td>Need to register the Receiver Apps and device on Google Cast SDK Developer Console.</td>
258293
</tr>
259-
294+
260295
<!-- <tr>
261296
<td>AND</td>
262297
<td>UA-767PBT-C</td>
@@ -402,20 +437,60 @@ _*Please do not use at network that can not be trusted because there is a securi
402437
<td>H7</td>
403438
<td>Heart rate meter</td>
404439
<td>BLE Heart Rate</td>
440+
<td>○</td>
441+
<td>×</td>
405442
<td></td>
406443
</tr>
407444
<tr>
408445
<td>Mio Global</td>
409446
<td>Mio Alpha</td>
410447
<td>Heart rate meter</td>
411448
<td>BLE Heart Rate</td>
449+
<td>○</td>
450+
<td>×</td>
412451
<td></td>
413452
</tr>
414453
<tr>
415454
<td>OMRON</td>
416455
<td>HVC-C</td>
417456
<td>Human Vision Components</td>
418457
<td>HVC</td>
458+
<td>○</td>
459+
<td>×</td>
460+
<td></td>
461+
</tr>
462+
<tr>
463+
<td>FUJITSU</td>
464+
<td>F-PLUG</td>
465+
<td>Smart Meter</td>
466+
<td>F-PLUG</td>
467+
<td>○</td>
468+
<td>×</td>
419469
<td></td>
420470
</tr>
471+
<tr>
472+
<td>RICOH</td>
473+
<td>THETA m15</td>
474+
<td>Spherical Camera</td>
475+
<td>THETA</td>
476+
<td>○</td>
477+
<td>○</td>
478+
<td>Need to register developer and download SDK at RICHO THETA Developers.</td>
479+
</tr>
480+
<tr>
481+
<td>LIFX</td>
482+
<td>White 800</td>
483+
<td>Light</td>
484+
<td>AllJoyn</td>
485+
<td>○</td>
486+
<td>○</td>
487+
<td>White 800 can not change color.</td>
488+
</tr>
421489
</table>
490+
491+
* This project is not a formal service provision as NTT docomo. It is an experimental source code disclosure. The purpose is consideration of specifications and security.
492+
* Each manufacturer does not guarantee the operation.
493+
* Available functions vary with each device.
494+
* The source code of the plug-in will be disclosed about some equipment by convenience of development for the library to be used.
495+
* We will advance sequentially that updating documents and expanding enabled devices.
496+
* Specifications may be changed by improvement of security or other reasons.

‎readme.ja.md

+33-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# DeviceConnect WebAPI について
22

3-
43
Device Connect WebAPIはスマートフォン上で仮想サーバとして動作するWebAPIで、様々なウェアラブルデバイスやIoTデバイスをWebブラウザやアプリから統一的な記述で簡単に利用することができます。
54

65
* 動作環境として、Android、iOSに対応しています。WebブラウザとしてはChrome、Safari(擬似的な仕組み)、Firefoxで動作を確認しています。
@@ -20,11 +19,10 @@ Device Connectシステムは、マルチOS、マルチプラットフォーム
2019
- 機器プロファイルによる統一的なAPI
2120
- ユーザによるアプリケーション認可機能
2221

23-
2422
<center><a href="https://raw.githubusercontent.com/wiki/DeviceConnect/DeviceConnect-Android/DevicePluginManual/image1_2.png" style="text-align:center" target="_blank">
2523
<img src="https://raw.githubusercontent.com/wiki/DeviceConnect/DeviceConnect-Android/DevicePluginManual/image1_2.png" border="0"
2624
width="251" height="235" alt="" style="text-align:center"/></a></center>
27-
25+
2826
# アプリケーション側の要件
2927
## リクエストの発行元を明示すること
3028
OMA GotAPI 1.0の規定に従い、Device Connectシステム上のアプリケーションはその発行元に対して認可されます。よって、Device Connectシステムは発行元の明示されないHTTPリクエストに対してエラーレスポンスを返します。
@@ -88,12 +86,12 @@ DeviceConnect-Android、およびDeviceConnect-iOSと連携するデバイス上
8886
1\. Androidの内部ストレージにデモコンテンツ用フォルダを作成し（[例]"demoWebSite"）、
8987
そこにサンプルのdemoWebSiteフォルダ以下のすべてのファイルをコピーしてください。
9088
adbコマンドが使える場合は、以下のようなコマンドでファイルをコピーすることができます。
91-
89+
9290
```
9391
adb push demoWebSite /sdcard/demoWebSite
9492
```
95-
96-
93+
94+
9795
```
9896
Android root
9997
└── mnt
@@ -103,9 +101,9 @@ Android root
103101

104102
2\. Firefoxブラウザのアドレス欄に内部ストレージのURIを記入し、
105103
内部ストレージにあるWebコンテンツにアクセスしてください。
106-
104+
107105
_※ChromeブラウザVer.45以降、Fileスキーム(file:///)でのデモの動作確認が出来なくなっております。_
108-
106+
109107
```
110108
[例] file:///sdcard/demoWebSite/index.html
111109
```
@@ -128,8 +126,6 @@ Android root
128126
* HOSTを選ぶと利用できる機能の一覧（Profile List）が表示されます。
129127
* そこから、vibrationを選び、Vibrateを選ぶと端末が振動します（最初の利用時にプラグイン利用の許可が必要です）。
130128

131-
132-
133129
##外部からのアクセスについて
134130

135131
* demoWebSiteのURLにIPアドレスのパラメータを付加することで、ローカルネットワーク上の他の端末で動作するDeviceConnect WebAPIの操作も可能になります。ただし、操作される側の端末に以下の設定が必要です。
@@ -151,7 +147,6 @@ Android root
151147
```
152148
_※遠隔で意図しない端末の操作およびデータ参照をされるリスクが伴います。信頼が出来ないローカルネットワーク環境に接続される可能性がある場合はDeviceConnectManagerの外部IPを許可のチェックを無効化してください_
153149

154-
155150
# 対応デバイス
156151

157152
<table>
@@ -534,6 +529,33 @@ Android root
534529
<td>×</td>
535530
<td></td>
536531
</tr>
532+
<tr>
533+
<td>FUJITSU</td>
534+
<td>F-PLUG</td>
535+
<td>スマートメーター</td>
536+
<td>F-PLUG プラグイン</td>
537+
<td>○</td>
538+
<td>×</td>
539+
<td></td>
540+
</tr>
541+
<tr>
542+
<td>RICOH</td>
543+
<td>THETA m15</td>
544+
<td>Spherical Camera</td>
545+
<td>THETAデバイスプラグイン</td>
546+
<td>○</td>
547+
<td>○</td>
548+
<td>RICOH THETA Developersにて開発者登録、およびSDKのダウンロードが必要。</td>
549+
</tr>
550+
<tr>
551+
<td>LIFX</td>
552+
<td>White 800</td>
553+
<td>ライト</td>
554+
<td>AllJoynデバイスプラグイン</td>
555+
<td>○</td>
556+
<td>○</td>
557+
<td>White 800の色は変えられない。</td>
558+
</tr>
537559
</table>
538560

539561
* 本プロジェクトはＮＴＴドコモとしての正式なサービス提供ではなく、実験的なソースコード開示です。仕様やセキュリティの検討を目的としております。

0 commit comments

Comments
 (0)