Quectel BG96 Developer'S Manual Download

Page: 41 / 90

AT+ETMCFG=mqtt,keepalive,1800

ETMCFGCHECK – checks if a new ETM configuration file is
available

This command checks the

updateurl

for a new configuration file.

Type

Syntax

Returned Result

Execute

AT+ETMCFGCHECK

+ETMCFGCHECK:checking...

+ETMCFGCHECK:complete

If a new configuration file needs to be applied, the

following URC will also appear:

+ETM: REBOOT REQUIRED

You must reboot the system as soon as possible.

ERROR

– the command failed.

Example

AT+ETMCFGCHECK

+ETMCFGCHECK:checking...

+ETMCFGCHECK:complete

Eseye-enabled Quectel BG96 module Developer Guide v1.8

ETM Management AT commands

Summary of Contents for BG96

Page 1: ...Eseye enabled Quectel BG96 module Developer Guide Document 8618 v1 8...

Page 2: ...this document and assumes no responsibility for any errors that may appear in the document nor does it make a commitment to update the information contained herein For the most current product informa...

Page 3: ...he AnyNet IRIS Welcome page 8 About the required AWS IAM user for AnyNet IRIS 9 Recommended reading 9 Creating a dedicated IAM user account for AnyNet IRIS 9 Required IAM Managed Policies 11 Attaching...

Page 4: ...mmands 44 EMQ publish a message to singletopic 45 EMQPERSIST report a set value to the device shadow 46 EMQPUBOPEN create a publish message topic 48 EMQPUBCLOSE remove a publish message topic 50 EMQPU...

Page 5: ...ng Linux USB drivers 76 Downloading the required files for Linux 76 Installing the USB drivers 77 Updating the modem firmware 77 Installing ETM files on the Quectel BG96 module using Linux 78 Updating...

Page 6: ...me that your thing is designed to transmit data over cellular networks You must have knowledge of AT command and cellular modem usage for data communications If you want to connect with other cloud pr...

Page 7: ...performing the mouse action Cross reference Title and page Cross references appear in italics for example For more information see Copyright on page ii Select the cross reference to view it Hyperlink...

Page 8: ...example Eseye uses the MIKROE LTE IoT 2 click featuring an Eseye enabled Quectel BG96 module Product ID MIKROE 3144 For information about MIKROE products see the MikroElektronika website www mikroe c...

Page 9: ...le devices so no hardware interfacing is specified except for PWRKEY and the main AT UART and DTR line if power control is required Do not disconnect the power supply to the Quectel BG96 module at any...

Page 10: ...Bits 8 Parity None Stop Bits 1 Flow Control None Send the following AT command to enable MQTT AT ETMSTATE startmqtt If the configuration file operation mode is set to mqtt then ETM automatically star...

Page 11: ...mation see Provisioning the Quectel BG96 module on page 23 6 Use a terminal emulator to send commands to the Quectel BG96 module For information about setting up the terminal emulator see Connecting t...

Page 12: ...for AWS IoT SaaS product see Required IAM Managed Policies For information about the IAM permissions you need to use the AnyNet Cellular Connectivity for AWS IoT SaaS product see Required IAM permiss...

Page 13: ...Cellular Connectivity for AWS IoT below 3 Within your AWS root account create a mandatory dedicated AWS IAM user account for AnyNet IRIS For more information see Creating a dedicated IAM user account...

Page 14: ...install and configure AnyNet IRIS If you previously subscribed to AnyNet Cellular Connectivity for AWS IoT and did not download the AnyNet IRIS executable then you will need to return to the AnyNet Ce...

Page 15: ...arning may appear about needing License Manager SLR to see license entitlements This does not affect the AnyNet Cellular Connectivity for AWS IoT installation 5 Select the AnyNet Cellular Connectivity...

Page 16: ...ess see Providing access to AWS accounts owned by third parties Recommended reading For information about AWS security best practices see Security best practices in IAM To learn how to create customer...

Page 17: ...nyNet IRIS will use these security credentials to perform necessary requests against your AWS account You can view and download the Secret access key once only If you forget the Secret access key you...

Page 18: ...ervice when AWS IoT things are created or deleted AmazonS3FullAccess Enables CloudFormation template retrieval and CloudTrail S3 bucket creation AWSCloudFormationFullAccess Required for both the Found...

Page 19: ...owing URL https console aws amazon com iam 3 In the left hand navigation menu select Users The AnyNet IRIS user you created is listed 4 Select the AnyNet IRIS IAM user name For example select anynetus...

Page 20: ...onFullAccess AWSCloudTrail_FullAccess AWSIoTFullAccess AWSIoTLogging IAMFullAccess If you select the wrong policy clear the check mark alongside it 10 Select Next Review The selected policies are disp...

Page 21: ...n iam AddUserToGroup iam AttachUserPolicy iam CreateUser iam DeleteUser iam DeleteUserPermissionsBoundary iam DeleteUserPolicy iam DetachUserPolicy iam PutUserPermissionsBoundary iam PutUserPolicy iam...

Page 22: ...icy 17 Select Create policy The IAM user account Permissions policies updates to include the inline policy After you have completed creating the IAM user and have attached the essential policies next...

Page 23: ...y AnyNet IRIS installs and opens 3 Next configure AnyNet IRIS For more information see Configuring AnyNet IRIS on the next page Installing AnyNet IRIS for macOS 1 On the AnyNet IRIS Welcome page selec...

Page 24: ...r computer on page 10 Do not use your AWS root user account to configure AnyNet IRIS For more information see Creating a dedicated IAM user account for AnyNet IRIS If required follow the onscreen inst...

Page 25: ...lect the Confirm subscription link to verify that email address The AWS Subscription confirmed page appears for each subscription The AnyNet IRIS Email Notifications page updates indicates successful...

Page 26: ...tion process is complete on your AWS account Eseye connects your thing to AWS over a cellular network To purchase the requisite SIM cards search for AnyNet SIM on Amazon com You need a AnyNet Secure S...

Page 27: ...AnyNetThingType For information about the AnyNetThingType see https docs eseye com Content General AnyNetThingType htm 9 In the Searchable attribute section leave the ActionRequest Value field blank...

Page 28: ...Ensure you have connected the terminal antenna The antenna connects to the MAIN Antenna connection point on the LTE IoT 2 click To power on and establish your cellular connection 1 Fully insert the mi...

Page 29: ...luminates on the USB adapter and three LED lights illuminate on the LTE IoT 2 click The LTE IoT 2 click connects to a cellular network using the Quectel BG96 module and is now ready to receive securit...

Page 30: ...rtificate delivery progress The certificate is delivered after the status changes from Pending to Provisioned You can also view smart terminal message consumption and location information Provisioning...

Page 31: ...icated devices We recommend that you edit or replace the installed default policy Only Allow required actions or Deny actions that the thing never performs Use a resource control for each action to re...

Page 32: ...range you will need to update the modem software For more information see Updating the modem software on page 79 Send an AT ETMSTATE startmqtt CR command to enable the MQTT protocol Ensure you know th...

Page 33: ...rs listed in the Subscriptions panel 3 Publish information to the topics you created in the Quectel BG96 module You can send a maximum payload of 1000 characters to AWS a Using the terminal emulator t...

Page 34: ...ished messages If you can see the messages in AWS then your thing can successfully publish data into the cloud through the Quectel BG96 module Next test that the cloud can publish messages to your thi...

Page 35: ...ur thing 1 Create two subscribe topics in the Quectel BG96 module a Using a terminal emulator type at emqsubopen 0 SubscribeFromCloud0 return at emqsubopen 1 SubscribeFromCloud1 return b Check that th...

Page 36: ...sh box type SubscribeFromCloud1 ThingName f In the coding window replace Turn heating on with Heat for 1 hour g Select Publish View the AWS messages in the terminal emulator in the following format EM...

Page 37: ...and updated state information to a shadow and your thing can synchronize its state when it connects For information about enabling shadow use see EMQPERSIST report a set value to the device shadow on...

Page 38: ...m type at return The terminal emulator will return any of the following OK the modem is connected and ready to communicate with the host ERROR the modem cannot communicate with the host Contact the mo...

Page 39: ...displays responses only CR LF is intentionally omitted The response may include OK indicates the command executed with no errors ERROR indicates an invalid command or that the command line was too lon...

Page 40: ...se is sent as multiple URCs with each line beginning ETMCFG get returns the current configuration value for the requested parameters default resets the configuration file values to the default firmwar...

Page 41: ...ute AT ETMCFGCHECK OK ETMCFGCHECK checking ETMCFGCHECK complete If a new configuration file needs to be applied the following URC will also appear ETM REBOOT REQUIRED You must reboot the system as soo...

Page 42: ...WCONF OK or ERROR indicates that the host firmware has not successfully downloaded onto the Quectel BG96 module Ensure AT ETMHFWGET completed successfully and you have seen the ETMHFWGET available URC...

Page 43: ...f the current device OK ETMHFWGET checking ETM is searching the configuration file host updateurl for new firmware For more information see updateurl on page 65 ETMHFWGET none no host firmware is avai...

Page 44: ...e host firmware image in bytes checksum is the 16 bit XOR checksum of the entire image in hexadecimal format If both imagesize and checksum are 0 no firmware image exists in the flash memory After rea...

Page 45: ...Example To read 48 bytes in 16 byte chunks AT ETMHFWREAD 0 16 ETMHFWREAD 0 16 hexdata OK AT ETMHFWREAD 16 16 ETMHFWREAD 16 16 hexdata OK AT ETMHFWREAD 32 16 ETMHFWREAD 32 16 hexdata OK Eseye enabled Q...

Page 46: ...he current version of Eseye software on the selected modem value OK where value is the requested value such as the SIM ICCID For service 0 not registered 1 registered For busy returns a hexadecimal va...

Page 47: ...ETMRESET The module reboots OK ETM REBOOTING NORMAL POWER DOWN RDY APP RDY ETM SYSSTART ETM IDLE or ERROR Example at etmreset OK ETM REBOOTING NORMAL POWER DOWN RDY APP RDY ETM SYSSTART ETM IDLE Eseye...

Page 48: ...connection 3 is establishing end to end security of data using the Transport Layer Security protocol 4 this state is currently unused 5 is establishing a connection to AWS in order to transfer data 6...

Page 49: ...rtmqtt start AnyNet Secure MQTT application startudp start UDP telemetry application stop stop UDP telemetry application Use this to cleanly shutdown before power off Example AT ETMSTATE 0 OK Eseye en...

Page 50: ...update_ autoreboot in the configuration file For more information see Using the Quectel BG96 module configuration file on page 62 ETM REBOOT REQUIRED The modem has received an update and needs to res...

Page 51: ...onnects to the broker as a clean session All publish messages are queued in a non volatile flash memory until they are sent to the broker For QoS 1 messages ETM waits for a puback from the broker befo...

Page 52: ...ent as text with no modification The maximum payload length is 1000 characters All characters must be printable If pubdata is contained within quotes it is handled as either ASCII hex or text ETM hand...

Page 53: ...and filters out the containing objects Presents the host with the state object JSON content only sent via URC The host only sends the content of the reported object AWSSHADOW complete mode The host s...

Page 54: ...for reported and desired text reported key value desired key value is sent as state reported key value desired key value For complete mode The complete JSON data for the shadow update topic is require...

Page 55: ...Maximum length 32768 characters 32kB for ASCII hex this means 500 bytes of binary data For JSON escaped characters count as 1 character null is an empty publish topic The Quectel BG96 module does not...

Page 56: ...e AT ETMSTATE startmqtt command to enable MQTT Example AT EMQPUBOPEN 1 PublishToCloud1 OK EMQPUBOPEN 1 0 AT EMQPUBOPEN 0 PublishToCloud0 AWSThingName 1 PublishToCloud1 AWSThingName OK 49 Eseye enabled...

Page 57: ...o the selected index number or the command will return an error OK EMQPUBCLOSE 0 7 status or ERROR EMQPUBCLOSE 0 7 status where 0 7 is the publish index number you selected from the range status is ei...

Page 58: ...If pubdata is contained within quotes it is handled as either ASCII hex or text ETM handles pubdata as ASCII hex if it contains an even number of valid ASCII hex characters 0 9 a f A F ASCII hex is c...

Page 59: ...e 0 1 2 and so on are the index numbers subscribetopicn is the unique name for each subscribe index AWSthingnameA is the unique name for the thing that you defined in AWS Maximum length 32768 characte...

Page 60: ...ribe topic 1 AWS rejected the subscribe request 2 socket already in use or ERROR the command failed Check you have sent the AT ETMSTATE startmqtt command to enable MQTT Example AT EMQSUBOPEN 1 Subscri...

Page 61: ...st have already subscribed to the selected index number or the command will return an error OK EMQSUBCLOSE 0 7 status or ERROR EMQSUBCLOSE 0 7 status where 0 7 is the subscribe index number you select...

Page 62: ...gletopic use len is the length of the incoming data data is the received data in either ASCII hex format or as text depending on both the urcautoformat setting in the configuration file and if data ap...

Page 63: ...8 state key1 value1 key2 value2 metadata key1 timestamp 1573232068 key2 timestamp 1573232068 where value1 and value2 are numeric values including decimals and negative numbers Eseye enabled Quectel BG...

Page 64: ...mber ICCID This command returns the unique Integrated Circuit Card Identifier ICCID of the installed SIM card Type Syntax Returned Result Test AT CCID OK Execute AT CCID CCID SIMnumber OK where SIMnum...

Page 65: ...turned is the mode If the mode 0 the following response occurs CREG 0 regStatus OK If the mode 1 the following response occurs CREG 1 regStatus OK If the mode 2 the following response occurs CREG 2 re...

Page 66: ...or ERROR the command failed Write AT CREG Mode where Mode is either 0 Disable network registration unsolicited result code You will need to manually check the network registration status 1 Enable netw...

Page 67: ...elements the modem will automatically return a response Factors contributing to SIM failure to register on the network may include Missing network coverage Denied network access No valid roaming agre...

Page 68: ...ecute AT CSQ CSQ rssi ber OK where rssi is either 0 113dBm or less 1 111dBm 2 30 109 53dBm 31 51dBm or greater 99 Not known or not detectable ber is either 0 7 between 0 2 and 12 8 For more informatio...

Page 69: ...uration file using either http https or tftp You can trigger an update using either SMS MQTT or AT command The ini file is divided into sections denoted by square brackets Each section has parameters...

Page 70: ...an OTA update is processed either 0 automatic reboot disabled If you disable this parameter the ETM REBOOT REQUIRED URC will appear after an update requiring the host to tell ETM when to reboot To ap...

Page 71: ...This is a Quectel BG96 module setting Refer to the Quectel documentation for more information nwscanseq Consult with Eseye before changing this parameter Radio Access Technology RAT search sequence 0...

Page 72: ...IP port Default 80 updateurl Host firmware update URL either http https or tftp If this parameter is not set it is not included in the configuration file config Configuration file update parameters u...

Page 73: ...is discarded if the client disconnects gracefully If this parameter is not set it is not included in the configuration file mqttlwtqos Last will and testament LWT message QoS defining the guarantee o...

Page 74: ...ore times singlesubtopic Predefined topic for single subscription systems If this parameter is not set it is not included in the configuration file singlesubtopicqos Quality of Service QoS for single...

Page 75: ...the received payload is binary data then the URC data is sent as ASCII hex udp UDP parameters port UDP IP port Default 12401 url UDP IP address sms SMS parameters enable For configuring SMS handling e...

Page 76: ...Section Parameter Definition default 69 Eseye enabled Quectel BG96 module Developer Guide v1 8 Using the Quectel BG96 module configuration file...

Page 77: ...he device with a new SIM and recreate it as a new thing within AWS then any existing security information in the keystore is replaced by the new certificates and a new private key AWS security complia...

Page 78: ...no network connection and protects against data loss in the event of a power failure Before you begin You need A Windows 10 computer version 1909 or later or up to date Linux system with administrato...

Page 79: ...lling ETM Quectel EFS Explorer for Windows ETM application binary bin and ini files If you are using Linux QFirehose for Linux If you are installing ETM QExplorer for Linux and Android ETM application...

Page 80: ...version _Windows zip EseyeTelemetryModule_ version _ma zip which contains the ETM application bin and ini files Installing the Windows USB drivers To install the Windows USB drivers 1 In the extracte...

Page 81: ...aunch the application 2 In the COM Port drop down list select the port number that matches the Quectel USB DM Port number 3 In the Baudrate drop down list select 460800 4 Select Load FW Files 5 In the...

Page 82: ...locate and run QEFS_Explorer exe to launch the application 4 In QEFS Explorer on the left hand side select 5 If the Please Select DM Port dialog box appears select File Device Quectel USB DM Port to...

Page 83: ...1 Using the Linux command terminal run sudo dmesg grep tty If Linux correctly recognized the Quectel BG96 module then four USB interfaces are listed in consecutive order for example If less than four...

Page 84: ...install the USB drivers 1 Using the command terminal run uname r 2 Note your Linux kernel version 3 Navigate to the correct extracted subfolder Quectel_LTE_5G_Linux_USB_Driver_ V version kernelversio...

Page 85: ...ke This command compiles QExplorer If it is successful you will see the QExplorer file 3 Run sudo QExplorer f EseyeTelemetryModule bin where EseyeTelemetryModule bin is the path to the supplied ETM bi...

Page 86: ...flash memory and send a URC to the host indicating that new software is available The host then reads the software image in chunks using AT commands A checksum is provided to ensure the copy from ETM...

Page 87: ...firmware image file from Eseye Contact Support for more information support eseye com Creating a JSON job description file 1 Create a UTF 8 encoded JSON job description file for the firmware update T...

Page 88: ...ates the ETM configuration file The location parameter contains the new configuration file URL host_ firmware Downloads a software image for the host MCU When the download completes the host is not no...

Page 89: ...settings 12 Select Next 13 On the Advanced configurations page leave all settings as the default settings 14 Select Create to create the job and start the update process Unsubscribing from AnyNet Cell...

Page 90: ...67 53 37 Australia 61 8 9551 5200 USA 1 484 935 3130 Brazil 55 11 4950 7015 Email support eseye com UK Head office 44 1483 802501 France 33 9 87 67 53 36 Norway 47 454 62 017 South Africa 27 87 551 8...

Search results

Summary of Contents for BG96

Reviews:

Related manuals for BG96

Brands by name

Popular brands

Quectel BG96, Developer'S Manual

Search results

Summary of Contents for BG96

Reviews:

Related manuals for BG96

Brands by name

Popular brands