initial commit

libraries/BusIOForStuduino/README.md

@@ -0,0 +1,48 @@
+# BusIOForStuduino
+
+Adafruit BusIO ライブラリ v1.0.0 を、株式会社アーテックが Studuino 向けに
+改変したものです。I2C デバイスのレジスタアクセスを抽象化します。
+
+オリジナル: https://github.com/adafruit/Adafruit_BusIO
+オリジナルのライセンス(MIT)は `LICENSE` を参照してください。
+
+本ライブラリは `MSA301ForStuduino` から使用されます。単体で使うことは想定していません。
+
+Adafruit が配布する公式版の `Adafruit_BusIO` と同時にインストールしても衝突しないよう、
+ライブラリ名・フォルダ名・ファイル名・インクルードガードを変更しています。
+
+## オリジナルからの変更点
+
+### 1. ライブラリ名・ファイル名の変更
+
+公式版との衝突を避けるため、次のように改名しました。クラス名は変更していません。
+
+| オリジナル | 本ライブラリ |
+|:--|:--|
+| `Adafruit_BusIO`(フォルダ) | `BusIOForStuduino` |
+| `Adafruit_I2CDevice.h` / `.cpp` | `BusIOForStuduino_I2CDevice.h` / `.cpp` |
+| `Adafruit_BusIO_Register.h` / `.cpp` | `BusIOForStuduino_Register.h` / `.cpp` |
+| `Adafruit_I2CDevice_h`(インクルードガード) | `BusIOForStuduino_I2CDevice_h` |
+| `BusIO_Register_h`(インクルードガード) | `BusIOForStuduino_Register_h` |
+| `name=Adafruit BusIO` | `name=BusIOForStuduino` |
+
+### 2. SPI サポートの削除
+
+`Adafruit_SPIDevice` および `Adafruit_BusIO_Register` の SPI 用コンストラクタ・
+SPI 分岐を削除(コメントアウト)しました。Studuino は I2C のみを使用します。
+これに伴い `Adafruit_I2CRegister.h` も削除しています。
+
+### 3. 未使用オーバーロードの削除
+
+`Adafruit_BusIO_Register` の `read(uint8_t*)` / `read(uint16_t*)` /
+`read(uint32_t*)` / `print()` / `println()`、および
+`Adafruit_BusIO_RegisterBits::read()` の実装を削除(コメントアウト)しています。
+
+**注意:** これらは `.h` 側に宣言が残ったままです。使用するとリンクエラーになります。
+`MSA301ForStuduino` はいずれも使用していないため、現状は問題ありません。
+
+### 4. 配布物からの除外
+
+ビルドに不要なファイルを削除しました(`examples/`、`.travis.yml`)。
+`examples/` は上記 2. と 3. により、そのままではコンパイルが通らなくなっていたため
+削除しています。