コマンドリファレンス

通信仕様

115,200bps (TERMコマンドにより変更可能)
8ビット
パリティなし
ストップビット1
改行文字 '\n' (TERMコマンドにより変更可能)

コマンドとリプライ

コマンドは改行文字を区切りとしたテキストデータです(1行1コマンド). コマンドによっては、コロン記号':'の後に引数が必要な場合があります. 大文字・小文字は区別されます.

コマンドに対しては、リプライが返ります. リプライはOKもしくはNGから始まり、最後は改行文字で終わります. OKの後、コロン記号':'に続いて戻り値が返される場合があります. NGの後はコロン記号':'に続いてエラーコードが返ります. エラーコードについてはエラーハンドリングをご覧ください.

ネットワーク関連コマンド

SSID: SSID設定

WiFiアクセスポイントのSSIDを設定します. 一度設定するとモジュール内部の不揮発性メモリに記憶され、次回起動時に読み込まれます.

SSID:EXAMPLE_SSID↵
OK

引数なしで呼び出すと現在モジュールに記憶されているSSIDを表示します

SSID↵
OK:EXAMPLE_SSID

SSIDの最大長は64文字です.

PASS: パスフレーズ設定

WiFiアクセスポイントに接続するためのパスフレーズを設定します. 一度設定するとモジュール内部の不揮発性メモリに記憶され、次回起動時に読み込まれます.

PASS:EXMAPLE_PASSPHRASE↵
OK

引数なしで呼び出すと現在モジュールに記憶されているパスフレーズを表示します

PASS↵
OK:EXAMPLE_PASSPHRASE

パスフレーズの最大長は64文字です.

CONN: WiFi接続

WiFiネットワークに接続を開始します.

CONN↵
OK

DISC WiFi切断

ネットワークを切断して通信機能を停止します。

DISC↵
OK

IPSTAT: IP情報取得

現在の接続についての情報を取得します.

IPSTAT↵
OK:(IPアドレス):(サブネットマスク):(デフォルトゲートウェイIPアドレス)

IPCONF: 固定IP設定

固定IPアドレスについての設定します. 一度設定するとモジュール内部の不揮発性メモリに記憶され、次回起動時に読み込まれます.

IPCONF:(IPアドレス):(サブネットマスク):(デフォルトゲートウェイIPアドレス)↵
OK

すべて0.0.0.0を指定すると固定IPは使用されず、DHCPによる動的なIPアドレス付与になります.

PROXY: プロクシ設定

プロクシサーバーの設定をします.2つの引数をとります. 第1引数にはプロクシサーバのホスト名もしくはIPアドレスを指定します. 第2引数にはプロクシサーバのポート番号を指定します. 一度設定するとモジュール内部の不揮発性メモリに記憶され、次回起動時に読み込まれます.

PROXY:proxy-server.net:3128↵
OK

空文字列およびポート番号に0を指定するとプロクシは無効となります。

PROXY::0↵
OK

ホスト名の最大長は64文字です.

MAC: MACアドレス取得

WiFi通信に使用されるMACアドレスを取得します. 正しい値を取得するには, CONNコマンドでWiFiアクセスポイントに正常に接続されている必要があります.

CONN↵
OK
MAC↵
OK:XX-XX-XX-XX-XX-XX

ファイル・バケット操作

LIST: ファイル一覧取得

バケットに含まれるファイルのファイルID一覧をカラムバッファに取得します.

LIST↵
OK  <-- カラムバッファに格納される
MIDX↵
OK:21 <-- カラム番号0～21にデータあり. 22個のファイルがある.
COL:0
OK:EXAMPLE_FILE <-- ファイル名をカラムバッファから取り出す.

注意: マイクロバケットサービスでは1つのバケットに10,000ファイルまで作成可能ですが、 LISTコマンドで取得できるのは最大256ファイルまでです.

USE: 操作ファイル選択

引数にファイル名を指定すると、操作対象のファイルを切り替えます.

USE:(操作対象のファイル名)
OK

なお、CONNコマンドでネットワークに接続時する際には自動的に 'DEFAULT' という名前のファイルが(存在すれば)選択されます.

NEW: ファイル作成

引数で指定した名前のファイルを新規に作成します. ファイル名は他のファイルと重複できません.

NEW:(作成するファイル名)↵
OK

REN: ファイル名変更

現在選択されているファイルの名前を引数で指定した名前に変更します. ファイル名は他のファイルと重複できません.

REN:(新しいファイル名)↵
OK

FDEL: ファイル削除

現在選択されているファイルを削除します.

FDEL↵
OK

BSZ: バケットサイズ取得

バケットのストレージ容量と使用済み容量を取得します.

BSZ↵
OK:(使用済み容量):(確保済み容量)

単位はバイトです.

レコード関連コマンド

COL: カラムバッファ更新・取得

カラムバッファの値を設定・取得します. 引数にカラム番号を設定します. 有効なカラム番号は0-255です.

COL:0:VALUE↵
OK

第2引数を指定せずに実行すると、カラムバッファに格納されているデータが返ります.

COL:0↵
OK:VALUE

CLR: カラムバッファ消去

カラムバッファの値をすべて消去します.

CLR↵
OK

MIDX: 最大カラム番号取得

データが入っている最大のカラム番号を取得します. カラムバッファが空の場合には-1が返ります.

MIDX↵
OK:10

GET: レコード取得

クラウドからレコードを取得します。

GETコマンドの引数にタイムスタンプを指定すると、指定のタイムスタンプのレコードを読み出します。

GET:(タイムスタンプ)↵
OK

タイムスタンプを指定しない場合、現在時刻に最も近いレコードがカラムバッファに読み出されます.

GET↵
OK

POST: レコード追加

カラムバッファに格納されたレコードをクラウドに追加で書き込みます。タイムスタンプはクラウド側で付与されます.

POST↵
OK:(タイムスタンプ)

PUT: レコード更新

タイムスタンプを指定してクラウドにレコードを書き込みます.

PUT:(タイムスタンプ)
OK

すでに指定したタイムスタンプにレコードがある場合には上書きされます.

DEL: レコード削除

指定したタイムスタンプのレコードを削除します.

DEL:(タイムスタンプ)↵
OK

IO関連コマンド

GPIO: IO状態取得・設定

モジュールの汎用IOピンの状態を取得/設定します.

ピンの値を取得するには第1引数にピン番号を指定します. (IOCNFコマンドによって入力方向に設定されている必要があります)

GPIO:0↵
OK:1

ピンに値をセットするには第1引数にピン番号を指定し, 第2引数に値を設定します. (IOCNFコマンドによってピンが出力方向に設定されている必要があります)

GPIO:0:1↵
OK

IOCONF: IOピン設定

IOピンを設定します.

IOCONF:(ピン番号):(設定値)
OK

設定値と意味は次の通りです:

値	ピン方向	プルアップ
0	入力	OFF
1	出力	-
2	入力	ON

デフォルトの値は0です.

電源関連コマンド

SLEEP: スリープ

モジュールをスリープします.

SLEEP↵

RESET: リセット

モジュールをリセットします.

RESET↵

その他のコマンド

TIME: 時刻取得

現在時刻を取得します. 取得される値はUNIX時刻です. 取得される時刻はMicroBucketのサーバとの通信経路の遅延の影響を受ける点にご注意ください.

TIME↵
OK:1555488799

TERM: 端末設定

ホストとのシリアル通信に関する設定値を変更をします. 設定値は下記の表に表される8ビットの符号なし整数を10進数で表記したものです. デフォルト値は0(すべてのビットが0)です. 一度設定するとモジュール内部の不揮発性メモリに記憶され、次回起動時に読み込まれます.

TERM:33↵  <-- 2進数表記 00100001 (エコーバックON, シリアルポートIO16,IO17使用) 
OK

ビット位置	設定名	1の意味	0の意味
0	エコーバック	ON	OFF
1	改行コード	\r\n	\n
2	予約	-	-
3	予約	-	-
4	通信ボーレート	9,600	115,200
5	シリアルポート	RX=GPIO3, TX=GPIO1	RX=GPIO16 TX=GPIO17
6	予約	-	-
7	予約	-	-

注意! 設定を不用意に書き換えた場合、通信ができなくなります.

なお、引数なしで実行すると、現在の設定値が返ります.

TERM↵
OK:33