Skip to content

Commit 06871ba

Browse files
TakayukiHoshi1984TakayukiHoshi1984
authored
Merge pull request #239 from TakayukiHoshi1984/modify_readme_md_link
README.mdとreadme.en.mdのリンクを修正
2 parents 197eed2 + a6c8f7b commit 06871ba

2 files changed

Lines changed: 89 additions & 74 deletions

File tree

‎README.md‎

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1+
Click [here](readme.en.md) for description of English.
2+
13
# DeviceConnect-iOS について
24

35
DeviceConnect-iOSはiOS版のDeviceConnectのプラットフォームになります。
46

57
このガイドでは以下のことについて解説していきます。
68

7-
* プロジェクトの説明]
8-
* dConnectBrowserのビルドと起動
9-
* DeviceConnectアプリの開発
9+
* Device Connect SDKのビルド
10+
* プロジェクトの説明
11+
* Device Connectアプリケーションの開発
12+
* Device Connect SDKのDoxygen出力
13+
* ビルドマニュアル
1014
* サポートするXcodeのバージョン
1115

12-
# DeviceConnectSDKのビルド
16+
# Device Connect SDKのビルド
1317

1418
DeviceConnect-iOS のソースコードをダウンロードし、解凍します。
1519

@@ -18,7 +22,7 @@ $ curl -LkO https://github.com/DeviceConnect/DeviceConnect-iOS/archive/master.zi
1822
$ unzip master.zip
1923
```
2024

21-
DeviceConnectSDK をビルドします。
25+
Device Connect SDK をビルドします。
2226

2327
```sh
2428
$ cd DeviceConnect-iOS-master/dConnectSDK/dConnectSDKForIOS/
@@ -31,29 +35,47 @@ $ xcodebuild -scheme DConnectSDK_framework -configuration Release
3135
## dConnectDevicePlugin
3236
| プロジェクト名|内容 |
3337
|:-----------|:---------|
34-
|dConnectDeviceAllJoyn|AllJoynのデバイスプラグイン。|
35-
|dConnectDeviceAWSIoT|AWSIoTのデバイスプラグイン。|
36-
|dConnectDeviceChromeCast|Chromecastのデバイスプラグイン。|
37-
|dConnectDeviceHitoe|Hitoeのデバイスプラグイン。|
38-
|dConnectDeviceHost|iOS端末のデバイスプラグイン。|
39-
|dConnectDeviceHue|Hueのデバイスプラグイン。|
40-
|dConnectDeviceIRKit|IRKitのデバイスプラグイン。|
41-
|dConnectDeviceLinking|Linkingのデバイスプラグイン。|
42-
|dConnectDevicePebble|Pebbleのデバイスプラグイン。|
43-
|dConnectDeviceSonyCamera|QX10などのSonyCameraのデバイスプラグイン。|
44-
|dConnectDeviceSphero|Spheroのデバイスプラグイン。|
45-
|dConnectDeviceTheta|THETAのデバイスプラグイン。|
46-
|dConnectDeviceTest|DeviceConnectのテスト用のデバイスプラグイン。|
38+
|dConnectDeviceAllJoyn|AllJoynのプラグイン。|
39+
|dConnectDeviceAWSIoT|AWSIoTのプラグイン。|
40+
|dConnectDeviceChromeCast|Chromecastのプラグイン。|
41+
|dConnectDeviceHitoe|Hitoeのプラグイン。|
42+
|dConnectDeviceHost|iOS端末のプラグイン。|
43+
|dConnectDeviceHue|Hueのプラグイン。|
44+
|dConnectDeviceIRKit|IRKitのプラグイン。|
45+
|dConnectDeviceLinking|Linkingのプラグイン。|
46+
|dConnectDevicePebble|Pebbleのプラグイン。|
47+
|dConnectDeviceSonyCamera|QX10などのSonyCameraのプラグイン。|
48+
|dConnectDeviceSphero|Spheroのプラグイン。|
49+
|dConnectDeviceTheta|THETAのプラグイン。|
50+
|dConnectDeviceTest|DeviceConnectのテスト用のプラグイン。|
4751
|DCMDevicePluginSDK|共通の独自拡張Profileライブラリ。 |
4852

4953
## dConnectSDK
5054
| プロジェクト名|内容 |
5155
|:-----------|:---------|
5256
|dConnectBrowser|DeviceConnect用のBrowserアプリ。|
5357
|dConnectBrowserForIOS9|DeviceConnect用のiOS9以降用Browserアプリ。|
54-
|dConnectSDKForIOS|DeviceConnectのプラットフォーム本体用ライブラリ。このライブラリをデバイスプラグインやネイティブアプリを作成するときに使用する。|
58+
|dConnectSDKForIOS|DeviceConnectのプラットフォーム本体用ライブラリ。このライブラリをプラグインやネイティブアプリを作成するときに使用する。|
5559
|dConnectSDKSample|DeviceConnectのJavaScript用テストを実行するためのアプリ。|
5660

61+
62+
# Device Connectアプリケーションの開発
63+
iOS版Device Connectを使用したアプリケーション開発および、プラグイン開発に関しましては、以下のページを参考にしてください。
64+
65+
* [アプリケーション開発マニュアル](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/ApplicationManual-20)<br>
66+
Device Connect Managerを使用したアプリケーション開を開発したい場合には、こちらのアプリケーション開発マニュアルをご参照ください。
67+
68+
* [プラグイン開発マニュアル](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/DevicePluginManual-20)<br>
69+
Device Connect Managerに対応したプラグインを開発したい場合には、こちらのプラグイン開発マニュアルをご参照ください。
70+
71+
# Device Connect SDKのDoxygen出力
72+
以下のコマンドを実行することで、Doxygenを出力します。
73+
74+
```
75+
$ cd DeviceConnect-iOS-master/dConnectSDK/dConnectSDKForIOS
76+
$ doxygen Doxyfile
77+
```
78+
5779
# ビルドマニュアル
5880

5981
* [dConnectBrowser](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/dConnectBrowser-Build)
@@ -72,7 +94,7 @@ $ xcodebuild -scheme DConnectSDK_framework -configuration Release
7294
* [AWSIoT](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/AWSIoT-Build)
7395

7496
# サポートするXcodeのバージョン
75-
DeviceConnectのデバイスプラグインは、下記に記すXcode以外でのビルド・実行をサポートしていません。
97+
DeviceConnectのプラグインは、下記に記すXcode以外でのビルド・実行をサポートしていません。
7698

7799
|プラグイン名|Xcodeバージョン|
78100
|:--|:--|

‎readme.en.md‎

Lines changed: 47 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
# DeviceConnect-iOS
2-
* 日本語説明はこちら
3-
https://github.com/DeviceConnect/DeviceConnect-iOS/blob/master/readme.ja.md
4-
5-
# About DeviceConnect WebAPI
6-
"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.
1+
日本語説明は[こちら](README.md)
72

83
# About DeviceConnect iOS
94

@@ -12,14 +7,33 @@ Device Connect iOS will be the platform of DeviceConnect of iOS version.
127

138
In this guide I will continue to discuss the following.
149

15-
* [Project description](#section1)
16-
* [Build and start-up of dConnectBrowser](#section2)
17-
* [Operation check](#section3)
18-
* [Development of DeviceConnect app](#section4)
19-
* [Xcode version to support](#section5)
10+
* Build Device Connect SDK
11+
* Project description
12+
* Development of Device Connect app
13+
* Generate a Doxygen of Device Connect SDK
14+
* Build Manuals
15+
* Xcode version to support
16+
17+
18+
# Build Device Connect SDK
19+
Download DeviceConnect-Android source code.
20+
21+
```
22+
$ curl -LkO https://github.com/DeviceConnect/DeviceConnect-iOS/archive/master.zip
23+
$ unzip master.zip
24+
```
2025

26+
Build Device Connect SDK
2127

22-
# <a name="section1">Project description</a>
28+
```sh
29+
$ cd DeviceConnect-iOS-master/dConnectSDK/dConnectSDKForIOS/
30+
$ xcodebuild -scheme DConnectSDK_framework -configuration Release
31+
```
32+
33+
The framework and bundle are generated in `DeviceConnect-iOS-master / dConnectSDK / dConnectSDKForIOS / bin` folder.
34+
35+
36+
# Project description
2337
## dConnectDevicePlugin
2438
| Project Name|Content |
2539
|:-----------|:---------|
@@ -46,7 +60,26 @@ In this guide I will continue to discuss the following.
4660
|dConnectSDKForIOS|DeviceConnect library for the platform body. Want to use this library when you want to create a device plug-ins and native apps.|
4761
|dConnectSDKSample|App to execute JavaScript for testing DeviceConnect.|
4862

49-
# <a name="section2">Build and start-up of dConnectBrowser</a>
63+
64+
# Development of Device Connect app
65+
Application and using the DeviceConnect, regard the development of the application, please refer to the following pages.
66+
67+
* [Application Development Manual](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/ApplicationManual-20)<br>
68+
If you want to develop an application that uses the Device Connect Manager, please refer to this device plug-in development manual.
69+
70+
* [Device plug-in development manual](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/DevicePluginManual-20)<br>
71+
If you want to develop a plug-in device that corresponds to the Device Connect Manager, please refer to this device plug-in development manual.
72+
73+
74+
# Generate a Doxygen of Device Connect SDK
75+
Execute the following command to output Doxygen.
76+
77+
```
78+
$ cd DeviceConnect-iOS-master/dConnectSDK/dConnectSDKForIOS
79+
$ doxygen Doxyfile
80+
```
81+
82+
# Build Manuals
5083
To install the dConnectBrowser to iOS terminal, first finished the Developer registration of Xcode installation and iOS, please keep in create an environment that can actual transfer.<br>
5184

5285
In this state, please start the DeviceConnect.xcworkspace. In the workspace that is started, a list of device plug-ins and dConnectBrowser of projects that have been implemented in the dConnectBrowser appears.<br>
@@ -69,49 +102,9 @@ Basically, you work with start-up of dConnectBrowser only, such as when you make
69102
* [AWSIoT](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/AWSIoT-Build)
70103

71104

72-
# <a name="section3">Operation check</a>
73-
To dConnectBrowser the address bar `http://localhost:4035/gotapi/availability` Please enter the.<br>
74-
If this response is returned in the following, such as JSON, you will be able to make sure that DeviceConnect is running.<br>
75-
76-
<center><a href="./assets/availability.PNG" target="_blank">
77-
<img src="./assets/availability.PNG" border="0"
78-
width="375" height="667" alt="" /></a></center>
79-
80-
Request
81-
82-
```
83-
GET http://localhost:4035/gotapi/availability
84-
```
85-
86-
Response
87-
88-
```
89-
{
90-
"product":"dConnectBrowser",
91-
"version":"x.x",
92-
"name":"Manager-0702",
93-
"uuid":"xxxx-yyyyy-zzz-aaaa",
94-
"result":0,
95-
}
96-
```
97-
98-
The API of the non-availability, you will not be able to easily check is basically to dConnectBrowser of address in order to access token is required to.
99-
If you want to create an application using the API of Device Connect, please refer to us a sample of [here] (https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/ApplicationManual).
100-
101-
# <a name="section4">Development of DeviceConnect app</a>
102-
Application and using the DeviceConnect, regard the development of the application, please refer to the following pages.
103-
104-
* [Application Development Manual](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/ApplicationManual)
105-
<br>
106-
If you want to develop an application that uses the Device Connect Manager, please refer to this device plug-in development manual.
107-
* [Device plug-in development manual](https://github.com/DeviceConnect/DeviceConnect-iOS/wiki/DevicePluginManual)<br>
108-
If you want to develop a plug-in device that corresponds to the Device Connect Manager, please refer to this device plug-in development manual.
109-
110-
111-
# <a name="section5">Xcode version to support</a>
105+
# Xcode version to support
112106
Device plug-ins DeviceConnect does not support the build execution other than Xcode referred to below.
113107

114-
115108
|Device Plug-in Name|Xcode version|
116109
|:--|:--|
117110
|ChromeCast|8.0|

0 commit comments

Comments
 (0)