0.お久しぶりです!!
前回の記事投稿からかなり経ってしまいました!申し訳ありません!私の大学での事情と就活等諸々大変でして...
この記事のPart1で意外と反響がありましたので続けていきます。
では今回は前回準備したコードを実際に動かしていきます!前回から時間が経ちRaspberry piやVscodeのバージョンがアップしていますが操作の違いや環境設定の変更などは必要ないです。
1.復習と補足
前回やったことをまとめます。
- 準備(IPアドレス固定化、必要機能インストール)
- ディレクトリ構成
- コードを書く
- コード解説
上の「コードを書く」のところでアクセストークンやチャネルシークレットがどこにあるかを記載していませんでしたのでそれを補足します。
アクセストークン・チャンネルシークレットの場所
ではLINE Developersにアクセスしてください。右上のログインボタンを押して自分のアカウントにログインします。
*アカウントやプロバイダー、チャンネルを作成していない方や方法が分からない方は【入門用】PythonによるLINEbot作り方を参照して作成してください。
ログインできましたら作成したチャネル(botアカウント)をクリックし以下の場所を参照して下さい。*アクセストークンなどは発行ボタンで発行する場合があります。
アクセストークン:Messaging api - Channel access token(チャネルアクセストークン)
チャネルシークレット:Basic Settings(チャネル基本設定) - Channel secret(チャネルシークレット)
上記をメモしたら前回のconfig.pyに記入してください。
2.動作準備
では前回のコードを動かしていきましょう!
説明を始める前に前回、ngrokの事についてはあまり触れませんでしたが今回は少しだけ触れていきます。
ngrokとはローカルのWebサイトや今回使用するWebアプリケーションなどを外部に公開することができるシステムです。通常はポート開放などを行いローカル環境を外部に公開しますが、セキュリティの問題から使用するには抵抗があります。またドメイン関連の作業が有るので面倒です(ここら辺はあんまり知らないのでどんな面倒さがあるのかわかりません)。しかしngrokはこれらの面倒さを肩代わりしてくれるほか、セキュリティについても短期間であれば問題無いものになっています(勿論、絶対とは言い切れません)。ngrokのインストールなどについては前回の記事を参照してください。
コードの始動
下図のようにRaspberry piをSSHを用いてVscodeで作業できる状態にしています。1
今下図のように前回書いたapp.pyを表示しておりディレクトリ構成も前回と同じものにしています。2
vscodeは沢山の拡張機能がありますので便利なものを入れておきましょう!3
ターミナルを起動したら(上図の下側)実行コマンドを打ちましょう!Vscodeの拡張機能PylanceならRunのボタン(上図の右上の三角▷ボタン)で実行できます。
実行すると上図のようになります。もしここでエラーが出た場合はFlaskなどのインストールや環境設定に問題がありますのでその辺を調べて直してみてください。
これでコードの始動は完了です。
ngrokの始動
次にngrokを始動させていきます。
上のコードを始動させているターミナルとは別の新しいターミナルを開いて下さい。下の印をつけた+マークで開くことができます。
ではターミナルに下記のコマンドを入れます。
ngrok http 8080
このコマンドはローカルの8080ポートを外部に公開・共有するという意味です。app.pyでは最後にポートを8080に指定していましたのでコマンドでも辻褄を合わせるために8080と入力しています。
コマンドを実行すると
となります。
もしエラーがあった場合はngrokのインストール関連で問題があると思いますので前回の記事をみて再度構築してみてください。
いまngrokの始動画面にあるhttpsから始まり、.ioまでのURLをコピーしてください。
注意:httpから始まるURLもありますがLINE側でhttpsしか対応していません。
これでRaspberry pi側(サーバー側)での操作は終了です。
LINE messaging apiの設定
次に上記動作を実際にbotに適応させる操作をしていきます。まずはLINE Developersにログインして自分のチャネル(botアカウント)の設定を開きます。その中のMessaging apiタブを選択して、下のようにWebhookのWebhook URLを編集していきます。
注意:Webhookの利用がオフの場合はオンにしてから編集してください
先ほどコピーしたhttpsから始まるアドレスをここに記入します。そして最後の.ioの後に必ず/callback
を入れてください。
今回は下のように記入しました。
更新又は設定ボタンを押してください。その後検証ボタンを押して、下のような画面が出れば大丈夫です!
このとき、/callback
をつけていないと別のエラー表示が出ます。
では検証した時のRaspberry piのターミナルも見ていきましょう。
下のようになっていました。
もし、python側でInvalid signature. Please check your channel access token/channel secret.
が出ている場合はチャネルシークレットやアクセストークンが間違っている場合があります。またngrok側でもBAD RequestやNot Foundなどが表示されていたらcallbackの付け忘れかチャネルシークレット、アクセストークンの間違いなどがあるかもしれませんので記事を読み直して再度編集してみてください。
停止・再起動時の注意
ngrokのURLは一人一人違います、さらにngrokを起動するたびに変化しますのでngrokを停止して再度起動した場合は上記操作を再度行う必要があります。4 プログラムを変えて続けて使用する場合はngrokは停止せず、app.pyのみを停止するようにしましょう。5
これでLINE側の操作も終了です。動作確認をしてみましょう!
#3.動作検証
ではLINEに移り、自分の作成したbotと会話できるようにしましょう!会話をするには友達登録が必要です、LINE Developers>チャネル(botアカウント)>Messaging apiのQRコードやIDから友達登録できます。
会話を開き何か文字を打ち込んでみてください。
出来ましたね。**現時点でbotはどんな言葉に対しても「こんにちは」しか言えないです。**これでは会話とは言えませんね。今回の目的は会話をするのと会話からRaspberry piを操作するような応用を目的としています。では改良を考えていきましょう!
4.ちょっと改良(応用を探る)
まずは会話を成り立たせることから始めます。
前回説明した中で下のコードをうまく使用できれば会話できるとお話ししました。
def selectwords(commandtext): # 対応する言葉を選択
reply = "こんにちは"
return reply
おさらいしておきますと引数のcommandtextに、送られてくるメッセージが入っています。
ではこの引数を使用して条件分岐を作成してあげれば会話のまねのようなものができます。
そこで下のように書き換えてみました。6
def selectwords(commandtext): # 対応する言葉を選択
if commandtext == "おはよう":
reply = "おはようございます!"
elif commandtext == "こんにちは":
reply = "こんにちは"
elif commandtext == "こんばんは":
reply = "こんばんは"
else:
reply = "分からない単語です。"
return reply
ではプログラムのみを停止・再起動します。LINEで改めて会話してみると
会話っぽいですね。「こんばんは」と「おはよう」については会話が成立しています。しかし「ごはん」では単語の条件分岐を作成しておらずうまく会話ができません。では「ごはん」についての条件分岐を作成すればよいのではないかと思うかもしれませんがそのように、単語一つ一つ条件分岐を作成していたらコードも大変多くなり、カッコ悪くなります。
#5.応用に向けてアプローチ方法を探る
そこで、別ファイルに会話パターンを記録しその会話パターンを読み込ませて会話するという方式を取ります。この方法を取る利点は次の通りです。
- プログラムをコンパクトにできる
- 同じような動作をする場合はまとめることができる
- プログラムの動作を止めなくても外部データを変更するだけで会話パターンを変更できる
- 会話に伴う追加情報を付加できる
上記の様に更なる応用を図ろうとした時にその応用機能を導入しやすくできます。また会話パターンを記録するファイル形式にもこだわります。ファイル形式はCSVです。表形式にする事で可視性とプログラムを書きやすくできます。前回作成したディレクトリ構成の中にactiondata.csvを活用していきます!
この後の詳細は次回にしますが上記をまとめると下のような概要図になります。
次回以降になりますが、Raspberry piの特徴でもある多彩な外部インターフェースや他のAPIを合わせて使用することもやっていきます。
6.まとめ
これでPart2は終了です。いかがだったでしょうか?理論的な話を踏まえて進めていきましたのでプログラムの方はあまり進んでいませんが、理論はだいぶ詰めましたので次回からはバリバリ書いていきます。次の記事投稿はいつになるかわかりませんが私の大学の講義と課外活動、就活が落ち着いてからになるかもです。
前回と同様に質問などありましたらコメント欄によろしくお願いします。時間がある時に回答いたします。
では!
続編出しました! > LINE Messaging API+Ngrok+Python で実験的にLINEボットを開発してみよう Part3会話盛りだくさん編
参考資料
- Part1
- 【入門用】PythonによるLINEbot作り方 < とても参考にさせていただきました
- Raspberry Pi】ngrokのインストールからローカル環境の公開まで
- Messaging APIを始めよう
- LINE Developers