Node.jsを使ってスマートプラグを操作したい

Question

TP-LinkのHS105というスマートプラグをスマホのアプリからではなくPC等別環境から操作したいと思いNode.jsが使えないか試してみております。
Macにこちらのページを参考に環境を作りました。
https://qiita.com/kyosuke5_20/items/c5f68fc9d89b84c0df09

GitHubよりスマートプラグを操作するAPIを開発している人がいたので頂戴し、インストールおよびコマンドベースでの操作でスマートプラグの電源ON、OFFが出来ています。

例）
$ tplink-smarthome-api sendCommand 192.168.0.117:9999 '{"system":{"set_relay_state":{"state":1}}}'

ここまでは出来ているのですが、こちらのページにある例（https://github.com/plasticrake/tplink-smarthome-api/blob/master/examples/plug-turn-on-off.js）を参考にVS Codeで書いてみているのですが、以下のようなエラーが出てしまいます。

Process exited with code 1
Uncaught Error: Cannot find module 'tplink-smarthome-api'

このようなエラーが出てしまう原因をどなたか解説いただけませんでしょうか？

Comments

[hoshi-takanori]

tplink-smarthome-api という npm モジュールを入れる必要があるのでは。

[MountDown]

ご指摘ありがとうございます。
記載が漏れておりました。
npm install -g tplink-smarthome-api でインストールが出来ております。

Answer 1

回答

npm install -g tplink-smarthome-api でインストールが出来ております。

npm install --global（npm i -g）はCLIからパッケージを利用したい場合のインストール方法で、通常require()で読み込むことはできません。

原因

require()は./、/、../または#で始まらない文字列を受け取った時、現在のディレクトリ（__dirname）を階層ごとに分割したリストにnode_modulesを連結して、その中にディレクトリ名が一致するパッケージが無いか総当たり方式で検索します。

例えば、現在のディレクトリが/Users/foo/bar/bazで、/Users/foo/node_modules/hoge-moduleにrequire()したいモジュールがあるとします。

$ tree /
.
└── Users
   └── foo
      ├── bar
      │  └── baz # この中にいる
      └── node_modules
         └── hoge-module # これをrequire()したい

この状態で、/Users/foo/bar/baz/index.jsの中でrequire('hoge-module')を実行すると、Nodeは次のディレクトリの中から順番にhoge-moduleと名付けられた子ディレクトリが存在しないか調べます：

1. /Users/foo/bar/baz/node_modules
2. /Users/foo/bar/node_modules
3. /Users/foo/node_modules
4. /Users/node_modules
5. /node_modules

このケースでは/Users/foo/node_modulesに目的のモジュールがあるため、リストの__3.__で検索が終了します。

--globalフラグ付きでインストールした場合にここで発生する問題が、npm-installがこれらのディレクトリのいずれの場所にもパッケージを配置してくれないことです。

---

npm install --globalは{prefix}/lib/node_modules（macOS/Linux/BSD/その他*nixの場合）または{prefix}/node_modules（Windowsの場合）の中にパッケージをインストールします。

ご自身の環境の{prefix}は次のコマンドを打つことで確認できます：

$ npm config get prefix
/usr/local # 一例（macOSの場合）

試しにjestパッケージを--globalフラグ付きでインストールし、typeとrealpathを使い、実態がどこにあるか調べてみましょう：

$ npm i -g jest
added 528 packages, and audited 529 packages in 13s
found 0 vulnerabilities

$ realpath $(type -p jest)
/usr/local/lib/node_modules/jest/bin/jest.js # 一例（macOSの場合）

ディレクトリ/usr/local/lib/node_modulesの中にjestパッケージがインストールされていますね。上記したNodeのパッケージ解決方法を参照すると、/usr/local/libの子孫ディレクトリ以外からrequire()することができないことに気がつくと思います。これが質問で発生しているCannot find module ...エラー（'MODULE_NOT_FOUND'エラー）の直接的な原因です。

解決方法

これを解決するにはNodeにより検索対象となっているnode_modulesにパッケージのフォルダを用意する必要がありますが、これには大きく3種類のアプローチがあります。

ローカルにインストールし、CLIではnpxコマンドを利用する（方法1）

$ npm i tplink-smarthome-api # 1. ローカルにインストール
$ npx tplink-smarthome-api   # 2. CLIで実行

バージョン7.0.0以降のNodeにはnpxと呼ばれる明示的にパッケージをインストールすることなくCLIスクリプトを実行できるコマンドが追加されています。このコマンドはローカルにパッケージがインストールされている場合ローカルのパッケージを、ローカルにパッケージがインストールされていない場合は自動的にNPMからキャッシュフォルダ（~/.npmまたは%AppData%/npm-cache）にダウンロードしたパッケージを実行します。環境を起因とした問題が発生する可能性が低く、消費する容量も抑えられるため、私はこれを推奨します。

ローカルとグローバルの両方にインストールする（方法2）

$ npm i tplink-smarthome-api    # 1. ローカルにインストール
$ npm i -g tplink-smarthome-api # 2. グローバルにインストール
$ tplink-smarthome-api          # 3. CLIで実行

特筆性は存在しませんが、一番シンプルな方法です。2回同じパッケージをインストールするため、消費する容量が2倍になります。

グローバルにインストールし、ローカルにリンクさせる（方法3）

$ npm i -g tplink-smarthome-api # 1. グローバルにインストール
$ npm link tplink-smarthome-api # 2. ローカルにリンク
$ tplink-smarthome-api          # 3. CLIで実行

npm-linkはローカルのnode_modules内に--globalでインストールしたパッケージのシンボリックリンクを作成します。両方にインストールする方法と比べると容量の節約にはなりますが、package.jsonの依存関係にパッケージを追加してくれず、結果的に管理が複雑になってしまうため非推奨です。加えて使用するパッケージによってはシンボリックリンクを追跡してくれないため、原因不明のエラーが発生することもあります。データ容量の節約をしたい場合は自動的にハードリンクを張ってくれるpnpmや、上記したNodeのモジュール解決方法を容量削減に活用したYarn 2といった他のパッケージマネージャーを使用することをおすすめします。

方法のまとめ

簡単なテーブルとして次のように表すことができます：

方法	容量	管理
ローカル+npx（方法1）	⭕️	⭕️
ローカル+グローバル（方法2）	❌	⭕️
グローバル+リンク（方法3）	⭕️	❌

---

ご不明な点などありましたらお気軽にご質問ください。

Comments

[MountDown]

詳しい解説を頂きありがとうございます。
使用したいパッケージがそもそも見つからないが故のエラーだったということを理解いたしました。
方法１を採用し、試してみましたが新たな壁にぶつかってしまい調べております。
Uncaught TypeError: Cannot read property 'alias' of undefined

こんなプロパティは無いよと言われているのかと思いますが、理解ができておらず困っております。
もし、こちらについてもヒントをいただけると幸いです。
恐れ入りますが、よろしくお願いいたします。

[itepechi]

スタックトレースをお見せいただくことは可能でしょうか？