konashi SDK for Android

※ バグ改善や要望以外の質問については konashiATux-xu.com 宛にご連絡下さい。

Requirements

• Android 4.3 or later
• Android Studio 1.0 or later
• konashi 2.0 or later

konashi ver1 は konashi-v1-android-sdk(obsoleted) にてサポートしておりました。

Installation

dependencies {
    compile 'com.uxxu.konashi:konashi-android-sdk:2.1.1'
}

Getting Started

• Getting Started
• APIリファレンス

Usage

samples フォルダ内に各機能の使い方を紹介するサンプルアプリを用意しています。

• PioSample
• PwmSample
• AioSample
• UartSample
• I2cSample
• SpiSample

開発について

機能要望やバグ報告をするには

開発者に要望を伝える報告する方法は以下です。

• GitHub の Issues に投稿
  • https://github.com/YUKAI/konashi-android-sdk/issues
  • feature-requests、bug、discussion などのラベルをご使用ください。
• Pull Request
  • バグ見つけて修正しといたよ、というときは Pull Request を develop ブランチに送ってください。
  • 詳細は ブランチの運用 をご覧ください。
• “konashi" をキーワードにつぶやく
  • twitter で #konashi のハッシュをつけるか、 konashi というキーワードを使って tweet してください。
  • もしくは konashi をキーワードにブログに書いてください。
• contact@ux-xu.com にメールする
  • メールでの報告も受け付けています。

ブランチの運用

git-flow を使用しています。各ブランチの役割は以下です。

• master
  • リリース用のブランチです。GitHubでは master ブランチがデフォルトのブランチです。
• develop
  • 開発用のブランチです。
• feature/***
  • 新機能追加やバグ修正を行うブランチです。develop ブランチから feature ブランチを切り、開発が完了後に develop ブランチに merge します。
• release/v***
  • リリース前ブランチです。develop ブランチから release ブランチを切り、テストが終わり次第 master ブランチにマージされます。(現在は基本的に origin に push されません)

タグの運用

基本的にリリース時にバージョン名でタグを切ります。konashi 公式ページからリンクされる zip ダウンロード先は最新のリリースタグの zip です。

タグ一覧はこちら。

Pull Request

規模の大小関わらず、バグ修正や機能追加などの Pull Request 大歓迎！

Pull Request を送るにあたっての注意点は以下です。

• 最新の develop ブランチから任意の名前でブランチを切り、実装後に develop ブランチに対して Pull Request を送ってください。
  • master ブランチへの Pull Request は(なるべく)ご遠慮ください。

ライセンス

konashi のソフトウェアのソースコード、ハードウェアに関するドキュメント・ファイルのライセンスは以下です。

• ソフトウェア
  • konashi-android-sdk のソースコードは Apache License Version 2.0 のもと公開されています。
• ハードウェア
  • konashi の回路図などハードウェア関連のドキュメント・ファイルのライセンスは クリエイティブ・コモンズ・ライセンス「表示-継承 2.1 日本」です。これに従う場合に限り、自由に複製、頒布、二次的著作物を作成することができます。
  • 回路図のデータ(eagleライブラリ)は公開予定です。
• konashi および konashi2.0 のBLEモジュールのファームウェアは公開しておりません。