MESHハブアプリケーションCLI(コマンドラインインタフェース)

■CLI提供機能一覧

 

Raspberry Pi版MESHではターミナルから実行可能なCLI(Command Line Interface)により、以下の機能を提供します。

 

  • CLIのヘルプ表示
  • MESHのソフトウェアバージョンの表示
  • MESHの設定の表示、変更
    • Raspberry Piブート時のMESHの自動起動の有効化/無効化
    • MESHからのGPIO制御の有効化/無効化
  • MESHの起動/停止/再起動/起動状態の表示
  • MESH起動時のモード(セットアップ / ノーマル)の表示、変更
  • データ消去

 

■使用方法

 

mesh [-h|--help|-v|--version]

 

 

オプション書式 説明と実行例
-h|--help
(オプション無し)
CLIの使い方を表示します。
実行例:mesh -h
-v|--version Raspberry Pi向けMESHハブアプリケーションのソフトウェアバージョンを表示します。
実行例:mesh -v

 

mesh {command} [option]

 

コマンド オプション書式 説明と実行例
help (オプション無し) CLIの使い方を表示します。

実行例:mesh help
version (オプション無し) Raspberry Pi向けMESHハブアプリケーションのソフトウェアバージョンを表示します。

実行例:mesh version
status (オプション無し) MESHの起動状態を表示します。

実行例:mesh status
setting [[[--startup on|off] [--gpio on|off]]
  |[--show]]

MESHの自動起動設定やMESHステータスボード用のGPIO制御設定を表示、変更します。

実行例1:mesh setting
自動起動設定、GPIO制御設定を表示

実行例2:mesh setting --startup on --gpio on
自動起動設定とGPIO制御を有効化

 

※GPIO制御をOFFからONにした場合は、mesh restartを実行した後に有効になります。

start [--startup on|off] [--gpio on|off] MESHを起動します。オプションによる指定で設定を変更しつつ起動することもできます。

実行例1:mesh start
MESHを起動

実行例2:mesh start --gpio off
GPIOを無効化してMESHを起動
stop (オプション無し) MESHを停止します。

実行例:mesh stop
restart [--startup on|off] [--gpio on|off] MESHを再起動します。オプションによる指定で設定を変更しつつ再起動することもできます。

実行例1:mesh restart
MESHを再起動

実行例2:mesh restart --gpio off
GPIOを無効化してMESHを再起動
mode [[--set normal|setup]|[--show]]

起動中のMESHのモードの表示、変更を行います。

実行例1:mesh mode
現在のモードを表示

実行例2:mesh mode --set setup
モードをセットアップモードに変更します。

 

※動作モードの種類

  • normal: 正常動作中
  • setup: セットアップモード
  • reset: 初期化待機中(この状態でRaspberry Piの電源を抜き差しするとMESHが保存しているデータが初期化されます。表示のみで指定はできません。初期化する場合は clear コマンドをご利用ください。)
clear [--force] MESHが保存しているデータ(レシピなど)を削除し、初期化します。

実行例1:mesh clear
データを削除するかどうかを問い合わせた後に、データ削除、または、削除処理をキャンセル

実行例2:mesh clear --force
問い合わせ無しですぐにデータを削除