obniz.jsのインストール

obniz.jsはobnizにインターネット経由で接続して使うためのjavascript用sdkです。

このsdkはobniz cloudの提供するAPIを網羅していて、APIを意識せずidでobnizと接続し、ファームウェアを書いているようにjavascript側でio等の操作を行うことができます。

特徴

  • obniz Cloud Websocket API の網羅
  • 標準パーツライブラリ
  • local connect によるobnizとの自動的な内部ネットワーク接続
  • 圧縮フォーマットによる通信
  • HTMLにおけるデバッグ情報表示サポート
  • ブラウザ/Nodejsでの動作
  • async/await による記載

また、obniz.jsはすべてのコードがGithub上で公開されています。

https://github.com/obniz/obniz

obniz.jsはGithubとnpmにより管理されています。
常に新しいバージョンが毎週のように公開されています。
どのバージョンが最新で、何ができるようになったのかはGithubより確認できます。
https://github.com/obniz/obniz/releases

インストール

ブラウザとNodejsの場合でインストール方法が異なります。

ブラウザ

unpkg経由でnpmに公開さているファイルにアクセスします。
仮にobniz.jsのバージョン1.0.0を取り込む場合は

<script src="https://unpkg.com/obniz@1.0.0/obniz.js"></script>

これだけでOKです。これでグローバル変数としてObnizというのが使えるようになります。
他の依存ファイルはありません。

nodejs

npmでインストールします。バージョンを指定せず最新のものを取り込むには以下のようにします。

npm install obniz

そしてjsファイルの中でrequireして下さい。

const Obniz = require('obniz');

インストールは以上で完了です。
Obnizというのがobnizのクラスとなっており、idを使ってインスタンス化してobnizに接続します。
詳しくは続きのレッスンをご覧ください。