Skip to main content

📣 Firmware Update Release:
Firmware Version v0.19 is now released! Please follow the link here or update via Cloudloop Device Manager.

User Configuration Guide for user.cfg

The user.cfg file is used to configure various settings for the RockREMOTE Pro. This configuration file allows users to control settings related to serial communication, I/O options, and position reports. It can be updated via mass storage over Type-C, over AT serial commands, over Cloudloop Device Manager and over RockCONNECT IoT Bluetooth app. Below is a description of the fields and how users can customise them to suit their needs.

Further details and instructions for transferring the configuration file to the Pro can be found here: Firmware and Config Update Process

The User Configuration will be retained following a FW update - although it is recommended to check the new user.cfg for any additions or changes.

important

It is recommended to use a JSON editor when changing the file as invalid JSON will revert to the default User Configuration file with no error reported.

Serial Communication​

The Serial section configures serial communication settings for the Pro AT interface.

  • mode: Serial communication mode such as RS232, RS4XX_FULL, RS4XX_HALF
  • baud: Baud rate for serial communication (4800, 9600, 19200 , 38400, 57600, 115200 (Default), 230400).
  • parity: Parity setting for serial communication, such as NONE. (EVEN and ODD are not implemented currently).
  • bits: Number of data bits (typically 8).
  • stop: Number of stop bits (1 or 2).

BLE Configuration​

The BLE section has the following options

  • Enabled: set true to enable (BLE module powered on) or false to disable (BLE module powered off).
  • connectionTimeout: Length of time in seconds that a connection will be maintained for with no BLE activity. (Min=60, Max=3600)

GNSS Configuration (Shared with APNT)​

  • GNSS: Configures whether the use of the builtin receiver is enabled or disabled.
    • true to enable, false to disable.
  • nmeaForwardEnabled: When set to true transforms the Physical Serial port into an NMEA sentences streaming port (VCP can still be used as an AT interface port), false disables the NMEA Forwarding
  • reportInterval: Sets the regular IMT position reporting in seconds to Cloudloop Device Manager and Cloudloop Tracking, 0 (zero) disables the regular position reporting
  • apntMode: Sets the APNT Mode, such as STATIC, DYNAMIC or AUTO
  • apntKalmanFilter: Sets the Kalman filter to MARITIME, WALKING, DRIVING or CUSTOM if apntMode is DYNAMIC
  • apntSensitivity: Sets the APNT Sensitivity, such as LOW, MED or HIGH
  • apntPowerSaving: Sets the APNT Power Saving to FAST or ECO
  • nmeaSentences: Toggles individual NMEA sentences to be shown or not
    • "GNGGA": - set true to enable or false to disable
    • "GNRMC": - set true to enable or false to disable
    • "GPGGA": - set true to enable or false to disable
    • "GPRMC": - set true to enable or false to disable
    • "GPZDA": - set true to enable or false to disable
    • "PJLTPOS": - set true to enable or false to disable
    • "PJLTSTAT": - set true to enable or false to disable
    • "PJLTSVI": - set true to enable or false to disable
    • "PJLTVEL": - set true to enable or false to disable
    • "AISVDO": - set true to enable or false to disable
  • apntFilterPosition: When set to true the position report will use the APNT position that has the lowest EPE from the last 20% of the set report interval. i.e. If set to 10min it will select the best from the last 2min. The reported GNSS timestamp will match APNT. Set to false to report without the filter applied. Available from FW version 0.19
info

For more information on APNT please refer to our RockBLOCK Pro APNT page

Sensors​

  • Enabled: set true to enable on board temperature sensing or false to disable.

Chart Plotter Settings​

  • "Chart": Allows the plotting of positions on a compatible chart plotter (i.e ZeusS3)
    • "epeScale": - Affects the size of the second circle, set from 0.5 - 10.0
    • "positionCompareTimer": - Affects the amount of time your gnss position can be outside your epescale * epe, set from 0 - 300
    • "utcDifferenceLimit": - Affects the threshold for checking for time spoofing, set from 2 - 10
    • "utcDifferenceTimer": - Affects the amount of time you're checking for time spoofing before alarming, set from 0 - 300
    • "positionValidityTimer" - Affects the amount of time you're checking for valid GNSS strings before alarming, set from 0 - 300
    • "errorCircle": - Enables or disables the inner circle, set true to enable or false to disable
    • "errorLimitCircle": - Enables or disables the outer circle, set true to enable or false to disable
info

For more information on the APNT Chart Plotter please refer to here

IO Configuration (GPIO)​

important

Requires FWv0.19+.

The IO section allows for configuration of I/O options.

  • IOtype: Defines the type of I/O. Options are NONE, DIGITAL or UNIVERSAL(Not yet implemented). In power constrained systems that do not need IO 'NONE' will reduce power consumption.
  • IOChans:
    • channelIndex e.g. 1, 2, 3, 4, The channel number.
    • channelMode:
      • "NONE": Channel disabled.
      • "digitalInput": - Standard input. Can be configured to provide a periodic value reading via IMT MO.
      • "digitalOutput": - Channel will operate as an output (open drain) controlled via IMT MO message.
      • "digitalInIntRising": - Will send an immediate(dependent on filter) value reading on rising edge. Can also report periodically.
      • "digitalInIntFalling": - Will send an immediate(dependent on filter) value reading on falling edge. Can also report periodically.
      • "digitalInIntChange": - Will send an immediate(dependent on filter) value reading on both rising and falling edge. Can also report periodically.
      • "digitalOutConfirmed": - Acknowledgement of output drive will be provided as IMT MT message.
    • filter: - Sets the digital input sensitivity level. i.e. the number of milliseconds that the input will need to be stable for after change.
      • "LOW": - 200 milliseconds.
      • "MEDIUM": - 100 milliseconds.
      • "HIGH": - 50 milliseconds.
    • hystersis: - Hysteresis can be set to prevent multiple triggers at the threshold. default is 0.1 volts.
    • threshold: - Digital inputs can be given varying thresholds. Default is 1.5 volts.
    • reportCoV: - Default 0.0 NOTE the analogue input Change of Value function is not yet implemented.
    • reportPeriod: - Sets the period (In seconds) between each input report. '0' turns periodic reporting off. Default 0

Sleep Mode​

The SleepMode section configures the Pro's external sleep pin behavior.

  • SleepMode: Defines the state of the sleep mode.
    • NONE disables the use of Sleep Pin.
    • SleepModeB enables the use of Sleep Pin.
    • Refer to Power Connection Options on how to activate sleep.

IMT Configuration​

The IMT section handles the IMT (Iridium Messaging Transport topic) configuration.

  • defaultTopic: Sets the default IMT topic (e.g. 244 a.k.a RAW IMT Topic).
  • defaultTTL: Sets the default Time to Live (TTL) in seconds for IMT messages (e.g. 86400 = 1 day before a message expires).
  • serialRelayTopic: Set to 0. NOT CURRENTLY USED. Placeholder for planned future features.
  • startupEventEnabled: Toggles the Startup Events sent to Cloudloop (e.g. false disables them and true enables them)

Buzzer configuration. NOT CURRENTLY IMPLEMENTED​

The BUZZER section is reserved for future implementation of the internal buzzer feature.

  • Enabled: true or false No functional difference as the feature is not implemented.

SVI Configuration. RESERVED FOR INTERNAL TEST USE​

When necessary it is possible to obtain regular reports containing various additional sentences related to A-PNT.

danger

Changing these settings could lead to VERY high level of data consumption.

  • reportDuration: Must be Set to 0 to disable.
  • reportTopic: INTERNAL TEST USE
  • reportInterval: INTERNAL TEST USE

Reducing power consumption.​

To get the most optimal power consumption for your solution you can edit the User Configuration File to turn off features you won't be using.

danger

Tread carefully as disabling some features might mean losing access to your device!

  • Serial
    • Can be turned off by disabling it in the User Configuration File 
      • "Serial": {
          "Enabled": false,
          …
warning

By disabling Serial, the Pro will not be reachable through Serial and you will need to drop a new User Configuration File via Type-C or update Over the Air via Cloudloop Device Manager

  • LEDS
    • Can be turned off in the User Configuration File 
      • "LEDS": {
          "Enabled": false,
          …
  • BLE
    • Can be turned off in the User Configuration File (Not currently implemented so OFF by default) 
      • "BLE": {
          "Enabled": false,
          …
  • GNSS
    • Can be turned off in the User Configuration File 
      • "GNSS": {
        "Enabled": false,
        …
important

By disabling GNSS, the coordinates will have to be set manually by using the AT Serial Commands

  • Sensors
    • Can be turned off by disabling them in the User Configuration File 
      • "Sensors": {
        "Enabled": false,
        …
important

If the Sensors are disabled, the Pro will not measure Power Consumption and other metrics

Example user.cfg​

Example user.cfg can be downloaded here. Includes config additions for v0.17

Last updated on