Skip to main content

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 or AT serial commands. 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

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).

GNSS Configuration (Shared with STL)​

  • 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
  • stlMode: Sets the STL Mode, such as STATIC or DYNAMIC
  • stlSens: Sets the STL Sensitivity, such as LOW, MED or HIGH
info

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

IO Configuration​

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

  • IOtype: Defines the type of I/O. Not currently used and set to NONE.

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).

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.

Low Power Mode​

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

Last updated on