WinActor

2020.03.30
サンプルシナリオ WinActorノート
Raspberry Piに接続してLEDライトを点灯/消灯するサンプルシナリオ

WinActorのSSHライブラリを使用し、Raspberry Piに接続して、LEDライトを点灯/消灯するサンプルシナリオとなります。

本コンテンツをダウンロードする前にこちらの利用条件を必ずご確認いただき、内容に同意をしたうえでダウンロードしてください。 また、"コンテンツの利用条件"は下のボタンからダウンロードし、お手元で保管してください。

サンプルシナリオ概要

Raspberry Piに接続してLEDライトを点灯/消灯するサンプルシナリオ

Raspberry Piに接続してLEDライトを点灯/消灯するサンプルシナリオ

はじめに

WinActorのSSHライブラリを使用し、Raspberry Piに接続して、LEDライトを点灯/消灯するサンプルシナリオ(以降、本サンプルシナリオ)について説明します。

本サンプルシナリオの概要

本サンプルシナリオは、以下の処理を行います。

  • SSHクライアントを用いてRaspberry Piに接続し、指定されたコマンド(mode変更、点灯/消灯)を実行して、結果をWinActorノートに出力します。
  • WinActorノートに出力した結果を、指定したテキストファイルに書き込みます。

使用するWinActorモジュール

本サンプルシナリオでは、以下のWinActorモジュールを使用します。

  • 01_WinActor制御/08_実行ログ/ログメッセージ出力.ums6
  • 25_WinActorノート/02_SSHツール/SSHクライアントを開く.ums6
  • 25_WinActorノート/02_SSHツール/コマンドを実行する(SSHクライアント).ums6
  • 25_WinActorノート/02_SSHツール/SSHクライアントを閉じる.ums6
  • 25_WinActorノート/テキストファイル書き込み.ums6

本サンプルシナリオの想定レベル

本サンプルシナリオのドキュメントは、以下の技術レベルのユーザを対象としています。

  • Linuxにおける動作を理解している。
  • SSHにおける仕様を理解している。
  • GPIOにおける仕様を理解している。

動作確認環境

本サンプルシナリオは以下の環境で動作確認しています。

  • Windows 10
  • WinActor 6.2.0
  • Raspberry Pi Zero W
  • LED 型番:OSM54K5111A

制約事項

  • 本サンプルシナリオの動作を確認するために、Raspberry Piの準備が必要です。
  • SSHクライアントの接続方法はパスワード認証を対象としています。

本サンプルシナリオの使い方

本サンプルシナリオの使い方は以下の通りです。

Step 1. Raspberry Piの起動

本サンプルシナリオは、WinActorの動作するPCとRaspberry PiをSSHで接続し、GPIO経由でLEDライトを点灯/消灯するサンプルシナリオです。
そのため、予めRaspberry PiとRaspberry PiのGPIOに接続して動作するLEDライトをご用意ください。
ご用意いただいたRaspberry PiとLEDを以下を参考に接続し、起動してください。

RasPi回路図
RasPi回路図

Step 2. サンプルシナリオの読み込み

ダウンロードしたZIPファイルを展開し、展開したフォルダに含まれている本サンプルシナリオをWinActorで読み込みます。

Step 3. 動作に必要なパラメータを設定

本サンプルシナリオを実行するために必要な値を、変数一覧で設定します。
事前に設定が必要な変数は下記の5つです。

  • ホスト
    • SSH接続を行うために接続先のIPアドレスをパラメータに設定します。
      例) 192.168.1.100
  • ポート番号
    • SSH接続を行うために接続先のポート番号をパラメータに設定します。
      例) 22
  • ユーザー名
    • SSH接続を行うために接続先のユーザー名をパラメータに設定します。
      例) pi
  • パスワードファイル
    • SSH接続を行うために接続先のパスワードファイルをパラメータに設定します。パスワードファイルは、シナリオファイルの置かれたフォルダからの相対パスで指定します。
      例) raspberryPW.json
  • コマンド待ち文字列
    • ログイン処理が完了した際に表示さ れるプロンプトの末尾を含む文字列を設定します。
      例) $
SSH接続パラメータ設定例
SSH接続パラメータ設定例

タイムアウト値と実行結果出力先については、初期値のまま実行しても問題ありませんが、タイムアウト秒数を指定する場合や実行結果の出力先ファイルの設定する場合、以下の変数の値を変更してください。

  • タイムアウト値[秒]
    • SSH接続に失敗した場合、タイムアウトとして例外処理する秒数を設定します。
      例) 10
  • 実行結果出力先
    • 実行結果としてWinActorノートの状態を出力するテキストファイルの出力先を設定します。
      例) .\log.txt

Step 4. サンプルシナリオの実行

WinActorで本サンプルシナリオを実行します。 選択ボックスから、動作内容(点灯/消灯)を選択してください。どちらかを選択後、コマンドが実行されます。
テキストファイル書き込みまで完了すると、本サンプルシナリオは終了します。

Step 5. サンプルシナリオの終了後

実行したコマンドが、テキストファイル書き込みライブラリのファイル名で指定したファイルに出力されています。

  • pi@raspberrypi:~$ gpio -g mode 14 out

  • pi@raspberrypi:~$ gpio -g write 14 1

  • pi@raspberrypi:~$ gpio -g write 14 0

トラブルシューティング

本サンプルシナリオでは、接続ミスや変数指定が不十分であった場合、エラーメッセージが出力されます。

詳細については、エラーメッセージ一覧を参照してください。

サンプルシナリオ解説

本サンプルシナリオで使用している実装テクニックやサンプルシナリオの拡張例について説明します。

SSH接続

本サンプルシナリオでは、変数一覧で設定した値を用い、SSH接続をしています。

SSH接続
SSH接続

SSHツールライブラリの設定方法については、「WinActorノート 端末機能シナリオ作成マニュアル」を参照してください。

SSHでRaspberry Piにログインするためには下記の情報が必要です。

  • ホスト
  • ポート番号
  • ユーザ名
  • パスワードファイル

本サンプルでは、SSH通信でRaspberry Piにログインし、GPIOコマンドを使ってRaspberry Piを操作します。

SSH通信の利用が終了したら、SSH接続を終了します。

SSH接続終了
SSH接続終了

GPIOコマンド

Raspberry PiでGPIOコマンドを使って操作をする場合、基板上に並んだ40本(旧モデルでは26本)のピンの中で、GPIO xx と記載されているピンが実際のデータの入出力の操作で使用できます。

コマンドラインから、"gpio"コマンドでGPIOを操作することが可能で、下記のコマンドを用いることで、GPIOの状態がわかります。

  • $ gpio readall

"Mode"の部分に現在のピンのモード(IN/OUT)が、"V"の部分にピンの値(1ならON、0ならOFF)が表示されます。

本サンプルで使用するGPIOコマンドを解説します。

GPIOコマンド
GPIOコマンド
  • ① gpio -g mode 14 out

    • GPIO14ピンを出力モードに設定します。
  • ② gpio -g write 14 1

    • GPIO14ピンをON(=1)にします。
  • ③ gpio -g write 14 0

    • GPIO14ピンをOFF(=0)にします。

GPIO機器の状態読み取り

本サンプルシナリオではGPIOを出力モードとして、GPIOへ値を書き込むことでLEDライトの点灯/消灯を制御しています。

発行しているGPIOコマンドを変更し、GPIOの値を読み取ることでGPIOに接続された機器の状態を取得することが可能です。

GPIOの値を読み取る際に使用するGPIOコマンドを解説します。

  • ① gpio -g mode 14 in

    • GPIO14ピンを入力モードに設定します。
  • ② gpio -g read

    • GPIO14ピンの状態を読み取ります。

本サンプルシナリオとの組み合わせにより、例えばGPIOに接続されたセンサの状態を読み取り、状態に応じてLEDライトの点灯/消灯を制御するシナリオの作成が可能です。

変更履歴

版数 日付 修正内容
1.0版 2020/03/30 初版
1.1版 2023/6/12 ・注意事項を削除
・ファイル名を「SS2003_9264_RaspberryPiOperation_1.0.1.zip」に変更

本コンテンツをダウンロードする前にこちらの利用条件を必ずご確認いただき、内容に同意をしたうえでダウンロードしてください。 また、"コンテンツの利用条件"は下のボタンからダウンロードし、お手元で保管してください。

"WinActorノート"に関連するその他のサンプルシナリオ

サンプルシナリオ一覧へ戻る
当サイトでは、お客さまに最適なユーザー体験をご提供するためにCookieを使用しています。当サイトをご利用いただくことにより、お客さまがCookieの使用に同意されたものとみなします。詳細は、「プライバシーポリシー」をご確認ください。