obniz

obniz入門:まず公式ドキュメントを読もう

obnizと仲良くなるには、公式ドキュメントを読んで例題を動かしてみるのが早道です。しかし、公式ドキュメントは数が多いので、どれから読み始めれば良いか初心者にはわかりにくいと思います。この記事では、初心者にお勧めの公式ドキュメントとそれを読む順番を解説します。

本記事は2021年4月6日時点でのobniz社のwebページに基づいて記載しています。obniz社のwebページは頻繁に更新されているので、ずれが生じている可能性があります。

対象機種

obnizには製品がいくつかありますが、この記事が対象とするのはobniz Boardobniz Board 1Y です。

ドキュメントの種類

obniz社のwebページを開くとページ上部にプルダウンメニューが並んでいます。

トップページでプルダウンメニューが表示されないことがあります。

この場合は下記のどちらかを行えば表示できます。

  • 右上にあるハンバーガーマークをクリックする。
  • ブラウザのウィンドウ幅を広げる。

 

「ドキュメント」プルダウンメニュー

「ドキュメント」にマウスを乗せると次のようなプルダウンメニューが表示されます。

このプルダウンメニューから4種類のページに移動できます。

obnizスタートガイド チュートリアル資料が置かれています。
サンプルコード 作例が置かれています。JavaScriptのみのようです。ブロックプログラムのサンプルプログラはここにはないようです。
ドキュメント リファレンスマニュアル系の資料が置かれています。(注:「ドキュメント」という名前がプルダウンメニュー名と被っていてちょっとわかりにくいですね。)
パーツライブラリ obnizに接続可能な機器(センサーやアクチュエータ)のリファレンスマニュアル

 

「導入事例」プルダウンメニュー

obnizトップページには 「導入事例 」というプルダウンメニューもあり、こちらにはobnizを使った導入事例や制作例のページへのリンクがあります。ここにあるドキュメントをざっと眺めると、obnizでできることが把握できます。

 

ドキュメントを読む順序

obniz入門者は次の順番で資料を読むと良いと思います。

  1. obnizトップページでobnizの最新情報を確認する。
  2. obnizスタートガイドに置いてある資料中で入門者向けの資料を読んでobnizの基本を把握する。
  3. 使いたいプログラミング言語に応じたガイドを読む。obnizスタートガイドには、ブロックプログラムJavaScriptNode.jsの3つのガイドが置いてある。
  4. 自分のやりたいことに応じた説明資料をサンプルコード制作例ドキュメントパーツライブラリなどで探して読む。

各ページの説明を以下に記載します。

obnizトップページ

obniz社のwebページのトップページです。下半分にあるNews & Release欄を見て最新情報をチェックしておきましょう。

News & Rlease リリース情報、イベント情報、プレスリリースなどが記載されています。特にリリース情報には新しく対応されたパーツや不具合修正が記載されているので、時々チェックすることをお勧めします。

obnizスタートガイド

チュートリアル資料が沢山並んでいます。初めてobnizを触る人は、まず左上にある「 IoT電子回路入門」にある資料を順番に読んでみましょう。タイトルが「電子回路入門」となっていますが、実際はobnizに電源を投入して使い始める手順が記載されています。

obnizの基礎 IoT電子回路入門

obnizを使い始めるための手順が記載されています。

ライセンス済み製品の購入 obnizOSがインストールされた公式デバイスの購入方法が記載されています。obniz Boardとobniz Board 1Yがそれぞれどのような用途に適しているかも書かれています。
クラウドにつなげる obnizを動作させるにはWi-Fiに接続する必要があります。製品ごとに接続手順が記載されています。obniz Boardとobniz Board 1Yの場合は、obniz Board(1Y)をクリックします。

クリックすると「起動とWi-Fi設定」ページに進みます。

説明にしたがって、

  • Step1. obniz Boardの起動
  • Step2. Wi-Fiに接続
  • Step3. プログラムの実行

を行います。Step3.プログラム実行ではサンプルプログラムを実行しますが、このプログラムの詳しい説明は、画面左上にある「動かしてみよう」をクリックして開くページに記載されています。

クリックするとこのページが開きます。

このページにはソースコード、プログラムの実行/終了方法、このプログラムでできること等が記載されています。

起動とWiFi設定」ページに戻り、Step3.の次に書いてある

  • クラウドへのデバイス登録

は行わずにこのページを終えます。

アカウントの作成と紐付け obnizクラウドでの、

  • アカウント登録方法
  • デバイス(obniz Boardなど)をアカウントへ紐付ける方法

が説明されています。説明に従ってアカウント登録とデバイスの紐付けを行ってください。

紐付けが終わったら、obniz Boardのファームウェアを最新版に更新することをお勧めします。更新方法はこちらに記載されています。

 

(2021年4月5日時点での情報です)


注意点1:
アカウントの作成
欄に「サインアップ」というリンクがありますが、

実際にはサインインページ(既にアカウントを持っている人のログインページ)が開きます。

右下のユーザ登録をクリックするとサインアップページに行けます。


注意点2:

アカウントの作成欄に「参考ページ:デバイスの登録」というリンクがあります。このリンクをクリックすると「アカウントと請求」ページが開きます。この中に「支払い方法の登録」欄がありますが、obniz Boardとobniz Board 1Yには無期限クラウドライセンスが付いているので支払い方法を登録する必要はありません。
公式デバイス以外にobnizOSをインストールして使ったり、有料アプリを使う場合は利用料が発生するケースがありますが、obniz入門時点では気にする必要はありません。


注意点3:

アカウントの作成と紐付け」ページでリポジトリサーバレスイベントの説明が出てきますが、現在これらはレガシー機能になっていて、利用は推奨されていません。

プログラムエディタの使い方 obnizクラウドの開発環境内に用意されているプログラムエディタを起動する方法が記載されています。このエディタはHTML/JavaScriptでobnizのプログラムを書く場合に使用します。

プログラムエディタを開くと、あらかじめサンプルプログラムが書き込まれています。自由に編集して動かしてみることができますが、一度編集してしまうと元のプログラムは失われます。サンプルプログラムに戻したい人は、「動かしてみよう」ページに記載されているプログラムをコピーしてエディタにペーストしてください。

このページの説明では「プログラムエディタを開く」というリンクをクリックして直接エディタ画面を開くようになっていますが、通常はobnizトップページ右上にある「開発コンソール」をクリックして開発コンソールを開き、左端のメニュの「HTMLプログラム」をクリックしてエディタを開きます。

HTMLプログラム」の下にある「ブロックプログラム」をクリックした場合は、ブロックプログラムのエディタが開きます。

内臓部品を使う obniz Boardにはディスプレイとスイッチが搭載されています。このページにはディスプレイを使うためのコード例とディスプレイのリファレンスマニュアルページへのリンクが書かれています。「参考ページ:obniz.jsディスプレイ」をクリックするとマニュアルページに行けます。

マニュアルページ内では、プログラム例が次のような形式で記載されている場合があります。

「Type obniz Id」部分に自分のobniz BoardのIDを記入し、右にある「実行」ボタンをクリックすると、自分のobniz Boardでプログラム例を実行することができます。コードを編集して実行してみることもできます。

obniz Boardのスイッチの使い方に関しては記述がありません。obniz Boardにあらかじめ用意されているサンプルプログラムを見たり、リファレンスマニュアルのスイッチのページを見て使い方を覚えてください。

「内臓部品を使う」のページではJavaScriptでのプログラミングの話しか書いてありません。ブロックプログラムの書き方の説明はこのページにはありません。

パーツライブラリの部品を使う (後で読みましょう)
IOやBLEを操作して部品を使う (後で読みましょう)
サーバレスイベントで実行 (読まなくてOK)(注:これはレガシー機能の説明です)

「内臓部品を使う」まで読み進んだら、残った3つは後回しにして、先にJavaScriptやブロックプログラムでプログラムを書く方法を学びましょう。

 

ブラウザ連携 JavaScript x obniz

obnizスタートガイドページに「ブラウザ連携 JavaScript x obniz」というガイドがあります。JavaScriptに慣れている人はこちらのガイドを読みましょう。

 

ブラウザ連携 ブロックプログラム入門

obnizスタートガイドページに「ブラウザ連携 ブロックプログラム入門」というガイドがあります。ブロックプログラムの基本から丁寧に解説されています。JavaScriptをあまり触ったことがない人はこのガイドを読み始めるとobnizを楽しめると思います。

 

obnizの基礎 IoT電子回路入門の「パーツライブラリの部品を使う」

JavaScriptやブロックプログラムを使えるようになったら、次に「obnizの基礎 IoT電子回路入門」に戻って「パーツライブラリの部品を使う」を読んでみましょう。LED、サーボモーター、可変抵抗などの基本的な電子部品の使い方が説明されています。各電子部品のリファレンスマニュアルがパーツライブラリにあり、それへのリンクも書かれています。

 

obnizの基礎 IoT電子回路入門の「IOやBLEを操作して部品を使う」

パーツライブラリにない部品を使ったり、BLEやシリアルIOで通信する場合のプログラミング方法が記載されています。obniz初心者は読まなくても大丈夫です。どうしてもBLEを使いたいといった状況になれば、その時読みましょう。

 

obnizの基礎 IoT電子回路入門の「サーバーレスイベントで実行」

サーバーレスイベントはレガシー機能なので読む必要はありません。サーバーレスイベントに相当する現在の機能は、「obnizスタートガイド」ページの「ブラウザアプリを作る」に記載されています。

 

制作例を読む

ここまで紹介してきたドキュメントを読み終えれば、obnizを自由自在に使えるようになっていると思います。あとは作りたいものをどんどん作っていくだけです。

制作例を眺めると、「こんなパーツがあるのか」、「こういう用途にも使えるのか」、「こんな組み合わせがあるのか」といった発見があり、作る物のアイディアが次々に湧いてきます。ぜひ制作例を読んでみてください。

obnizの制作例のページは少し混沌とした状態です。入り口となるページが複数あり、またページのフォーマットも複数あります。私が見つけたページを以下にあげます。これ以外にもあるかもしれませんし、今後全体構成が大幅に変更になるかもしれません。

 

サンプルコード

サンプルコード」は、obnizトップページの「ドキュメント」プルダウンメニューの「サンプルコード」から開けるページです。用途別に制作例のリンクが並んでいます。obniz社以外のページへのリンクもあります。

 

公式制作レシピ集

公式制作レシピ集」は、obniz社が書いた制作例が網羅的に掲載されているページです。obniz BoardやM5StickCといった製品別に制作例を絞り込むことができます。

このページは、「obnizスタートガイド」ページの上部にある「DIY制作例」タブをクリックすることで開けます。

ページを開くとこんな画面になります。

 

活用事例

obnizトップページの「導入事例」プルダウンメニューから開けるページです。プルダウンメニューでは用途別になっていますが、活用事例のトップページはこちらです。