02. Log
logオブジェクトは、ログ出力機能を提供する組み込みオブジェクトです。
機能概要:
- システムログの出力レベルを設定できます。
- ログ出力先を設定できます。
- JavaScript上から任意文字をログへ出力できます。
制限事項:
- ログ保存用不揮発メモリの最大保存容量は
366KBとなります。
フルになった場合は古いログから上書き更新されます。
log Global Object
| Methods()/Properties | Summary | Version | Note |
|---|---|---|---|
| log.setLevel() | システムログのレベル及び出力先を設定します。 | 01.00.00+ | |
| log.clear() | 不揮発メモリに保存されているログを消去します。 | 01.00.00+ | |
| log.getStoredSize() | 現在保存されているログサイズを取得します。 | 01.00.00+ | |
| log.getStorageSize() | 保存可能なログサイズを取得します。 | 01.00.00+ | |
| log.printLevel() | print()関数の出力先を設定します。 | 01.00.00+ | |
| print() | ログを出力します。 | 01.00.00+ | グローバルスコープの関数となります。 |
Details
log.setLevel([level[,output[,instance]]])
システムログのレベル及び出力先を設定します。
最後に設定した値が不揮発メモリに保存されます。
システムログは基本的に無効設定のままで構いません。
予期せぬ動作が発生した際に、原因を調査するために使用します。
| Name | Type | M/O | Summary | Note | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| level | number | optional | ログレベル設定 -1: Disabled 0: Error level 1: Warning level 2: Debug level 3: Trace level デフォルト値は-1となります。 | |||||||||
| output | number | optional | 出力先設定 0: All disabled 1: NEQTOデバイス上の不揮発メモリにログ保存 2: NEQTOデバイスのシリアルポートからログ出力 3: 1, 2 が有効 4: NEQTO Consoleにログをリアルタイム送信 5: 1, 4 が有効 6: 2, 4 が有効 7: 1, 2, 4 が有効 デフォルト値は0となります。 | Version 01.00.01+ 4 以上は Version 01.03.00+ 「NEQTO Consoleにログをリアルタイム送信する」機能は、デバック用途のみでご使用ください。この機能は多くの通信リソースを使用するため、デバイスの処理負荷の増加やデータ伝送遅延を発生させる可能性があります。又、通信障害時の再送処理は行われないため、ログデータが欠落する可能性があります。 | ||||||||
| instance | number | optional, mandatory | NEQTO Console上のリアルタイムログ送信先となるインスタンスIDを指定します。 指定可能なインスタンスIDの範囲についてはこちらを参照してください。 | Version 01.03.00+ 'output'が 4 以上の場合のみ必須となります。 リアルタイムログは下記のMQTT仕様でNEQTO Consoleへ送信されます。
| ||||||||
| return | undefined | - | - | 異常が発生した時は、例外となります。 |
log.clear()
不揮発メモリに保存されているログを消去します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | undefined | - | - |
log.getStoredSize()
現在保存されているログサイズを取得します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | number | - | 現在保存されているログサイズ[byte] |
log.getStorageSize()
保存可能なログサイズを取得します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | number | - | 保存可能なログサイズ[byte] |
log.printLevel([output[,instance]])
print()関数の出力先を設定します。
スクリプトの開始時に常にデフォルト値で初期化されます。
| Name | Type | M/O | Summary | Note | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| output | number | optional | 出力先設定 0: All disabled 1: NEQTOデバイス上の不揮発メモリにログ保存 2: NEQTOデバイスのシリアルポートからログ出力 3: 1, 2 が有効 4: NEQTO Consoleにログをリアルタイム送信 5: 1, 4 が有効 6: 2, 4 が有効 7: 1, 2, 4 が有効 デフォルト値は0となります。 尚、Version 01.00.01以降、ユーザーコンソールモードで起動した場合、デフォルト2となります。 | 4 以上は Version 01.03.00+ 「NEQTO Consoleにログをリアルタイム送信する」機能は、デバック用途のみでご使用ください。この機能は多くの通信リソースを使用するため、デバイスの処理負荷の増加やデータ伝送遅延を発生させる可能性があります。又、通信障害時の再送処理は行われないため、ログデータが欠落する可能性があります。 | ||||||||
| instance | number | optional, mandatory | NEQTO Console上のリアルタイムログ送信先となるインスタンスIDを指定します。 指定可能なインスタンスIDの範囲についてはこちらを参照してください。 | Version 01.03.00+ 'output'が 4 以上の場合のみ必須となります。 リアルタイムログは下記のMQTT仕様でNEQTO Consoleへ送信されます。
| ||||||||
| return | undefined | - | - | 異常が発生した時は、例外となります。 |
print(logMsg)
ログを出力します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| logMsg | string | mandatory | 出力するログメッセージ | |
| return | undefined | - | - | 異常が発生した時は、例外となります。 |
オブジェクトの使用例
Sample 1
システムログ及びprintログをNEQTOデバイスのシリアルポートから出力するサンプルです。
log.setLevel(0,2);
log.printLevel(2);
Sample 2
システムログ及びprintログをNEQTO Consoleにリアルタイム送信するサンプルです。
インスタンスIDは任意の値です。システムログとprintログで同IDを使用することも可能です。
FWバージョン 01.03.00以降から使用可能です。
log.setLevel(0,4,1);
log.printLevel(4,2);
//log.printLevel(4,1); /*Available*/
Updated: 2021-05-06