QUECTEL NB-IoT Module Series Elecom Electronics Supply User Guide
QUECTEL NB-IoT Module Series Elecom Electronics Supply

At Quectel, our aim is to provide timely and comprehensive services to our customers. If you require any assistance, please contact our headquarters:

Legal Notices

We offer information as a service to you. The provided information is based on your requirements and we make every effort to ensure its quality. You agree that you are responsible for using independent analysis and evaluation in designing intended products, and we provide reference designs for illustrative purposes only. Before using any hardware, software or service guided by this document, please read this notice carefully. Even though we employ commercially reasonable efforts to provide the best possible experience, you hereby acknowledge and agree that this document and related services hereunder are provided to you on an “as available” basis. We may revise or restate this document from time to time at our sole discretion without any prior notice to you.

Use and Disclosure Restrictions

License Agreements
Documents and information provided by us shall be kept confidential, unless specific permission is granted. They shall not be accessed or used for any purpose except as expressly provided herein.

Copyright
Our and third-party products hereunder may contain copyrighted material. Such copyrighted material shall not be copied, reproduced, distributed, merged, published, translated, or modified without prior written consent. We and the third party have exclusive rights over copyrighted material. No license shall be granted or conveyed under any patents, copyrights, trademarks, or service mark rights. To avoid ambiguities, purchasing in any form cannot be deemed as granting a license other than the normal non-exclusive, royalty-free license to use the material. We reserve the right to take legal action for noncompliance with abovementioned requirements, unauthorized use, or other illegal or malicious use of the material.

Trademarks
Except as otherwise set forth herein, nothing in this document shall be construed as conferring any rights to use any trademark, trade name or name, abbreviation, or counterfeit product thereof owned by Quectel or any third party in advertising, publicity, or other aspects.

Third-Party Rights
This document may refer to hardware, software and/or documentation owned by one or more third parties (“third-party materials”). Use of such third-party materials shall be governed by all restrictions and obligations applicable thereto.

We make no warranty or representation, either express or implied, regarding the third-party materials, including but not limited to any implied or statutory, warranties of merchantability or fitness for a particular purpose, quiet enjoyment, system integration, information accuracy, and non-infringement of any third-party intellectual property rights with regard to the licensed technology or use thereof. Nothing herein constitutes a representation or warranty by us to either develop, enhance, modify, distribute, market, sell, offer for sale, or otherwise maintain production of any our products or any other hardware, software, device, tool, information, or product. We moreover disclaim any and all warranties arising from the course of dealing or usage of trade.

Privacy Policy

To implement module functionality, certain device data are uploaded to Quectel’s or third-party’s servers, including carriers, chipset suppliers or customer-designated servers. Quectel, strictly abiding by the relevant laws and regulations, shall retain, use, disclose or otherwise process relevant data for the purpose of performing the service only or as permitted by applicable laws. Before data interaction with third parties, please be informed of their privacy and data security policy.

Disclaimer

a) We acknowledge no liability for any injury or damage arising from the reliance upon the information.
b) We shall bear no liability resulting from any inaccuracies or omissions, or from the use of the information contained herein.
c) While we have made every effort to ensure that the functions and features under development are free from errors, it is possible that they could contain errors, inaccuracies, and omissions. Unless otherwise provided by valid agreement, we make no warranties of any kind, either implied or express, and exclude all liability for any loss or damage suffered in connection with the use of features and functions under development, to the maximum extent permitted by law, regardless of whether such loss or damage may have been foreseeable.
d) We are not responsible for the accessibility, safety, accuracy, availability, legality, or completeness of information, advertising, commercial offers, products, services, and materials on third-party websites and third-party resources.
Copyright © Quectel Wireless Solutions Co., Ltd. 2024. All rights reserved.

About the Document

Revision History

Revision Date Author Description
2023-11-09 Berg LIU/ Sven DING Creation of the document
1.0 2024-08-13 Howie DONG First official release

Introduction

Quectel BC680Z-EU module supports capturing the module-side log through LogView. If you encounter problems while debugging or using the module, you can use this tool to capture the module log for further analysis and problem location.

This document mainly introduces how to use LogView to capture the log through the debug port of Quectel module, including saving the captured log, importing the log and viewing the log.

Tool Usage

This chapter outlines how to use LogView to capture the module log, and how to save, import and view the log. Double-click LogView.exe in the LogView program directory to open LogView.

NOTE
The first time you use LogView, you need to install the C++ runtime environment. Double-click vcredist_x86.exe in the LogView program directory to install the C++ runtime environment. If the C++ runtime environment is already installed, you can ignore this note.

Tool Description

Connection

  1. Connect the module to PC via a USB cable, open the Device Manager, and view the serial ports as shown below. For the Quectel BC680Z-EU TE-B, the third COM port is typically used to capture the log.
    Communication Port
    Figure 1: Communication Port
  2. To prevent any anomalies during the log capture process, before connecting the module with LogView, import the loginfo.info file, which can be obtained from the corresponding version package.
    The import procedure is as follows: select “Setting” → “Load Log Inf”.
    Import loginfo.info
    Figure 2: Import loginfo.info
  3. For the BC680Z-EU module, select XY1200 in chip version of the LogView when using LogView to capture the module-side log. For other modules, contact Quectel Technical Support to select the chip version. Select method: Choose “Common” → “Chip Version”.
    Select Chip Version
    Figure 3: Select Chip Version
  4. After the hardware is correctly connected, double-click to open LogView, and click on “Connect” as indicated by the red box in the following figure.
    Connection Setting Interface
    Figure 4: Connection Setting Interface
    The main interface appears as shown in the following picture. In “Port List”, select the corresponding log port and click “OK”.
    Select Port
    Figure 5: Select Port

Interface Description

The LogView main interface includes the title bar, menu bar, tools bar, view bar, message parsing bar, and air message bar.
LogView Main Interface
Figure 6: LogView Main Interface

Table 1: LogView Main Interface

Name Description
Title bar Displays different content depending on the state.
  1. Idle state: LogView is displayed;
  2. Connected state: Serial port number is displayed;
  3. During playback: Text directory is displayed.
Menu bar Entry to basic functions. Relevant functions can be accessed through the menu bar.
Tools bar Entry to common functions. You can quickly find the function you want to operate through the tools bar.
View bar Displays the log information and allows log filtering based on filtering conditions.
Message parsing bar Area to display the parsed message.
Air message bar Area to display the air message.

Log Capturing

After the module is successfully connected, log capture begins.
Log Capturing
Figure 7: Captured Log Message

Log Saving

Automatic Log Saving
You can configure automatic saving log, and set the file size, the file duration and the maximum number of files. You can also set a temporary cache path and the loop mode, where the maximum number of saved files is effective only in the loop mode. Click “Setting” → “File Store Setting”:
Automatic Log Saving
Figure 8: Automatic Log Saving
Automatic Log Saving Configuration
Figure 9: Automatic Log Saving Configuration

Manual Log Saving

There are 2 ways to save the log manually:

  1. Once log capture is complete, click “Connect” to disconnect, then click “SaveAs”, choose a save path and file name as prompted, and click “Save”.
    Disconnection
    Figure 10: Disconnection
    Method 1 to Save Log Manually
    Figure 11: Method 1 to Save Log Manually
  2. Once log capture is complete, click “Reset”, then select “Yes”, and choose the save path as prompted.
    Method 2 to Save Log Manually
    Figure 12: Method 2 to Save Log Manually

Log Importing

After the log is saved, you can import it into Logview for viewing. Click “Open File” to import the log file, or directly drag the log file into the view bar for viewing.
Import Log File
Figure 13: Step 1 to Import the Log File
 Import Log File
Figure 14: Step 2 to Import the Log File

Log Viewing

Log Searching
Press “Ctrl” + “F” on the keyboard in the log display area to open the “Find…” dialog. Enter a keyword to search for, and click “Find All” to extract log that match the condition separately. Click “Find” to search upwards or downwards as needed. The “Search Down” and “SearchUp” functions are the same as “Find”.
Log Searching
Figure 15: Log Searching

Log Filtering
Right-click the shortcut in the log display area, and select the “Find All” function, which includes “Item”, “Type”, “Source”, “Message”, and “Advance” options.
Log Selecting
Figure 16: Log Selecting

  • Item: Filter logs to show only those with the same item as the selected log.
  • Type: Filter logs to show only those with the same type as the selected log.
  • Source: Filter logs to show only those from the same source thread as the selected log.
  • Message: Filter logs based on message type.
  • Advance: Filter log based on conditions; open the advanced filter dialog, set the conditions, and click “Find All” to select log that meets the conditions.
    Log Filtering
    Figure 17: Log Filtering

Quick View
To help locate and track the log information of application core, the tool provides a quick button “User Log” that outputs only the application core log. You can also choose the log related to Platform CP, Platform AP, PS, or PHY as needed.
Log Quick View
Figure 18: Log Quick View

Log Synchronizing
Clicking “PS” in the tool opens the PS layer log in a new sub-window. Double-clicking the sub-window log, the log is synchronized to the corresponding log in the main window. The sub-window displays information filtered from the main window.
Log Synchronizing
Figure 19: Log Synchronizing

Appendix Reference

Table 2: Terms and Abbreviations

Abbreviation Description
AP Application Processor
COM Communication
CP Communication Processor
PC Personal Computer
PHY Physical Layer
PS Packet-Switched
USB Universal Serial Bus

Quectel Wireless Solutions Co., Ltd.
Building 5, Shanghai Business Park Phase III (Area B), No.1016 Tianlin Road, Minhang District, Shanghai 200233, China
Tel: +86 21 5108 6236
Email: info@quectel.com

Or our local offices. For more information, please visit:
http://www.quectel.com/support/sales.htm.

For technical support, or to report documentation errors, please visit:
http://www.quectel.com/support/technical.htm.
Or email us at: support@quectel.com.

QUECTEL logo

Documents / Resources

QUECTEL NB-IoT Module Series Elecom Electronics Supply [pdf] User Guide
NB-IoT Module Series Elecom Electronics Supply, NB-IoT Module Series, Elecom Electronics Supply, Electronics Supply

References

Leave a comment

Your email address will not be published. Required fields are marked *