About neqto.js Libraries
neqto.jsライブラリは、neqto.jsで開発された組み込みクラスです。
NEQTOデバイスに接続されたセンサやデバイスの制御、外部クラウドサービスへの接続、アルゴリズム等、各種機能をライブラリとして提供します。
neqto.jsライブラリには、ライブラリが追加設定されたユーザースクリプト上から直接アクセスすることができます。node.jsの"require"のようにライブラリをインポートするメソッドをスクリプト上から呼び出す必要はありません。
ライブラリを追加する方法については、こちらを参照してください。
ライブラリの使用要件
ライブラリ毎にライブラリの使用要件が定義されています。
Library usage requirements | |
---|---|
Type | 機能別に分類されたライブラリの種類 |
Name | ライブラリ名 (組み込みクラス名) |
Version | ライブラリのリリースバージョン |
Code size used | ライブラリが使用するスクリプトコードサイズ |
Resources used | ライブラリが必要とするneqto.jsオブジェクトのリソース |
Type
Type | Summary |
---|---|
UART | UARTインタフェースを使用するライブラリ |
I2C | I2Cインタフェースを使用するライブラリ |
Utils | 汎用機能ライブラリ |
Integrations | 外部クラウドへ接続するためのライブラリ |
Version
ライブラリのバージョンアップによって、既に公開されているメソッド・プロパティの仕様が変更又は廃止されることはなく、互換性は維持されます。
ライブラリバージョンとNEQTO Engineファームウェアバージョンの組み合わせには依存関係がなく、互換性が維持されますが、双方共に最新バージョンの組み合わせで使用することを推奨します。
Code size used
追加設定されたライブラリはユーザースクリプト上にマージされて、NEQTO Engineに渡されます。そのため、ライブラリが使用するスクリプトコードサイズとスクリプトエディタ上のユーザースクリプトコードサイズの合計が、neqto.jsがサポートしている最大コードサイズを超えないようにする必要があります。
尚、追加したライブラリをユーザースクリプト上で使用しなくても、ユーザースクリプトコード領域を消費するため、必要なライブラリのみ追加するようにしてください。
Resources used
ライブラリが必要とするリソースが、使用するNEQTO Engine及びNEQTOデバイスで利用可能であることを事前に確認してください。リソース要件が満たされていない状態でライブラリを使用した場合、例外が発生します。
ライブラリを使用する際は、ライブラリ以外の処理とリソースが競合しないようにする必要があります。