Using AnyNet SMARTconnect™ configuration file

Eseye-enabled module operating parameters are contained in a module-specific configuration file.

The Eseye-enabled Quectel module operating parameters are contained in the configuration file, which you can find here: /datatx/eseyeconfig.ini.

You can use the configuration file to set the following parameters:

If this file does not exist, a backup configuration file is used instead: /datatx/eseyeconfig.bak. If neither file exists, AnyNet SMARTconnect™ uses internal default configuration parameters.

To display the contents of the current configuration file:

  • Send: AT+ETMCFG="show"

To save the current configuration:

  • Send: AT+ETMCFG="save"

For more information, see ETMCFG – read and write configuration file values.

To update the configuration file over the air, see Updating the modem firmware using AWS IoT jobs – Quectel module.

You can deploy the configuration 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 listed underneath it.

Section Parameter Definition
[operation] Operational parameters
  apptrace Application trace level (0-4), for Support purposes. Leave as 1 (default).
  attrace AT command trace level (0-4), for Support purposes. Leave as 1 (default).
  irqmode

Sets the interrupt request (IRQ) general-purpose input/output (GPIO) pin to reflect the AnyNet SMARTconnect™ status flag state. Use either:

"none" (default) – disables the IRQ pin

"rx_only" – sets the IRQ pin to reflect the MQTT Rx flag state, indicating when received data is queued for reading. This pin remains set (high) until all messages are read from AnyNet SMARTconnect™ application. For information about the MQTT Rx queue, see MQTT Rx Queue.

"status" – sets the IRQ pin (high) when any of the status flags is set, and clears when there is no flag set.

  irqpin

Which physical AnyNet SMARTconnect™ pin to use as the IRQ pin. Type a number from the following ranges:

4-7,18-19,22-23,26-28,40-41,64.

  nvqueuemaxsize

Maximum size (in bytes) of the NV data TX queue. Default: 2048 bytes. If the queue size is exceeded, the oldest messages are dropped.

The default size is intended for devices sending small message payloads. Increase this amount if you are using devices that send large message payloads.

For large messages, you must ensure that the maximum NV store size is at least four times the largest expected published message size, plus eight bytes for the storage header. For example, for 1000 byte messages, set a minimum nvqueuemaxsize of 4032.

  nvqueue_enable

The non-volatile memory NV queue is enabled by default to prevent message loss during a power-cycle or reboot. Use:

0 – NV queue is not enabled

1 (default) – NV queue is enabled

  nvqueuetrace Non-volatile (NV) queueing subsystem trace level (0-4), for Support purposes. Leave as 1 (default).
  mode

Operating mode, either:

mqtt

none (default)

  teletrace Data connection subsystem trace level (0-4), for Support purposes. Leave as 1 (default).
  update_autoreboot

AnyNet SMARTconnect™ will automatically reboot after 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 AnyNet SMARTconnect™ when to reboot. To apply the changes, the host must reset AnyNet SMARTconnect™ as soon as possible by sending AT+ETMSTATE="reboot".

1 (default) – automatic reboot enabled

If you enable this parameter, AnyNet SMARTconnect™ will automatically reboot after an update and issue the +ETM: REBOOTING URC. After this, the host must wait for the +ETM: IDLE URC before starting the desired telemetry mode.

[network] Network parameters
  apn Access Point Name
  apnuser APN user name
  apnpass APN password
  band

Comma-separated list of frequency bands, for example: 0xf,0x400a0e189f,0xa0e189f

This is a Quectel module setting. Refer to the Quectel documentation for more information.

  iotopmode

The network category for searching under LTE RAT.

0 (default) – LTE Cat M1

1 – LTE Cat NB1

2 – LTE Cat M1 and LTE Cat NB1

This is a Quectel module setting. Refer to the Quectel documentation for more information.

  nwscanseq

Consult with Eseye before changing this parameter.

Radio Access Technology (RAT) search sequence.

00 (default) – automatic (LTE Cat M1 to LTE Cat NB1 to GSM)

01 – GSM

02 – LTE Cat M1

03 – LTE Cat NB1

For example, 010203 will initiate a search in the following order: GSM to LTE Cat.M1 to LTE Cat.NB1.

This is a Quectel module setting. Refer to the Quectel documentation for more information.

  nwscanmode

Consult with Eseye before changing this parameter.

Configure which RATs are searched, either:

0 (default) – automatic

1 – GSM only

3 – LTE only

This is a Quectel module setting. Refer to the Quectel documentation for more information.

  tech

Preferred technology for connecting to the cellular network, either:

2G – 2G only

LTE – LTE only

any (default) – either 2G or LTE

[application] Application parameters
  fotaport Modem firmware OTA image protocol IP port. Default: 80
  fotaurl

Modem firmware OTA image URL, either: http, https, or tftp

If this parameter is not set, it is not included in the configuration file.

  updateport Application firmware update protocol IP port. Default: 80
  updateurl

Application firmware update URL, either: http, https, or tftp

If this parameter is not set, it is not included in the configuration file.

[host] Host parameters
  updateport Host firmware update protocol 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
  updateport Configuration file update protocol IP port. Default: 80
  updateurl

Configuration file update URL, either: http, https, or tftp

If this parameter is not set, it is not included in the configuration file.

[mqtt] MQTT parameters
  awsjobs

AWS jobs topics subscription and for processing jobs instructions, either:

0 – Do not subscribe to AWS jobs topics

1 (default) – Subscribe to AWS jobs topics

  awsshadow

AWS shadow mode for reporting a set value to the device shadow/twin, either:

simple (default) – Report only the content of the state reported object

complete – Report the complete JSON data

off – Do not report a set value

For more information, see EMQPERSIST – report a set value to the device shadow.

  clientid

MQTT client ID. This parameter is ignored when AnyNet SMARTconnect™ connects to Google IoT.

If this parameter is not set, it is not included in the configuration file.

  keepalive Maximum expected time (in seconds) between received keepalives before AnyNet SMARTconnect™ assumes the MQTT connection is down. Default: 1200
  mqttenablerxqueue

For enabling or disabling the MQTT Rx Queue. Either:

0 (default) – disables the queue

1 – enables the queue

For more information, see MQTT Rx Queue.

  mqttlwtmessage

LWT message for notifying subscribed clients about an unexpected loss of connection. To enable LWT, you must configure <mqttlwttopic> and <mqttlwtmessage>. Use:

<message> – the MQTT message that 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 of message delivery. Either:

0 (default) – at most once, no guarantee of message receipt

1 – the message is sent or delivered to the receiver one or more times

  mqttlwtretain

LWT message retained message flag, either:

0 (default) – message flag not enabled. This is a required setting for AWS only.

1 – message flag enabled

  mqttlwttopic

Last will and testament (LWT) topic path for notifying subscribed clients about an unexpected loss of connection. To enable LWT, you must configure <mqttlwttopic> and <mqttlwtmessage>. Use:

topic – the topic path

If this parameter is not set, it is not included in the configuration file.

  mqttrxqueuesize

The maximum number of messages that the MQTT Rx Queue can retain, up to three. Either:

1, 2, or 3 (default)

  mqttsettingstopic

Alternative to the AWS IoT shadow for configuring AnyNet SMARTconnect™ behaviour. Subscription to this single topic enables commands to be sent from the cloud broker to AnyNet SMARTconnect™ via MQTT. Use either:

settings/<topicsuffix> (default) - If the <mqttsettingtopic> parameter is not configured, then AnyNet SMARTconnect™ subscribes to the settings topic and appends the <topicsuffix> parameter.

<mqttsettingstopic>/<topicsuffix> – If the <mqttsettingtopic> parameter is configured, then AnyNet SMARTconnect™ subscribes to the MQTT settings topic name and appends the <topicsuffix> parameter.

The <mqttsettingstopic> parameter supports the following tokens:

  • $t –the cloud thingName
  • $i – the unique IMEI number for the device

For example, settingtopicname/$t. If a token is used, <topicsuffix> is not used.

  port MQTT IP port. Default: 8883
  singlepubtopic

Predefined topic for single-publish systems. The <topicsuffix> is not added as a suffix to the singlepubtopic name, however you can use a token instead.

The <singlepubtopic> parameter supports the following tokens:

  • $t –the AWS thingName
  • $i – the unique IMEI number for the device

For example: mysinglepubtopic/$t

If this parameter is not set, it is not included in the configuration file.

  singlepubtopicqos

QoS for single publish, defining the guarantee of message delivery. Either:

0 (default) – at most once, no guarantee of message receipt

1 – the message is sent or delivered to the receiver one or more times

  singlesubtopic

Predefined topic for single subscription systems. The topic name depends on <[mqtt] singlesubtopic>/<[mqtt] topicsuffix>, unless a token is used.

The <singlesubtopic> parameter supports the following tokens:

  • $t –the AWS thingName
  • $i – the unique IMEI number for the device

For example: mysinglesubtopic/$t

If this parameter is not set, it is not included in the configuration file.

  singlesubtopicqos

Quality of Service (QoS) for single subscription, defining the guarantee of message delivery. Either:

0 (default) – at most once, no guarantee of message receipt

1 – the message is sent or delivered to the receiver one or more times

  topicsuffix

Appends a topic path to the end of the requested topic to uniquely identify the thing on the broker.

thingname (default) – the cloud thingName

imei – the unique IMEI number for the device

none – the exact topic is used, with no suffix appended

If topicsuffix is not present in the configuration file, then thingname is appended on the requested topic.

  tracelevel MQTT trace level (0-4), for Support purposes. Leave as 1 (default).
  urcautoformat

For formatting URCs, either:

0 – sends all URCs as ASCII-hex within quotes

For example: '{"key1":"val1"}' will appear in a URC as '+EMQ: <id>,15\r\n"7B226B657931223A2276616C31227D"'

1 (default) – this option enables sending URCs as either ASCII-hex or text, depending on the received payload.

  • If the received payload is printable text (including JSON), then the URC data is sent as text.

    For example:

    '{"key1":"val1"}' will appear in a URC as '+EMQ: <id>,15\r\n{"key1":"val1"}'

    For JSON, the maximum payload is 1012 characters. Escaped quotes count as 1 character: \"

  • If 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, either:

0 – SMS handling disabled

1 (default) – SMS handling enabled

  tracelevel SMS trace level (0-4), for Support purposes. Leave as 1 (default).
  whitelist Comma-separated list of one or more MSISDN values from which SMS is accepted. For example: 447624499970,447624499971
[location] Location parameters
  enable

For configuring location, either:

0 (default) – location disabled

1 – location enabled; Quectel module will always try to establish a GPS/GNSS location while running

  tracelevel Location trace level (0-4), for Support purposes. Leave as 1 (default).