plis

README for PLIS developpers

このWebサイトはPLIS開発者のための情報をまとめています。 開発にドキュメントが追い付いていかないことが多々ありますがご了承ください。 一般ユーザーは User’s Manual を参照してください。

Source Code

ソースコードはMITライセンスで、Githubで提供してます。

Github

Database Schima (ER diagram)

PLISが実行されるPCでは、通信ログをデータベースで記録しています。 このDBのスキーマは次のようになっています。

Download

License

PLISは各種モジュールや各社のIoTサービス及びプロトコルを利用しています。 従って、PLISのソースコードを利用した商用ソフトウェア開発をする場合は、PLISのライセンスのみならず、各社のライセンスやプロトコルの認証などを必要とします。 下記に外観を示します。

License of the PLIS

PLISのアプリケーション及びソースコードはMITライセンスにて配布しています。

LICENSE file

正確には原文を読んで欲しいのですが、簡単に表現すれば次のようになります。

コピー利用、配布、変更の追加、変更を加えたもの再配布、商用利用、有料販売など自由に利用可能

このソフトウェアの著作権表示（「Copyright (c) 年 作者名」）と、このライセンスの全文（英語の原文）を、
ソースコードや、ソースコードに同梱したライセンス表示用の別ファイルなどに掲載すること。
（ユーザが確認可能な場所に書いてください）

保証無し。このソフトを利用して問題が起きた際に、私たちは一切の責任を負いません。

Licenses of Other modules

PLISは他のモジュールを含んでおり、それらのライセンスに関しては各モジュールのライセンスをご確認ください。 利用しているモジュール群は下記ファイルにまとめています。

Modules.json

基本的にはPLIS作成時において、利用している全モジュールが著作権をクリアしていることを確認しているつもりですが、各モジュール開発者がバージョンアップによってライセンスを変更した場合に追従できていない可能性はあります。 およその場合は、個人利用＆非商用において問題になることはないと思いますが、PLISのソースコードを利用して商用ソフトウェアを開発する場合には各社で知財を確認して保証する必要があります。

APIs and certifications

PLISでは多種多様なIoT商品のAPI及びプロトコルを利用していますが、もしも商品提供している会社側のAPIが変更や廃止となった場合に、その機能が利用できなくなることがあります。

Copyright

Copyright © 2023-Now Sugimura Laboratory, KAIT All Rights Reserved.

Development Environment

PLISの開発

このソフトはNode.js、Electronをベースにしています。

1. Node.js（LTS板がおすすめ）をインストールしておく
2. ~/<github>/plis/v1/app で npm i を実行しておく
3. Windowsならnpm run win、Macならnpm run macで起動する
4. Buildする場合、npm run makeでコンパイルできる。

API Documentsの自動生成

このAPIマニュアルはJSDocで自動生成しています。

1. ~/<github>/plis/v1/docsでnpm iを実行してJSDocをインストールする
2. npm startで生成する。

lifelog.dbのER図自動生成

lifelog.dbのER図はA5:SQL Mk-2で自動生成しています。

1. A5:SQL Mk-2をインストールしておく A5:SQL Mk-2 (x64, for Win)
2. PLISを実行し、~/PLIS/lifelog.dbをA5で開く
3. さらに、~/<github>/plis/v1/docs/lifelog.aSerを開く

Maximum sizes of images for UWP （未確認情報）

• StoreLogo.png — 200x200 (original: 50x50) = 50, 100, 200
• Square150x150Logo.png — 600x600 (original: 150x150) = 150, 300, 600
• Square44x44Logo.png — 256x256 (original: 44x44 more info): 44, 88, 176では？
• Wide310x150Logo.png — 1240x600 (original: 310x150): 310x150, 620x300, 1240x600
• SmallTile.png (Square71x71Logo) — 284x284 (original: 71x71): 71, 142, 284
• LargeTile.png (Square310x310Logo) — 1240x1240 (original: 310x310): 310, 620, 1240
• SplashScreen — 2480x1200 (original: 620x300 more info): 620x300, 1240x600, 2480x1200

参考: https://learn.microsoft.com/ja-jp/windows/apps/design/shell/tiles-and-notifications/creating-tiles

Work around

• node-gyp (windows + sqlite3モジュールで発生しやすい)

開発開始時、下記のようなエラーが出ることが良くあるが、これは開発環境がきちんと整っていない場合に出る。

o Checking your system
o Locating application
o Loading configuration
x Preparing native dependencies: 0 / 1
  x node-gyp failed to rebuild '~\plis\v1\app\node_modules\sqlite3'
- Running generateAssets hook

node-gyp failed to rebuild sqlite3

• 解決方法 Visual Studio 2022の場合

コマンドを実行して npm config edit 適当な空行に下記を追加 msvs_version=2022

コマンドを実行して npm config edit -g 適当な空行に下記を追加 msvs_version=2022

This site is open source. Improve this page.