Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OSS Gate Workshop: PyConJP 2020 Sprint: 2020-08-23: Miura55:NFCPy : Work log #1406

Closed
Miura55 opened this issue Aug 23, 2020 · 17 comments
Closed

OSS Gate Workshop: PyConJP 2020 Sprint: 2020-08-23: Miura55:NFCPy : Work log #1406

Miura55 opened this issue Aug 23, 2020 · 17 comments

Comments

@Miura55
Copy link
Contributor

Miura55 commented Aug 23, 2020

This is a work log of a "OSS Gate workshop".
"OSS Gate workshop" is an activity to increase OSS developers.
Here's been discussed in Japanese. Thanks.

作業ログ作成時の説明

以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。

OSS Gate Workshop: ${LOCATION}: ${YEAR}-${MONTH}-${DAY}: ${ACCOUNT_NAME}: ${OSS_NAME}: Work log

タイトル例↓：

OSS Gate Workshop: Tokyo: 2017-01-16: kou: Rabbit: Work log

OSS Gateワークショップ関連情報

  • スライド：ワークショップの進行に使っているスライドがあります。
  • チャット：OSS開発に関することならなんでも相談できます。ワークショップが終わった後もオンラインで相談しながら継続的にOSSの開発に参加しましょう！
  • シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
  • 過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。
@Miura55 Miura55 changed the title OSS Gate Workshop: PyConJP 2020 Sprint: 2020-08-23: Miura55: Rabbit: Work log OSS Gate Workshop: PyConJP 2020 Sprint: 2020-08-23: Miura55: : Work log Aug 23, 2020
@piroor
Copy link
Contributor

piroor commented Aug 23, 2020

よろしくお願いします！

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020 •
edited

OSSの選定

  • Python
  • Raspi GPIO
  • Grovepy
  • NFCpy←今回はこれ
  • LINE bot SDK
  • Kivy
  • Flask
  • SQL Alchemy
  • VS Code
    • draw.io
    • jinja
    • Git Lens
    • kite autocomplete
    • Postman(未インストール)
    • Node-red(未インストール)

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020

NFCpyでググって以下の公式ドキュメントにアクセス
https://nfcpy.readthedocs.io/en/latest/topics/get-started.html

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020

↑上記サイトより、Windows向きにZadigをインストール
https://zadig.akeo.ie/

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020

コメント 2020-08-23 142345

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020

Zadigを起動することまでは書いてあったが、デバイスを接続することまでは書いてなかった

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020

とりあえずデバイスを接続してから次の手順を実行

Click Options -> List All Devices

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020 •
edited

接続したデバイスの型番が表示された
コメント 2020-08-23 143509

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020

WinUSB (v6.1.7600.16385)が選択された状態でInstall Driverをクリック

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020

インストールが終わったっぽいので、次のThen, install libusb:をすすめる

@Miura55 Miura55 changed the title OSS Gate Workshop: PyConJP 2020 Sprint: 2020-08-23: Miura55: : Work log OSS Gate Workshop: PyConJP 2020 Sprint: 2020-08-23: Miura55:NFCPy : Work log Aug 23, 2020
@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020

7zipをインストールしたら再起動を要求されてそのまま中間報告の時間になった…

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020 •
edited

中間フィードバックで気づいたこと

  • Zadigのセットアップで以下の表現が分かりにくい…

Select your NFC reading/writing device from the list

@knokmki612
Copy link
Member

ふりかえりました！

Zadigを起動することまでは書いてあったが、デバイスを接続することまでは書いてなかった

NFCpyのドキュメントでのZadigの説明に戸惑う箇所が結構あった様子。その点についてドキュメントにフィードバックをするのがよさそうだと思いました！

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020 •
edited

Getting startedのフィードバック

  • NFCデバイスをどのタイミングで接続するのかが明記されておらずわかりにくかった。zadigを初めて触る人にとってはzadigが何をするアプリなのかがわからない。List All Devicesでパソコンに接続中のデバイスの一覧を表示するということが手順では分かりにくい。何も接続せずに手順を実行したらNFCデバイスがリストに表示されなかったため
    →zadigを起動する前にNFCデバイスを接続するように記載するのが親切。
  • Run the standalone exeの表現が初心者に不親切。standalone exeで通じるかどうかが分かりにくかったため、「インストールしたexeファイル」という書き方にしたほうが分かりやすい気がする。

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020 •
edited

Getting startedの修正

https://nfcpy.readthedocs.io/en/latest/topics/get-started.html#installation 内のWindowsでNFCデバイスを接続するための手順について、以下の2点の修正を行う。

Run the standalone exe→Run the exe which you installedに手順を変更

standalone exeだとどのexeファイルを指しているのか分からず、直前の手順でインストールしたZadigを示す表現として変更した

zadigを起動する前にNFCデバイスを接続する手順を追加

zadigを初めて触る人にとってはzadigが何をするアプリか分からず、List All Devicesでパソコンに接続中のデバイスがリストアップされることが分からないため。

@Miura55
Copy link
Contributor Author

Miura55 commented Aug 23, 2020 •
edited

Updated Getting started

I propose two changes in https://nfcpy.readthedocs.io/en/latest/topics/get-started.html#installation

Change Run the standalone exe to Run the exe which you installed

I confused the expression standalone exe, because I didn't understand what standalone exe exactly meaned. This change describes it is the one I have just installed.

Add Connect your NFC device

People who have not known zadig well may not understand the List All Devices shows the current connected devices. So, I clarified when I should connect my NFC device to my machine.

@knokmki612
Copy link
Member

nfcpy/nfcpy#170
プルリク出されたのちに、開発者の方から以下のコミットをされた旨反応ありましたね！
nfcpy/nfcpy@10a8087

おつかれさまでした！

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@piroor @knokmki612 @Miura55