PythonでLINEBotはじめました（冷やし中華的な）【後編】

前回の続きのエントリーとなります。 今回は前回作成したプログラムをHerokuに移行することを目指します。

更新がかなり遅れたのですが、ずーっと悩んでいましたが原因がやっとわかったので更新となります。 自分の開発環境のみでの話だと思いますので、それについての記載の必要はなさそうです。

【前回のエントリー】 uepon.hatenadiary.com

Herokuとは？

jp.heroku.com

HerokuはWikipediaによれば

Heroku - Wikipedia

Heroku（へろく）は2007年創業のアメリカ合衆国の企業。また、同社が開発と運営を行っているPaaSの名称でもある。

初期はRubyによるウェブアプリケーションフレームワークRuby on Railsのみのサポートであったが、Java、Node.js、Scala、Clojure、Python、PHP、Goなど複数のプログラミング言語をサポートするようになった。

かなり大雑把にいうなら、Herokuを使用すると開発したWEBアプリケーションを簡単に公開することができます。（※自分は慣れていないので少し苦労しました）

今回はこのHerokuを使用して前回作成したLINEBotを公開します。

Herokuを使用するための準備

まずは、Herokuを使用するための準備を行います。以前は、Heroku Toolbeltというアプリケーションを使用してHerokuへデプロイを行っていましたが、現在はHeroku CLIという名前になっています。

まずダウンロードしてみましょう。Herokuにアクセスを行います。ユーザアカウントがなければここで作成を行います。今回はこの部分は事前に行われている前提で話を進めていきます。

画面の右上に【ログイン】ボタンがありますのでクリックしてログインを行います。 ユーザIDとパスワードを入力して【Log In】ボタンをクリックすればOKです。

すると以下のような画面に遷移します。画面中に使用するサービスに使用する言語が表示されているのがわかるかと思います。

拡大すると以下の様になっています。今回はpythonを選択します。

pythonをクリックすると画面が以下のように遷移します。開発に必要なもののが表示されます。

必要となるものは以下のように書いてありますが

• Herokuのフリーアカウントの準備
• ローカルの環境にPython version 3.6のインストール（OSはOS X、 Windows、Linux）
• ローカルの環境にPipenvのインストール
• ローカルの環境にPostgresのインストール

ここで記載されているものは、以降のチュートリアルを行うために必要な環境なので、そのまま作業を進めても大丈夫です。 画面下部にある【I'm readly to start】ボタンをクリックします。

画面表示が以下のようになるので画面内にある

以下のボタン部分をクリックします。

するとローカル側のOSを選択するプルダウンが開くので

自分の環境にあったOSを選択します。今回使用している環境はWindows 64bitだったので【Windows 64】を選択します。するとプルダウンの部分が選択したOSになります。

選択前【Download the Heroku CLI for …】

選択後【Download the Heroku CLI for Windows 64】

OSの選択後に表示が変更された【Download…】のボタンをクリックするとHeroku CLIのインストーラーがダウンロードされます。Windows 64bitでは以下のようなファイルがダウンロード出来ます。

このインストーラーを起動すると、インストールを行うコンポーネントの選択になります。このインストーラではHeroku CLI、環境変数のPATHセット、Gitのインストールを行ってくれます。

今回はそのまますべてインストールします。（Gitのインストールに関しては行うかどうかを決めたほうがいいかと思います。今回テストした環境ではGitのバージョンが2.8.1よりも低かったこともあり、一度Gitのアンインストールを行ってからインストールをしています。）

【Next >】ボタンをクリックしてインストールを進めます。

すると次はHeroku CLIのインストールパスの設定になります。基本的にはそのままで大丈夫だと思いますので【Install】ボタンをクリックします。

プログレスバーが動きインストールが徐々に行われていきます。

途中でGitのSetupのダイアログが表示されます。まずはライセンスの同意画面が表示されますので、確認後【Next >】ボタンをクリックします。

続いてはGitのインストールパスに関してですが、そのままで大丈夫だと思いますので、確認後【Next >】ボタンをクリックします。

次はGitのインストールコンポーネントの選択になります。ショートカットアイコンをデスクトップに作るかとか、Explorerの右クリックメニューでGit Bashを表示するか、.gitや.shの拡張子の関連付けするか、表示にTureTypeフォントを使用するかなどが聞かれています。インストール後でも変更はできるので、自分下記の様に選択してみました。

【Next >】ボタンをクリックします。

Windowsのスタートメニューの表記もそのままで良いので【Next >】ボタンをクリックします。

まだまだ続きます。次はGitのPATH設定です。Git Bashからしか使用しないか、cmd.exeから使用するか、はたcmd.exe上から違うUnixツールを使用して使うかという感じです。Git Bashからでいいような気もしますが、ここはUse Git from the Windows Command Promptを選択しました。（cmd.exeからの使用）

選択したら、【Next >】ボタンをクリックします。

次は改行コードの設定になります。 checkoutの改行コードとcommit時の改行コードを選択することになりますが、 このあたりは好きに選んで頂いたほうがいいのかなと思います。 個人的にはcommitはUnix-styleが良いかと思いますので、Checkout Windows-style, commit Unix-style line encodingsを選択しました。

選択したら、【Next >】ボタンをクリックします。

次はGit Bashのターミナル設定になりますがそのままにしました。

選択したら、【Next >】ボタンをクリックします。

最後は追加機能になりますが、これもそのままインストールすることにしました。

選択したら、【Install】ボタンをクリックします。

これでインストール処理が進んで行きます。インストーラーのほとんどがGitなのでGitインストールを行わなければここまで面倒な選択にはならないと思います。（この点はOS XとLinuxは羨ましいです。）

プログレスバーが100％になったらGitのインストールは完了です。【Finish】ボタンをクリックします。今、完了したのはあくまでもGitのインストールです。本当に必要なのはこのあとインストールされるHeroku CLIになります。

Heroku CLIのインストールのプログレスバーが100%なったら処理は完了です。以下の様な画面になったら【Close】ボタンをクリックして、インストーラーを終了させます。

インストール後はスタートメニューからGitをグループを検索してその中からGit CMDを選択して実行を行います。

Git CMDが起動するので実際にGitコマンドを実行してバージョンを確認してみました。

C:\>git --version
git version 2.8.1.windows.1

インストールを行ったVersion 2.8.1がインストールされていることがわかります。

続いてHeroku CLIのコマンドを実行してみます。Heroku CLIをダウンロードしたブラウザに戻るとHerokuへログインするコマンドを叩いてみてねというメッセージがあるので、これに従ってCLI経由でログインをしてみます。

コンソール上（Git CMD）から以下の様に実行してみます。*の部分は自分のアカウントに合わせてください。

(base) C:\src > heroku login
Enter your Heroku credentials:
Email: *********@*********
Password: **************
Logged in as *********@*********

Herokuへログインができ、Heroku CLIのインストールも無事に完了したことがわかりました。

インストールが終わったのでようやくHerokuへLINEbotをデプロイする作業になります。

HerokuへLINEBotをデプロイする

以下のエントリーがわかりやすかったです。参考にさせていただきました。

【参考】 qiita.com

設定ファイルの作成

Herokuでの実行環境の設定ファイルを可能であればローカルに合わせるためにローカル実行環境のバージョンを事前に調べて、設定ファイルを作成します。

(base) C:\src> python --version
Python 3.6.4 :: Anaconda, Inc.

(base) C:\src> pip freeze
alabaster==0.7.10
（中略）
Flask==0.12.2
（中略）
line-bot-sdk==1.6.0
（中略）
zict==0.1.3

作成するファイルは、

• runtime.txt(Pythonのバージョンを記載)
• requirements.txt(依存するライブラリの記載)
• Procfile(プログラムの実行方法を定義)

あとはもちろん

• main.py(アプリケーションのプログラム)

となります。

.gitignoreもあってもいいかなと思いますが、今回は最小単位での実行なので割愛しています。

runtime.txt(Pythonのバージョンを記載)

python-3.6.4

requirements.txt(依存するライブラリの記載)

Flask==0.12.2
line-bot-sdk==1.6.0

Procfile(プログラムの実行方法を定義)

web: python main.py

main.py(アプリケーションのプログラム)

from flask import Flask, request, abort
import os

from linebot import (
    LineBotApi, WebhookHandler
)
from linebot.exceptions import (
    InvalidSignatureError
)
from linebot.models import (
    MessageEvent, TextMessage, TextSendMessage,
)

app = Flask(__name__)

#環境変数取得
YOUR_CHANNEL_ACCESS_TOKEN = os.environ["YOUR_CHANNEL_ACCESS_TOKEN"]
YOUR_CHANNEL_SECRET = os.environ["YOUR_CHANNEL_SECRET"]

line_bot_api = LineBotApi(YOUR_CHANNEL_ACCESS_TOKEN)
handler = WebhookHandler(YOUR_CHANNEL_SECRET)

@app.route("/")
def hello_world():
    return "hello world!"

@app.route("/callback", methods=['POST'])
def callback():
    # get X-Line-Signature header value
    signature = request.headers['X-Line-Signature']

    # get request body as text
    body = request.get_data(as_text=True)
    app.logger.info("Request body: " + body)

    # handle webhook body
    try:
        handler.handle(body, signature)
    except InvalidSignatureError:
        abort(400)

    return 'OK'

@handler.add(MessageEvent, message=TextMessage)
def handle_message(event):
    line_bot_api.reply_message(
        event.reply_token,
        TextSendMessage(text=event.message.text))

if __name__ == "__main__":
#    app.run()
    port = int(os.getenv("PORT"))
    app.run(host="0.0.0.0", port=port)

これまでのファイルを作成するとディレクトリ構造は以下の様な感じになると思います。

(base) C:\linebot>dir
 ドライブ C のボリューム ラベルがありません。
 ボリューム シリアル番号は 9EF6-06E5 です

 C:\linebot のディレクトリ

2018/07/26  21:22    <DIR>          .
2018/07/26  21:22    <DIR>          ..
2018/07/26  08:53             1,641 main.py
2018/07/25  07:45                19 Procfile
2018/07/25  07:45                34 requirements.txt
2018/07/25  07:44                12 runtime.txt
               4 個のファイル               1,706 バイト
               2 個のディレクトリ  223,239,733,248 バイトの空き領域```

Herokuへデプロイするアプリケーションの設定

Herokuにデプロイするアプリケーションの作成と、アプリケーション内部で使用している環境変数を設定します。

(base) C:\linebot> heroku create 【アプリケーション名】
(base) C:\linebot> heroku config:set YOUR_CHANNEL_ACCESS_TOKEN="【LineDevelopersのChannelの設定ページで表示されたAccessトークン】" --app 【アプリケーション名】
(base) C:\linebot> heroku config:set YOUR_CHANNEL_SECRET="【LineDevelopersのChannelの設定ページで表示されたSECRET】" --app 【アプリケーション名】

設定をした【アプリケーション名】を使用して、Webアクセスをしたときのエンドポイントがhttps://【アプリケーション名】.herokuapp.com/になります。

これで設定できました。環境変数がセットされたかは以下のコマンドで確認ができます。

heroku config --app uepon-linebot

例えば、【アプリケーション名】をuepon-linebotとした場合には以下のような実行結果となります。

(base) C:\linebot>heroku create uepon-linebot
Creating ⬢ uepon-linebot... done
https://uepon-linebot.herokuapp.com/ | https://git.heroku.com/uepon-linebot.git

(base) C:\linebot>heroku config:set YOUR_CHANNEL_ACCESS_TOKEN="【LineDevelopersのChannelの設定ページで表示されたAccessトークン】" --app uepon-linebot
Setting YOUR_CHANNEL_ACCESS_TOKEN and restarting ⬢ uepon-linebot... done, v3
YOUR_CHANNEL_ACCESS_TOKEN: 【LineDevelopersのChannelの設定ページで表示されたAccessトークン】
(base) C:\linebot>heroku config:set YOUR_CHANNEL_SECRET="【LineDevelopersのChannelの設定ページで表示されたSECRET】" --app uepon-linebot
Setting YOUR_CHANNEL_SECRET and restarting ⬢ uepon-linebot... done, v4
YOUR_CHANNEL_SECRET: 【LineDevelopersのChannelの設定ページで表示されたSECRET】

(base) C:\linebot>heroku config --app uepon-linebot
=== uepon-linebot Config Vars
YOUR_CHANNEL_ACCESS_TOKEN: 【LineDevelopersのChannelの設定ページで表示されたAccessトークン】
YOUR_CHANNEL_SECRET:  【LineDevelopersのChannelの設定ページで表示されたSECRET】

【実行のようす】

Herokuへデプロイする

アプリケーションの作成と設定が終わったらGitを使用してデプロイを行います。 以下の様に実行していけばいいのですが・・・

(base) C:\src> git init
(base) C:\src> git add .
(base) C:\src> git commit -m "first commit"
(base) C:\src> git push heroku master

注意点1

実行していくと途中、（gitの初回使用の場合だと思いますが）コマンドラインでメールアドレスとユーザーネームを尋ねられてしまうことがあるので、その場合には下記のようにgit configで登録を行ってください。

【エラーの表示】

(base) C:\linebot> git commit -m "first commit"

*** Please tell me who you are.

Run

  git config --global user.email "you@example.com"
  git config --global user.name "Your Name"

to set your account's default identity.
Omit --global to set the identity only in this repository.

fatal: unable to auto-detect email address (got '*****@*******.(none)')

以下のコマンドを自分の設定に合わせて行います。

(base) C:\linebot> git config --global user.email "【メールアドレス】"
(base) C:\linebot> git config --global user.name "【名前】"

注意点2

git push heroku masterを行ったときに以下の様なエラーが出た場合には

【エラーの表示】

(base) C:\linebot>git push heroku master
fatal: 'heroku' does not appear to be a git repository
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

こちらのエントリーを参考にして

【参考】 qiita.com

下記の様にコマンドを実行します。（このコマンドで.git/configにリモートリポジトリの設定が追加されます）

(base) C:\linebot>git remote add heroku https://git.heroku.com/【アプリケーション名】.git

その後、git push heroku masterするとエラーは発生せず実行が行われます。

(base) C:\linebot>git push heroku master
Counting objects: 10, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (6/6), done.
Writing objects: 100% (10/10), 2.75 KiB | 0 bytes/s, done.
Total 10 (delta 1), reused 0 (delta 0)
remote: Compressing source files... done.
remote: Building source:
remote:
remote: -----> Python app detected
remote:  !     The latest version of Python 3.6 is python-3.6.6 (you are using python-3.6.4, which is unsupported).
remote:  !     We recommend upgrading by specifying the latest version (python-3.6.6).
remote:        Learn More: https://devcenter.heroku.com/articles/python-runtimes
remote: -----> Installing python-3.6.4
remote: -----> Installing pip
remote: -----> Installing requirements with pip
remote:        Collecting Flask==0.12.2 (from -r /tmp/build_6689ac1a6741420f3d4f4c7f8da40fe8/requirements.txt (line 1))
remote:          Downloading https://files.pythonhosted.org/packages/77/32/e3597cb19ffffe724ad4bf0beca4153419918e7fa4ba6a34b04ee4da3371/Flask-0.12.2-py2.py3-none-any.whl (83kB)
remote:        Collecting line-bot-sdk==1.6.0 (from -r /tmp/build_6689ac1a6741420f3d4f4c7f8da40fe8/requirements.txt (line 2))
remote:          Downloading https://files.pythonhosted.org/packages/17/f7/6babf86d300cd98671c94a695c72b961ce6eb26ccb46a2eabe53edc181e4/line_bot_sdk-1.6.0-py2.py3-none-any.whl
（中略）
remote: -----> Discovering process types
remote:        Procfile declares types -> web
remote:
remote: -----> Compressing...
remote:        Done: 44.6M
remote: -----> Launching...
remote:        Released v3
remote:        https://uepon-echo-linebot.herokuapp.com/ deployed to Heroku
remote:
remote: Verifying deploy... done.
To https://git.heroku.com/uepon-echo-linebot.git
 * [new branch]      master -> master

念の為、先程【アプリケーション名】をuepon-linebotとした場合には以下のような実行結果となります。

(base) C:\linebot>git init
Initialized empty Git repository in C:/linebot/.git/

(base) C:\linebot>git add .

(base) C:\linebot>git commit -m "first commit"
[master (root-commit) 66e2d01] first commit
 4 files changed, 61 insertions(+)
 create mode 100644 Procfile
 create mode 100644 main.py
 create mode 100644 requirements.txt
 create mode 100644 runtime.txt

(base) C:\linebot>git remote add heroku https://git.heroku.com/uepon-linebot.git

(base) C:\linebot>git push heroku master
Counting objects: 6, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (6/6), 1.23 KiB | 0 bytes/s, done.
Total 6 (delta 0), reused 0 (delta 0)
remote: Compressing source files... done.
remote: Building source:
remote:
remote: -----> Python app detected
remote:  !     The latest version of Python 3.6 is python-3.6.6 (you are using python-3.6.4, which is unsupported).
remote:  !     We recommend upgrading by specifying the latest version (python-3.6.6).
remote:        Learn More: https://devcenter.heroku.com/articles/python-runtimes
remote: -----> Installing python-3.6.4
remote: -----> Installing pip
remote: -----> Installing requirements with pip
remote:        Collecting Flask==0.12.2 (from -r /tmp/build_75a6e194f23fb5b2bfc239b6b8f891b7/requirements.txt (line 1))
remote:          Downloading https://files.pythonhosted.org/packages/77/32/e3597cb19ffffe724ad4bf0beca4153419918e7fa4ba6a34b04ee4da3371/Flask-0.12.2-py2.py3-none-any.whl (83kB)
remote:        Collecting line-bot-sdk==1.6.0 (from -r /tmp/build_75a6e194f23fb5b2bfc239b6b8f891b7/requirements.txt (line 2))
remote:          Downloading https://files.pythonhosted.org/packages/17/f7/6babf86d300cd98671c94a695c72b961ce6eb26ccb46a2eabe53edc181e4/line_bot_sdk-1.6.0-py2.py3-none-any.whl
（中略）
remote:        Successfully installed Flask-0.12.2 Jinja2-2.10 MarkupSafe-1.0 Werkzeug-0.14.1 certifi-2018.4.16 chardet-3.0.4 click-6.7 future-0.16.0 idna-2.7 itsdangerous-0.24 line-bot-sdk-1.6.0 requests-2.19.1 urllib3-1.23
remote:
remote: -----> Discovering process types
remote:        Procfile declares types -> web
remote:
remote: -----> Compressing...
remote:        Done: 44.6M
remote: -----> Launching...
remote:        Released v5
remote:        https://uepon-linebot.herokuapp.com/ deployed to Heroku
remote:
remote: Verifying deploy... done.
To https://git.heroku.com/uepon-linebot.git
 * [new branch]      master -> master

実行環境の設定

念の為、実行時の環境変数とHerokuの実行環境のワーカープロセスの設定を行います。

(base) C:\src> heroku ps:scale web=1

テスト

(base) C:\src> heroku open

これでHelloWorldが表示されれば、作業は成功しています。

Herokuのダッシュボードも念の為確認してみると、問題なくデプロイされているのがわかります。

LINE側の設定

ここまできたらあとはLINE側のChannel設定のエンドポイントをHerokuでデプロイしたリンクに変更します。あと一歩です。

まずはLineDevelopersのページにアクセスし、画面の右上にある【ログイン】ボタンをクリックしてログインを行います。

メールアドレスとパスワードでログインを行います。それぞれ入力を行って【ログイン】ボタンをクリックします。

ログインを行うと作成しているプロバイダーリストが表示さえるので設定するプロバイダーを選択します。以前作成したプロバイダーは【Mashup名古屋】だったのでそれをクリックします。

続いて、プロバイダー内にあるChannelを選択します。前回作成したbotは【MashupNagoyaEcho】という名前でしたのでそれをクリックします。

チャンネル基本設定の画面になるので画面をスクロールさせて

【メッセージ送受信設定】の項目までいきます。その中にあるエンドポイントの設定、つまり【Webhook URL】をHerokuのアプリケーションのURLに変更します。【編集ボタン】をクリックしてURLを編集します。 すでにhttps://は書かれているのでそれ以降のURLを記載します。先程Herokuにデプロイしたアプリ名はuepon-linebot でしたので、この場合uepon-linebot/callbackを入力します。入力後は【更新】ボタンをクリックします。

これで設定完了です。普通であればここで【接続確認】のボタンをクリックして接続テストするのですが…

何故かエラー…泣けますが、とりあえずこのまま進めていきます。

ではスマートフォン側のLineアプリでBotに対してメッセージを送信してみましよう。エラーがでているのでクソ不安ですが。すでに友だち登録はしているので呼び出しはすぐにできるかと思います。接続テストはNGでしたが、うまく動作しているようです。

念の為、Herokuのアクセスログも確認してみます。

(base) C:\linebot> heroku logs

実行もうまく行えているのが確認できました。（接続テストのエラーがよくわかってないですが…）

おわりに

今回のエントリーで書いている間によくわからないトラブルがあってうまく行かなかったのですが、ようやくエントリーも書き終えました。これで…

www.line-community.me

へのファーストステップが迎えられたかなと思います。 みなさんもいいBotライフを！

【参考】

uepon.hatenadiary.com

このブログもHTTPS化しました

このブログもHTTPS配信の設定に変更しました。過去のエントリーでも若干HTTPの混在状態になっていますが、ほとんどが画像やリンクという感じでしたので、更新は諦めました。（具体的にはリンク先のプレビュー表示が抜けていますが、リンクをクリックすれば、問題なく表示されていますので実害はないかなと思います）

あと今まで使用していたテーマの一部がHTTPSに対応していなかったので別のテーマに変更しました。（CSS全くわからない…のでかなりあっさりしています。）

引き続きよろしくお願いいたします。

PythonでLINEBotはじめました（冷やし中華的な）【前編】

PythonでLINEBotはじめました（冷やし中華的な）【前編】

ずっと前からハッカソンでLINEbotとか使いたかったけど、手をだせなかったので今更ながらはじめましたあくまでも簡単な練習としてEcho的なBotを作成しています。今回はHerokuへデプロイをするつもりでしたが、ボリュームが多くなってしまったので前後編としました。 今回のエントリーは前編として、ローカル環境でのbot作成までを行ってみています。

今回はpythonとFlaskを使ってbotを作成しています。

今回のエントリーでは以下の2つを参考させていただいています。本当にありがとうございます。

【参考1】

qiita.com

【参考2】

qiita.com

Botを作成する。

まずはLINEのデベロッパーコンソールにログインしてBotの基本部分を作成していきます。

最初にLINE developersにアクセスするところからスタートです。アクセスすると以下の様な画面になります。

画面中の【MessagingAPI（ボット）をはじめる】ボタンをクリックします。

ログインを促されます。（すでにログインしている場合には出ないかもしれません）開発しようと考えている人がユーザー登録してないとは思いにくいのでこの部分の手順に関しては省略しますがこのあたりを参考してもらえればいいのかなと思います。

ユーザ登録をしている人はそのまま【ログイン】ボタンをクリックしてください。

続いては画面左の【新規プロバイダー】を作成します。すでに実験などをしている場合にはプロバイダーやチャンネルが作成されていると思いますが、今回はそれとは別でそれらを作成していきます。（全くの新規の場合は少し画面が違うかもしれません）

ログイン後このような画面に遷移すると思いますので画面の左側の【新規プロバイダー作成】のボタンをクリックします。すると以下のような画面になります。

新規プロバイダーの名前の登録になります。わかりやすいものがいいとは思いますので、今回は【Mashup名古屋】というプロバイダーを作成してみることにしました。入力が終わったら確認ボタンをクリックします。

クリックすると確認画面が表示されますので、間違いなければ再度【作成ボタン】をクリックします。

クリックするとプロバイダーが作成されプロバイダー一覧にも表示されるようになります。

プロバイダー名の隣にある歯車のアイコンをクリックすればプロバイダーの管理画面に入れます。名前の変更や削除も可能です。

では、続いて【Messaging API】ボタンをクリックします。

次の処理は【新規channel作成】となります。

画面全体は以下のようになっています。

Messaging APIの情報を入力する項目は以下の情報となります。

• アイコン
• アプリ名（※アプリ名を設定した後、7日間は変更できません。）
• アプリ説明
• プラン（【Developer Trial】と【フリー】からの選択）
• 大業種（選択式）
• 小業種（選択式）
• メールアドレス

アプリ名の変更が7日間できないのでここは厳しいかも？（ぬるいブログのサンプルだったら全く問題ありませんけど） あと、プランに2つから選択になりますが、画面内の説明にある通り

Developer Trial
MessagingAPIを利用したBotを試すプランです。友だちとメッセージの送受信を行うことができます。 ※追加可能友だち数は50人に制限されています。また、Developer Trialからプランの切り替えやプレミアムIDの購入はできません。

---

フリー
MessagingAPIを利用したBotを開発するプランです。友だちの人数に制限はありませんが、Push messagesを利用してBotから友だちにメッセージを送信することはできません。 ※サービス拡張に向けプラン変更が可能です。

このように説明されていました。開発のテストであれば間違いなく【Developer Trial】を選択すればいいかなと思います。まあ、LINEの友達も50人もいませんけどｗ。

今回はこんな感じで設定してみました。入力が終わったら画面下にある【確認】ボタンをクリックします。

【確認】ボタンをクリックすると情報利用に関する同意が求められるのでよく読んで問題なければ【同意】ボタンをクリックしてください。（よっぽどおかしいことは書いていないと思いますが…）

【同意】ボタンのクリックで確認のダイアログが閉じて規約同意の確認画面に遷移します。

あとは利用規約部分にチェックを行い【作成】ボタンをクリックします。

無事にチャンネルが作成されました。

ですが新しいチャンネルはまだ設定が完了していないようです。ただ、まだ入力できない情報もあるので今はまだ設定が完了していいないことだけ覚えておくことにします。

botのソースコードの準備

今回のbot用のサンプルコードの準備をします。サンプル用のコードは公式側からGithubで公開されていますのでこれを使用します。このサンプルコードは文字列を受信して同じものを返す機能になっています。（Echo的なものです）

github.com

今回はpythonを出しましたが他にも以下のような言語があるようです。

• PHP
• Go
• Perl
• Ruby
• Python
• Node.js

注意点はEchoのサンプルコードのファイルはREADME.rst（ドキュメント）に入っているので単純にGit Cloneしても見当たらないので覚えておいてください。

ドキュメントにあるソースコードを貼ってろうと思ったのですがいろいろどうだろうかというところもあるので少しコードを変更しています。

【main.py】

from flask import Flask, request, abort
#環境変数取得用
import os

from linebot import (
    LineBotApi, WebhookHandler
)
from linebot.exceptions import (
    InvalidSignatureError
)
from linebot.models import (
    MessageEvent, TextMessage, TextSendMessage,
)

app = Flask(__name__)

# オリジナルの処理
# line_bot_api = LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
# handler = WebhookHandler('YOUR_CHANNEL_SECRET')

#環境変数取得
YOUR_CHANNEL_ACCESS_TOKEN = os.environ["YOUR_CHANNEL_ACCESS_TOKEN"]
YOUR_CHANNEL_SECRET = os.environ["YOUR_CHANNEL_SECRET"]

line_bot_api = LineBotApi(YOUR_CHANNEL_ACCESS_TOKEN)
handler = WebhookHandler(YOUR_CHANNEL_SECRET)

@app.route("/")
def hello_world():
    return "hello world!"

@app.route("/callback", methods=['POST'])
def callback():
    # get X-Line-Signature header value
    signature = request.headers['X-Line-Signature']

    # get request body as text
    body = request.get_data(as_text=True)
    app.logger.info("Request body: " + body)

    # handle webhook body
    try:
        handler.handle(body, signature)
    except InvalidSignatureError:
        abort(400)

    return 'OK'


@handler.add(MessageEvent, message=TextMessage)
def handle_message(event):
    line_bot_api.reply_message(
        event.reply_token,
        TextSendMessage(text=event.message.text))


if __name__ == "__main__":
    app.run()

サンプルではFlask、requestを使用する必要あるのがわかります。requestはHTTP関連でお馴染みのモジュールですが、Flaskはウェブアプリケーション用のマイクロフレームワークになります。

Welcome | Flask (A Python Microframework)

github.com

Djangoに似たような機能を持つもののようです。PCにAnacondaをインストールしているのですがpip freezeコマンドでもインストールされていました。RaspberryPi側でも確認しましたがインストールされていました（pip,pip3ともに）。

とはいっても今回は最終的にはHerokuホスティングしてもらうのでインストールに関してはHeroku側で行う必要があります。

また、コード内を眺めてみるとYOUR_CHANNEL_ACCESS_TOKENとYOUR_CHANNEL_SECRETが必要になりますが、Messaging APIの設定から取得できるので後から取得します。その際もHeroku側の環境変数として設定するのが一般的のようですがさんぷるのコードでは直接代入しているではないですか！ その部分をあわせるためにYOUR_CHANNEL_ACCESS_TOKENとYOUR_CHANNEL_SECRETを環境変数から読み込むようにコードを変更してあります。

【オリジナル】

line_bot_api = LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
handler = WebhookHandler('YOUR_CHANNEL_SECRET')

↓ 【変更後】

#環境変数取得用
import os

…（中略）…

#環境変数取得
YOUR_CHANNEL_ACCESS_TOKEN = os.environ["YOUR_CHANNEL_ACCESS_TOKEN"]
YOUR_CHANNEL_SECRET = os.environ["YOUR_CHANNEL_SECRET"]

line_bot_api = LineBotApi(YOUR_CHANNEL_ACCESS_TOKEN)
handler = WebhookHandler(YOUR_CHANNEL_SECRET)

あと、テスト用にルートアクセスをしたときにメッセージを表示するhello_worldも追加しました。

【追加部分】

@app.route("/")
def hello_world():
    return "hello world!"

続いてはHeroku側の設定としたいところですが、とりあえずはローカル環境で実行できるかを試してみます。

アクセスに必要なCHANNEL_ACCESS_TOKENとCHANNEL_SECRETの取得

デベロッパーコンソールに戻って実行に必要な``CHANNEL_ACCESS_TOKENとCHANNEL_SECRET```の取得します。

作成したBotの【設定が完了していません】をクリックするとChannel基本設定の画面に遷移します。

画面をスクロールさせると基本情報のカテゴリの中にCHANNEL_SECRETがあるのでメモしておきます。

さらに画面をスクロールさせると【メッセージ送受信設定】のカテゴリに``CHANNEL_ACCESS_TOKEN```があるので右にある【再発行】のボタンをクリックします。

クリックすると以下のようなダイアログが表示されますが、初回の場合は0時間で問題ないでしょう。再度【再発行】のボタンをクリックします。

以下のように表示が行われればOKです。これもメモしておきます。

ローカルでテストを行う

先程の手順で実行に必要な``CHANNEL_ACCESS_TOKENとCHANNEL_SECRET```の取得できたので、環境変数にセットしてローカルで実行してみます（ここではアクセスできるかになります）。

まずは、``CHANNEL_ACCESS_TOKENとCHANNEL_SECRETを環境変数にセットします。以下はAnacondaPrompt（Windows10のcmd環境）でセットしています。文字は＊伏せています。環境変数をsetコマンド（Linuxならばexport```）でセットしています。（Macはわかりませんｗ）

【WindowsなAnaconda環境】

(base) >set YOUR_CHANNEL_ACCESS_TOKEN=***************************************************************************************************************************************************************************************************************

(base) >set YOUR_CHANNEL_SECRET=***********************

【Linuxなど】

$ export YOUR_CHANNEL_ACCESS_TOKEN=***************************************************************************************************************************************************************************************************************

$ export YOUR_CHANNEL_SECRET=***********************

あとは先程のpythonのコードを実行します。（この実行仕方では失敗してます。正解は後述しますが、それ以外の工程に関してはそのままで大丈夫です。）

【間違えた実行方法】

(base) > python main.py

【（念の為）後述する正解の実行方法-WindowsなAnaconda環境】

> set FLASK_APP=main.py
> set FLASK_DEBUG=1
> flask run --host=0.0.0.0

デフォルトではポート5000番でサービスが開始されます。

実行したら、Webブラウザからアクセスしてみます。

HelloWorld!が表示されました。サンプルコードに追加したHelloWorldの処理が動作したことがわかります。

続いてはこれをインターネット経由でアクセスします。ルータの設定をするのは危険なので、ここでもおなじみのngrokを使用します。

【ngrokに関しては以下を参照】

ngrok.com

使い方に関しては過去のエントリーを参照してください。エントリーではRaspberryPiで使用していますが、WindowsやMacでも変わらないと思います。

uepon.hatenadiary.com

ngrokをダウンロードして任意の場所（パスの通ったところなど）にいれて以下の様に実行します。実行は別のcmdやコンソールからの実行となります。pythonプログラムとは異なるコンソールで実行してください。

> ngrok.exe http 5000

【2つのコンソールを開いての実行の様子】

実行すると以下のような画面になります。その中のForwardingのところにあるアドレスがサービスが公開されたURLとなっています。

それでは、このURLへブラウザからアクセスします。httpでも、httpsでもどちらでもアクセス出来ますが、今回はhttpsを使用しています。（botではhttpは使えませんのでご注意。）

ではこのURLをメモっておきます。これがBotのWebhook用のURLとなります。

では、デベロッパーコンソールに移動して、今回ngrokで取得したURLを設定します。 デベロッパーコンソールの画面に戻って、作成したBotの【設定が完了していません】のあたりをクリックします。

クリックすると、【Channel基本設定】画面に遷移します。

画面をスクロールさせて【メッセージ送受信設定】の項目の中から

【Webhook送信】の右側にある【ペン】のアイコンをクリックします。

表示されたラジオボタンで【利用する】に設定をして、【更新】ボタンをクリックします。

次に【Webhook URL】の右側にある【ペン】のアイコンをクリックします。

すると、入力ボックスが表示されるので、ここに先程ngrokで得られたURL（httpsのもの）を入力します。画面内の注意書きにもありますが、今回はhttpは使えませんのでご注意。 また、URLの末尾に/callbackをつけるのも忘れずに！

入力値が[任意の文字列].ngrok.com/callbackとなっていれば問題ありません。

入力が終わったら、更新ボタンを押して設定を完了させてください。 デベロッパーコンソールの画面に戻ると【設定が完了していません】の文字が消えています。

実行してみる

実行は一度このボットと友達になる必要があります。デベロッパーコンソールから今回作成したbotのアイコンをクリックすると、【Channel基本設定】画面に遷移します。 その画面の一番下の部分に友達設定用のQRコードが表示されているので、それを使用してLINEアプリから登録を行います。

QRコードで友だち追加の画面から、QRコードを読み込ませると以下のような画面になるので【追加】ボタンをタップします。

無事、友だち登録が完了しました。

【トーク】を開くと以下のようなウエルカムメッセージが届きます。

そして、いよいよ文字列を送信してみると…

あれ？Echoが帰ってきていない…アクセスログをみると200（正常）が帰ってきているので問題はなさそう…コードが違う？

いろいろとググったところFlaskでの実行では通常のpythonとは少し異なる実行方法が推奨されているようです。

【参照】

qiita.com

【WindowsなAnaconda環境】

> set FLASK_APP=main.py
> set FLASK_DEBUG=1
> flask run --host=0.0.0.0

【Linuxなど】

$ export FLASK_APP=main.py
$ export FLASK_DEBUG=1
$ flask run --host=0.0.0.0

ちなみにpythonのコードの最後の部分でapp.runの引数を以下の様に変更すると

【変更前】

if __name__ == '__main__':
    app.run()

【変更後】

if __name__ == '__main__':
    app.run(debug=False, host='0.0.0.0', port=5000)

環境変数を使用せず、そのままflask runとさせることが出来るようです。

あえて実験しましたが、環境変数をセットしておけば以前のようにpythonからアプリを実行しても問題はなさそうです。

(base)  >python main.py

【スマートフォン側実行画面】

【コンソール側実行画面】

スマートフォン側の実行では、途中なんか変なメッセージがでているのですが…

ぐぐってみるとこのメッセージは自動応答系のメッセージのようです。LineデベロッパーコンソールでこれをOFFすると表示されないようですので設定をしてみます。 以下の画面から作成したアプリをクリックして

【Channel基本設定】の画面に入ります。

画面をスクロールさせていくと【LINE@機能の利用】の項目があると思います。 現在の設定は以下のようになっていると思います。

このなかで【自動応答メッセージ】がONになっているので、毎回メッセージが表示されています。これをOFFすることにします。項目の右側にある【ペン】アイコンをクリックして

ラジオボタンの「利用しない」を選択して【更新】ボタンをクリックします。

以下のようになっていればOKです。

では、改めてLINEでテストで実行してみます。

実行に成功しました。

おわりに

今回も長くなってしまったのでローカルでのテストができたので前半戦は終了です。今回はpythonがどうとかいうよりはFlaskの関連で躓いた感じは否めません。ただ無事に動かせてよかったかなと思います。ngrokを使用すればRaspberryPiでもBotをローカルで動かせるかなと思います。

続いてはHelokuへのデプロイをしていきたいと思います。（つづく）

RaspberryPiでNFCタグを使ってみる

RaspberryPiでNFCタグを使ってみる

久しぶりにいろいろと思うところがあって、RaspberryPiでNFCのタグを使ってみることにしました。

基本的には過去エントリー見てもらえればいいのですが、その頃からRaspbianのバージョンもベースが変わっているのでちょっと変わったようです。 というか楽になっただけなので大したことはないです。

【参考1】 uepon.hatenadiary.com 【参考2】 uepon.hatenadiary.com

使用したタグはサンワサプライさんのシールタイプになります。

一枚あたり100円を切っているので、前よりも安くなってきていますね。

今回のOS情報も念の為。今回はRaspberry Pi3ではなく、使っていなかったRaspberry Pi2を使用してます。

$ lsb_release -a
No LSB modules are available.
Distributor ID: Raspbian
Description:    Raspbian GNU/Linux 9.4 (stretch)
Release:        9.4
Codename:       stretch

最新のイメージを使用していますのでRaspbian GNU/Linux 9.4 (stretch)となっています。（イメージ名は2018-04-18-raspbian-stretch.imgでした）

RC-S380の認識

基本的には以前のエントリーと同様にUSBを挿すだけで認識は行われます。不確定な情報ではありますが、過去のバージョンのリーダーではどうも認識はされますが、` ``nfcpy```からは認識出来ないようです。自分も何回か試してみましたがだめでした。nfcpy側では対応デバイスになっていますが、情報から察するにその他ライブラリなどの依存関係も疑われるのではないかと思います。ネットの情報を調べるとベースがDebian 6.0 (squeeze)からDebian 7 (wheezy)に変わったあたりか使えなくなっているのではないかと推測しています。

とりあえずUSBケーブルで接続すると以下のようになります。

【リーダーを1つ接続した場合】

$ lsusb
Bus 001 Device 006: ID 056e:4008 Elecom Co., Ltd
Bus 001 Device 007: ID 054c:06c3 Sony Corp.
Bus 001 Device 003: ID 0424:ec00 Standard Microsystems Corp. SMSC9512/9514 Fast Ethernet Adapter
Bus 001 Device 002: ID 0424:9514 Standard Microsystems Corp. SMC9514 Hub
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub

特に問題ありません。2つ接続しても問題なく認識されています。

【リーダーを2つ接続した場合】

$ lsusb
Bus 001 Device 006: ID 056e:4008 Elecom Co., Ltd
Bus 001 Device 007: ID 054c:06c3 Sony Corp.
Bus 001 Device 008: ID 054c:06c3 Sony Corp.
Bus 001 Device 003: ID 0424:ec00 Standard Microsystems Corp. SMSC9512/9514 Fast Ethernet Adapter
Bus 001 Device 002: ID 0424:9514 Standard Microsystems Corp. SMC9514 Hub
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub

nfcpyモジュールのインストール

前回とは異なり、pipに登録されていました。気になる点としてはpython2系にしかまだ対応していない点でしょうか。ドキュメント通りインストールすれば問題はありません。 -Uスイッチをつけて置かないとエラーがでるようです。

$ sudo pip install -U nfcpy
Collecting nfcpy
  Downloading https://files.pythonhosted.org/packages/89/2c/3d7378d65c6f21312fae4cc44849606eefa08f5980e06c5bc220c2086808/nfcpy-0.13.5-py2-none-any.whl (214kB)
    100% |????????????????????????????????| 215kB 627kB/s
Collecting libusb1 (from nfcpy)
  Downloading https://files.pythonhosted.org/packages/ec/5d/4fdac6c53525786fe35cff035c3345452e24e2bee5627893be65d12555cb/libusb1-1.6.4.tar.gz (55kB)
    100% |????????????????????????????????| 61kB 1.0MB/s
Collecting pydes (from nfcpy)
  Downloading https://www.piwheels.org/simple/pydes/pyDes-2.0.1-py2.py3-none-any.whl
Collecting pyserial (from nfcpy)
  Downloading https://files.pythonhosted.org/packages/0d/e4/2a744dd9e3be04a0c0907414e2a01a7c88bb3915cbe3c8cc06e209f59c30/pyserial-3.4-py2.py3-none-any.whl (193kB)
    100% |????????????????????????????????| 194kB 680kB/s
Collecting ndeflib (from nfcpy)
  Downloading https://files.pythonhosted.org/packages/01/76/39eb236dc5566618abdb169cb88ba4eabd22245b29cc9e5f8d91d5fcf261/ndeflib-0.3.2-py2.py3-none-any.whl (57kB)
    100% |????????????????????????????????| 61kB 1.0MB/s
Building wheels for collected packages: libusb1
  Running setup.py bdist_wheel for libusb1 ... done
  Stored in directory: /root/.cache/pip/wheels/98/8d/8b/bac0a20eb9757e7dbf46e8ab1f1695c78ad919f53080a58bc1
Successfully built libusb1
Installing collected packages: libusb1, pydes, pyserial, ndeflib, nfcpy
  Found existing installation: pyserial 3.2.1
    Not uninstalling pyserial at /usr/lib/python2.7/dist-packages, outside environment /usr
Successfully installed libusb1-1.6.4 ndeflib-0.3.2 nfcpy-0.13.5 pydes-2.0.1 pyserial-3.4

インストールは終わりましたが、テスト用のコマンドなどはインストールされていませんので、Githubから以下のサイトからcloneします。

github.com

$ git clone  https://github.com/nfcpy/nfcpy.git
$ cd nfcpy/
$ ls
HISTORY.rst  README.rst  requirements-dev.txt   setup.py  tox.ini
LICENSE      docs        requirements-pypi.txt  src
MANIFEST.in  examples    setup.cfg              tests

nfcpyの実行を行う

インストール準備がおわったので続いてはnfcpyモジュールのチェックを行います。 以下のコマンドで行います。ですが、インストール直後はsudoをつけないと以下のようなエラーメッセージが表示されます。（sudoをつければ実行は問題はありません。）

今回はRaspberryPiに2つのリーダーを接続しているのでエラーも2つ表示されています。

$ python -m nfc
No handlers could be found for logger "nfc.llcp.sec"
This is the 0.13.5 version of nfcpy run in Python 2.7.13
on Linux-4.14.34-v7+-armv7l-with-debian-9.4
I'm now searching your system for contactless devices
** found usb:054c:06c3 at usb:001:007 but access is denied
-- the device is owned by 'root' but you are 'pi'
-- also members of the 'root' group would be permitted
-- you could use 'sudo' but this is not recommended
-- better assign the device to the 'plugdev' group
   sudo sh -c 'echo SUBSYSTEM==\"usb\", ACTION==\"add\", ATTRS{idVendor}==\"054c\", ATTRS{idProduct}==\"06c3\", GROUP=\"plugdev\" >> /etc/udev/rules.d/nfcdev.rules'
   sudo udevadm control -R # then re-attach device
** found usb:054c:06c3 at usb:001:008 but access is denied
-- the device is owned by 'root' but you are 'pi'
-- also members of the 'root' group would be permitted
-- you could use 'sudo' but this is not recommended
-- better assign the device to the 'plugdev' group
   sudo sh -c 'echo SUBSYSTEM==\"usb\", ACTION==\"add\", ATTRS{idVendor}==\"054c\", ATTRS{idProduct}==\"06c3\", GROUP=\"plugdev\" >> /etc/udev/rules.d/nfcdev.rules'
   sudo udevadm control -R # then re-attach device
I'm not trying serial devices because you haven't told me
-- add the option '--search-tty' to have me looking
-- but beware that this may break other serial devs
Sorry, but I couldn't find any contactless device

このメッセージをよくみると

-- better assign the device to the 'plugdev' group
   sudo sh -c 'echo SUBSYSTEM==\"usb\", ACTION==\"add\", ATTRS{idVendor}==\"054c\", ATTRS{idProduct}==\"06c3\", GROUP=\"plugdev\" >> /etc/udev/rules.d/nfcdev.rules'
   sudo udevadm control -R # then re-attach device

このメッセージの内容は、「使用するデバイスをplugdevグループに入れて続くコマンドをいれるとsudoなしで実行できるようになります。」とのことでした、ベンダIDなどもセットされた形でメッセージが表示されるので、コピペして以下のように実行します。

$ sudo sh -c 'echo SUBSYSTEM==\"usb\", ACTION==\"add\", ATTRS{idVendor}==\"054c\", ATTRS{idProduct}==\"06c3\", GROUP=\"plugdev\" >> /etc/udev/rules.d/nfcdev.rules'
$ sudo udevadm control -R

リーダーが複数ある場合はエラーメッセージにある分だけ実行します。 実行が終わったら、念の為RaspberryPiを再起動し、改めてチェック行ってみます。

$ python -m nfc
No handlers could be found for logger "nfc.llcp.sec"
This is the 0.13.5 version of nfcpy run in Python 2.7.13
on Linux-4.14.34-v7+-armv7l-with-debian-9.4
I'm now searching your system for contactless devices
** found SONY RC-S380/P NFC Port-100 v1.11 at usb:001:005
** found SONY RC-S380/P NFC Port-100 v1.11 at usb:001:004
I'm not trying serial devices because you haven't told me
-- add the option '--search-tty' to have me looking
-- but beware that this may break other serial devs

これでsudoをつけなくてもエラーメッセージは表示されないようになります。デバイスも正しく認識されているようです。

続いてはGithubで落としてきたテスト用のコマンドを使用して交通系ICカードを読み込ませてみます。exampleディレクトリ内のtagtool.pyがテスト用のコマンドです。実行すると読み込み待ちになります。

$ git clone  https://github.com/nfcpy/nfcpy.git
$ cd ~/nfcpy/examples/
$ python tagtool.py
No handlers could be found for logger "nfc.llcp.sec"
[nfc.clf] searching for reader on path usb
[nfc.clf] using SONY RC-S380/P NFC Port-100 v1.11 at usb:001:005
** waiting for a tag **

ここで交通系ICカードをタッチすると読み込んだデータの一部が表示されます。 （IDの部分は一部伏せています）

$ python tagtool.py
No handlers could be found for logger "nfc.llcp.sec"
[nfc.clf] searching for reader on path usb
[nfc.clf] using SONY RC-S380/P NFC Port-100 v1.11 at usb:001:005
** waiting for a tag **
Type3Tag 'FeliCa Standard (RC-S915)' ID=**************** PMM=**************** SYS=0003

このコマンドでは使用するリーダーを指定して起動することになります。（指定しない場合には最初に見つかったリーダーが使用される）

では、改めて今回準備したNFCタグを読み込ませてみます。（IDの部分は一部伏せています） うまく読み込めたようです。購入時は何も書き込まれていないので以下のような表示になります。（この商品は144Byteのデータ書き込みができるようですが、実際には137byteの書き込みになってしまうようです。）

$ python tagtool.py
No handlers could be found for logger "nfc.llcp.sec"
[nfc.clf] searching for reader on path usb
[nfc.clf] using SONY RC-S380/P NFC Port-100 v1.11 at usb:001:005
** waiting for a tag **
Type2Tag 'NXP NTAG213' ID=04D803********
NDEF Capabilities:
  readable  = yes
  writeable = yes
  capacity  = 137 byte
  message   = 0 byte

pythonからタグを操作する

タグ情報をreadする

on_ほげほげみたいな感じのイベントハンドラーのメソッドを作成して、usb接続のデバイスに登録することで読み込むことができます。今回の例ではon_connectが読み込みに当たりますが、今後の例もこの部分を編集して実装しています。

【readNFC.py】

import nfc

def on_startup(targets):
        print("on_startup()")
        return targets

def on_connect(tag):
        print("Tag: {}".format(tag))
        print("Tag type: {}".format(tag.type))
        #print '\n'.join(tag.dump())
        if tag.ndef:
                print tag.ndef.message.pretty()
        #return True

def on_release(tag):
        print("on_release()")
        if tag.ndef:
                print(tag.ndef.message.pretty())

clf = nfc.ContactlessFrontend('usb')
if clf:
        print("Clf: {}".format(clf))
        clf.connect(rdwr={
                'on-startup': on_startup,
                'on-connect': on_connect,
                'on-release': on_release
        })

clf.close()

このプログラム例ではタグ情報をダンプしていますが、初期状態ではタグの内容は空になってます。

【実行】

$ python readNFC.py
No handlers could be found for logger "nfc.llcp.sec"
Clf: SONY RC-S380/P on usb:001:005
on_startup()
Tag: Type2Tag 'NXP NTAG213' ID=04A903********
Tag type: Type2Tag
record 1
  type   = ''
  name   = ''
  data   = ''

タグをフォーマットする

【formatNFC.py】

import nfc

def on_connect(tag):
        print("format:", tag.format())

clf = nfc.ContactlessFrontend('usb')
if clf:
        print("Clf: {}".format(clf))
        clf.connect(rdwr={
                'on-connect': on_connect
        })

clf.close()

【実行】

$ python formatNFC.py
No handlers could be found for logger "nfc.llcp.sec"
Clf: SONY RC-S380/P on usb:001:005
('format:', True)

情報がフォーマットされているかを先程のreadNFC.pyで もう一度読み込ませてみると

【実行】

$ python readNFC.py
No handlers could be found for logger "nfc.llcp.sec"
Clf: SONY RC-S380/P on usb:001:005
on_startup()
Tag: Type2Tag 'NXP NTAG213' ID=04A903********
Tag type: Type2Tag
record 1
  type   = ''
  name   = ''
  data   = ''

無事にフォーマットされていることがわかります。

タグに情報を書き込む

"Hello World!"という文字列を書き込んでみます。

【writeNFC.py】

import nfc

def on_startup(targets):
        print("on_startup()")
        return targets

def on_connect(tag):
        print("Tag: {}".format(tag))
        print("Tag type: {}".format(tag.type))
        #print '\n'.join(tag.dump())
        if tag.ndef:
                record = nfc.ndef.TextRecord("Hello World!")
                tag.ndef.message = nfc.ndef.Message(record)
                print tag.ndef.message.pretty()
        #return True

def on_release(tag):
        print("on_release()")
        if tag.ndef:
                print(tag.ndef.message.pretty())

clf = nfc.ContactlessFrontend('usb')
if clf:
        print("Clf: {}".format(clf))
        clf.connect(rdwr={
                'on-startup': on_startup,
                'on-connect': on_connect,
                'on-release': on_release
        })

clf.close()

【実行】

$ python writeNFC.py
No handlers could be found for logger "nfc.llcp.sec"
Clf: SONY RC-S380/P on usb:001:005
on_startup()
Tag: Type2Tag 'NXP NTAG213' ID=04A903********
Tag type: Type2Tag
record 1
  type   = 'urn:nfc:wkt:T'
  name   = ''
  data   = '\x02enHello World!'

書き込んだタグを先程のreadNFC.pyで読み込ませると…

$ python readNFC.py
No handlers could be found for logger "nfc.llcp.sec"
Clf: SONY RC-S380/P on usb:001:005
on_startup()
Tag: Type2Tag 'NXP NTAG213' ID=04A903********
Tag type: Type2Tag
record 1
  type   = 'urn:nfc:wkt:T'
  name   = ''
  data   = '\x02enHello World!'

無事に書き込まれているようです。また先程のフォーマットをすれば初期化も問題なくできます。

$ python formatNFC.py
No handlers could be found for logger "nfc.llcp.sec"
Clf: SONY RC-S380/P on usb:001:005
('format:', True)

$ python readNFC.py
No handlers could be found for logger "nfc.llcp.sec"
Clf: SONY RC-S380/P on usb:001:005
on_startup()
Tag: Type2Tag 'NXP NTAG213' ID=04A903********
Tag type: Type2Tag
record 1
  type   = ''
  name   = ''
  data   = ''

複数のリーダーを使用した読み込み（スレッド＋interruptシグナル対応）

今回は複数のリーダーを接続してそれぞれでタグを読み込ませたいと思っていたのでそれを実装してみます。各デバイスごとにスレッドを生成し、且つデーモン化してCtrl+Cでの終了にも対応させています。

【multiPollingNFC.py】

#!/usr/bin/env python
# -*- coding: utf-8 -*-
import sys
import signal
import nfc
import time
import threading

def on_startup(targets):
    # print("on_startup()")
    return targets

def on_connect(tag):
    print("Tag: {}".format(tag))
    print("Tag type: {}".format(tag.type))
    if tag.ndef:
        print(tag.ndef.message.pretty())
    print("-----------------")

def on_release(tag):
    # print("on_release()")
    if tag.ndef:
        print(tag.ndef.message.pretty())

def readNFCThread(device):
    clf = nfc.ContactlessFrontend(device) # バス番号とデバイス番号を指定
    while True:
        if clf:
                # print("Clf: {}".format(clf0))
                clf.connect(rdwr={
                        'on-startup': on_startup,
                        'on-connect': on_connect,
                        'on-release': on_release
                })
    clf.close()

def main(argv):
    t1 = threading.Thread(target=readNFCThread,name="readNFC1",args=('usb:001:004',))
    t2 = threading.Thread(target=readNFCThread,name="readNFC2",args=('usb:001:005',))
    t1.setDaemon(True)
    t2.setDaemon(True)
    t1.start()
    t2.start()
    while True:
        pass

def handler(signal, frame):
    print("Process Interrupt!")
    sys.exit(0)

if __name__ == '__main__':
    signal.signal(signal.SIGINT, handler)
    main(sys.argv)

ちょっと解説

各デバイスの読み込みをスレッド化しているので以下のようにデバイスの設定をできるようにしています。

clf = nfc.ContactlessFrontend(device) # バス番号とデバイス番号を指定

ここでいうデバイスが接続したリーダーの設定になります。引数として与える情報としてはlsusbコマンドで認識されたBusとDeviceIDを与えることになります。

$ lsusb
【略】
Bus 001 Device 005: ID 054c:06c3 Sony Corp.
Bus 001 Device 004: ID 054c:06c3 Sony Corp.
【略】

上記のような表示が行われた場合には以下のように引数で与えれることになります。 USBの接続状態によって毎回変わる可能性のある情報なので注意が必要となります。

t1 = threading.Thread(target=readNFCThread,name="readNFC1",args=('usb:001:004',))
t2 = threading.Thread(target=readNFCThread,name="readNFC2",args=('usb:001:005',))

このプログラムではThread化しているのでCtrl+Cを押してinterruptを発生させても、Threadが終了しない状態になります。 そのため、以下のようにしてDeamonの設定をしています。

    t1.setDaemon(True)
    t2.setDaemon(True)

実行してみる

フォーマットされたタグとHello World！の書き込まれたタグを別のリーダーに読み込ませると以下のような表示になります。

【実行】

$ python multiPollingNFC.py
No handlers could be found for logger "nfc.llcp.sec"
Tag: Type2Tag 'NXP NTAG213' ID=04D803********
Tag type: Type2Tag
record 1
  type   = ''
  name   = ''
  data   = ''
-----------------
Tag: Type2Tag 'NXP NTAG213' ID=04A903********
Tag type: Type2Tag
record 1
  type   = 'urn:nfc:wkt:T'
  name   = ''
  data   = '\x02enHello World!'
-----------------

一応はできていますが、なんとなく処理が遅いです。それぞれのリーダーでポーリングをしているということもあるので、少し待ち時間があるようです。（別のターミナルで別々のreadNFC.pyを動作させたほうが早いかもｗ）このままの仕組みで高速化するのであれば、もっと別の方法での工夫がいるかなと思います。

終わりに

raspbianなどのバージョンも変わると設定方法もいい感じで簡単になってきているのでいいですね。

Raspberry Pi Desktopをインストール(2018.06.03版)

Raspberry Pi Desktopをインストール

以前からあったx86版のRaspberryPixel（Raspbian JESSIE With Pixelが正式名称だった？）がバージョンアップしていました。ちょっと、PC版のLinuxも少し触る機会があったのですが、aptコマンドではディストリビューションのアップグレードが出来ないようだった（バージョンがダウンしたような表記になってしまったｗ）ので、インストールし直すことにしました。

使用したPCは【Acer Aspire One 753】になります。 www.notebookcheck.net

結論からいうと以前やったものとはかなり印象的に変わっていたのでメモを取ることにしました。

【参照】 uepon.hatenadiary.com

OSの正式名称としてはRaspberry Pi Desktopという名称でいいのかなと思います。

www.raspberrypi.org

USBメモリへイメージの転送

この部分に関しては以前と同様にEtcherを使用します。

etcher.io

rufusでもいけるかなと思ったのですが、最新のrufusの書き込みモードにdd形式の選択がUIから消えていたので、Etcherで行ったほうがいいかもしれません。（古いバージョンだと問題はないのかなと勝手に予想）

↑　dd形式の書き込みができない

書き込み操作は簡単で、インストールしたらEtcherを起動 【Select Image】ボタンを押してダウンロードしたOSイメージを選択します。

イメージを選択したら次は【Select drive】で書き込み先のUSBメモリを選択します。

ドライブ選択のダイアログが表示されます。

あとは【Flash!】ボタンをクリックして書き込みを行います。

下記の画面が出れば処理終了になります。

ここまでは特に大きく差はありません。

USBをPCに挿してを起動する

起動すると以下のような画面が出てきます。前はこのような画面はなかったのですが…。このバージョンからはこのイメージはLiveイメージのようなものになり、Persistence領域（Liveイメージとは別の領域に変更した情報を入れる）ようになったようです。基本的にはメニューの一番上にある【Run with persistence】選択すれば良いようです。

あとは起動すれば普通のRasbianと大きくは変わりません。ただ、以前のバージョンにはなかったraspi-configがある点が大きく変わった気がします。起動時にSSHの起動はありますが、VNCなどの起動がない（その他はRaspberryPi固有なのでなくても仕方ないですが）のが少し困った感じです。ただ、dpkg-reconfigureを使うよりはずいぶん進歩したなって感じです。

GUI起動もできますが、設定中の作業でCUI起動しかできなくなってる…（日本語フォントっぽい感じがしなくもない）

CUIでも問題はないのでいいのですが…。

また、SSHに関しては有効化を行ってもそのままusernameとpasswordでログインできるモードではありませんでした。鍵推奨ということでその設定なのかもしれませんが、最初にしらないとなぜ？になってしまうかも。

SSHの設定変更

usernameとpasswordでログインできるようにするには /etc/ssh/sshd_configを編集することになります。

$ sudo vim /etc/ssh/sshd_config

ファイルの中ほどにある PasswordAuthentication no を PasswordAuthentication yes に変更します。

変更後はサービスの再起動を行えばOKです。

$ sudo systemctl restart ssh
$ sudo systemctl enable ssh

（注）2行目は念の為ですが多分いらないような気がします。

これで無事にSSHができるようになりました。

＃VNCの設定

次はVNCになります。Raspbianにデフォルトで入っているのはRealVNCなのですがなんとRaspberry Pi DesktopにはRealVNCのパッケージが存在しません。仕方ないので、昔使っていたTightVNCで代用します。

【RealVNC】 www.realvnc.com

【TightVNC】 www.tightvnc.com

以下2つの情報を参考に設定を行っていきます。

VNC server in Jessie (using a systemd service)

[メモ] Raspberry Pi : VNCサーバ設定(自動起動)

インストールに関しては以下でOKです。

$ sudo apt-get update
$ sudo apt-get install -y tightvncserver

インストール後、一度vncserverを起動します。起動しなくてもいいのですが一回目の起動時にパスワードを登録することになりますのでここでやっておいたほうが無難です。登録しなかった場合にはパスワードなしでの設定になります。（設定する場合にはvncpasswdコマンドを実行すれば再設定出来ます。）

Serverを手動にて起動し、パスワード設定を行う。

$ vncserver

つづいて設定ファイルの編集を行います。

$ sudo vim /etc/systemd/system/vncserver@.service

【/etc/systemd/system/vncserver@.service】

[Unit]
Description=Remote desktop service (VNC)
After=syslog.target network.target
[Service]
Type=forking
User=pi
PAMName=login
PIDFile=/home/pi/.vnc/%H:%i.pid
ExecStartPre=-/usr/bin/vncserver -kill :%i > /dev/null 2>&1
ExecStart=/usr/bin/vncserver -depth 24 -geometry 1280x800 :%i
ExecStop=/usr/bin/vncserver -kill :%i
[Install]
WantedBy=multi-user.target

編集後に設定を有効化して

$ sudo systemctl daemon-reload && sudo systemctl enable vncserver@1.service

再起動を行います。

$ sudo reboot

あと、Windowsからはリモートデスクトップ接続を使用してVNC接続を行いたいので xrdpをインストールしておきます。

$ sudo apt-get install -y xrdp

設定が完了するとWindowsからリモートデスクトップ接続でVNCへ接続できるようになります。

日本語化

日本語化に関しては以下を参照して行いました。ありがとうございます。

【参考】 PIXEL for x86 (RaspberryPiのデスクトップ環境)

日本語入力（IM）

$ sudo apt-get install fcitx-mozc  -y

インストール後に優先順位などの設定が必要かと思ったのですが大丈夫そうでした。

日本語フォント

$ sudo apt-get install fonts-ipafont fonts-ipaexfont fonts-takao

Chromiumの日本語化

$ sudo apt-get install chromium-l10n

libreofficeの日本語化

$ sudo apt-get install libreoffice-help-ja

Node.jsのインストール

これで大丈夫かなーと思ったのですが、開発環境も一応確認。 pythonは2系も3系もそれなりに使えそうなバージョンだったのですが、Node.jsはインストールされていませんでした。aptでインストールをするのですが、インストールされるのはVersion4系。さすがにletなどが使えないということでもあったので、少なくとも現在のLTSのバージョンにはしておこうと思います。（ちなみにNode 4.x is End Of Lifeとのことです。）

ただ、Version4系の頃にはそもそもnpmのパッケージがないので、nを使おうと思ってもnpmを経由してインストールは出来ない状況でした。

公式情報でインストール方法があったので、それを使用してインストールを行います。

$ curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
$ sudo apt-get install -y nodejs
$ sudo apt-get install -y build-essential

これでバージョンが8.11.2のLTSまで来ました。npmも同時にインストールされるのでバージョンが5.6になっています。

$ node -v && npm -v
v8.11.2
5.6.0

おわりに

一応これで、Windows7時代のCeleronなPCもそれなりに作業用に使用できるようになりました。実の所はUbuntuにする予定だったのですがUSBにうまく入れられなかったので苦し紛れには近いです。インストール時の苦労を考えるとUSBメモリを2つ使ってUbuntuを入れるのがいいと思います。

…どんなだよ。

ちなみにScratch2も日本語設定できています！