<commit_before># konashi SDK for Android #alpha

![image](http://konashi.ux-xu.com/img/header_logo.png)

スマートフォンでのフィジカルコンピューティングツールキットであるkonashiのAndroid対応SDKです。

現在α版でまだまだ改良される予定です！

## 動作環境
- Android4.3以降 (SDK Version >= 18)
- Bluetooth Low Energy (Bluetooth4.0) 対応端末

## Getting started

#### まず konashi-android-sdk をダウンロード
```
$ git clone <EMAIL>:YUKAI/konashi-android-sdk.git
```

#### eclipse でライブラリのプロジェクトとしてインポート
`File -> Import`で Import ウィンドウを開く。<br/>
そして、`Android -> Existing Android Code into Workspace`を選択。<br/>
Import Projects ウィンドウが開くので、Root Directory にさきほどダウンロードした `konashi-android-sdk/Konashi`ディレクトリを指定して、Finishをクリック。

eclipse のプロジェクトに KonashiLib というライブラリプロジェクトが追加されているか確認してください。

##### サンプルプロジェクトを作成
eclipse でAndroidプロジェクトを作成してください。

#### konashi-android-sdk ライブラリをサンプルプロジェクトに追加
`Package Explorer`にて、サンプルプロジェクトを右クリックして`Properties`を選択。<br/>
Properties ウィンドウが開いたら左のプロパティリストの中にある`Android`という項目を選択。<br/>
Library の `Add` を押し、`KonashiLib`を選択。

これで konashi ライブラリを使えるようになりました。

#### BLEのパーミッション追加
Bluetooth を使えるように、AndroidManifest.xml に以下のパーミッションを追加。

```xml:AndroidManifest.xml
<uses-permission android:name="android.permission.BLUETOOTH"/>
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
```

もし、BLE機能を持っているAndroidのみインストール可能にするには、AndroidManifest.xml に以下も追加。

```xml:AndroidManifest.xml
<uses-feature android:name="android.hardware.bluetooth_le" android:required="true"/>
```

#### コードを書く
comming soon

#### 実機で動かす

Galaxy S3 (docomo) に CyanogenMod のAndroid4.3のカスタムROMを利用してBLEを使えるようにして実行してみましょう。

![image](images/konashi_sample_basic.png)


## 国内のBLE対応Androidに関して
### Android4.3以降が公式に提供されている端末
- Nexus 7(2013)
- Nexus 5
- GALAXY J
- GALAXY Note 3

### キャリアのBluetoothのスペック(4.0,BLE or not)
#### au
- [http://www.au.kddi.com/developer/android/kishu/bluetooth/](http://www.au.kddi.com/developer/android/kishu/bluetooth/)
<commit_msg>update readme.<commit_after># konashi SDK for Android #alpha

![image](http://konashi.ux-xu.com/img/header_logo.png)

スマートフォンでのフィジカルコンピューティングツールキットであるkonashiのAndroid対応SDKです。

現在α版でまだまだ改良される予定です！

## 動作環境
- Android4.3以降 (SDK Version >= 18)
- Bluetooth Low Energy (Bluetooth4.0) 対応端末

## Getting started

#### まず konashi-android-sdk をダウンロード
```
$ git clone <EMAIL>:YUKAI/konashi-android-sdk.git
```

#### eclipse でライブラリのプロジェクトとしてインポート
`File -> Import`で Import ウィンドウを開く。<br/>
そして、`Android -> Existing Android Code into Workspace`を選択。<br/>
Import Projects ウィンドウが開くので、Root Directory にさきほどダウンロードした `konashi-android-sdk/Konashi`ディレクトリを指定して、Finishをクリック。

eclipse のプロジェクトに KonashiLib というライブラリプロジェクトが追加されているか確認してください。

##### サンプルプロジェクトを作成
eclipse でAndroidプロジェクトを作成してください。

#### konashi-android-sdk ライブラリをサンプルプロジェクトに追加
`Package Explorer`にて、サンプルプロジェクトを右クリックして`Properties`を選択。<br/>
Properties ウィンドウが開いたら左のプロパティリストの中にある`Android`という項目を選択。<br/>
Library の `Add` を押し、`KonashiLib`を選択。

これで konashi ライブラリを使えるようになりました。

#### BLEのパーミッション追加
Bluetooth を使えるように、AndroidManifest.xml に以下のパーミッションを追加。

```xml:AndroidManifest.xml
<uses-permission android:name="android.permission.BLUETOOTH"/>
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
```

もし、BLE機能を持っているAndroidのみインストール可能にするには、AndroidManifest.xml に以下も追加。

```xml:AndroidManifest.xml
<uses-feature android:name="android.hardware.bluetooth_le" android:required="true"/>
```

#### コードを書く

[こちら](https://github.com/YUKAI/konashi-android-sdk/blob/master/samples/KonashiSampleBasic/src/com/uxxu/konashi/sample/basic/MainActivity.java)を参考に、LEDをチカチカさせるコードを書いてみましょう！

#### 実機で動かす

Galaxy S3 (docomo) に CyanogenMod のAndroid4.3のカスタムROMを利用してBLEを使えるようにして実行してみましょう。

![image](images/konashi_sample_basic.png)

LEDを光らせることができたら成功です！

## APIリファレンス
Javadocで提供しています。


## 国内のBLE対応Androidに関して
### Android4.3以降が公式に提供されている端末
- Nexus 7(2013)
- Nexus 5
- GALAXY J
- GALAXY Note 3

### キャリアのBluetoothのスペック(4.0,BLE or not)
#### au
- [http://www.au.kddi.com/developer/android/kishu/bluetooth/](http://www.au.kddi.com/developer/android/kishu/bluetooth/)

{'fraction_non_alphanumeric': 0.13453713123092573, 'fraction_numerical': 0.01017293997965412, 'mean_word_length': 6.9939024390243905, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 25, 'https://': 1, 'lorem ipsum': 0, 'www.': 4, 'xml': 12}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3327495', 'n_tokens_mistral': 2170, 'n_tokens_neox': 2046, 'n_words': 217}