Skip to content

CONFIG.TXT

Boaz Feldboim edited this page Sep 2, 2023 · 16 revisions

File CONFIG.TXT resides in the root directory of the micro SD card. Various values of the software can be set by editing the content of this file. After changing the content of CONFIG.TXT the new values take in effect only after rebooting the device. The content of the file is in the following format:

[Value Name]=[Value]

The value is everything that follows the '=' (equal sign), including spaces and any other characters until the new line character '\n'. '\r' characters are ignored.

A line starting with ; at column 0 is considered as a comment line.

The default value of a variable is used in case the variable is omitted from the file.

The content of the file is as follows:

Value Name

Units

Default Value

Functionality

Comment

TimeServer String time.nist.gov The DNS name of a time server. This server is used during initialization to retrieve the current time. The server is queried using NTP.
TimeZone Minutes 0 The difference of the local time zone from GMT in minutes. A negative number is used for time zones that are west to GMT and a positive number for time zones that are east to GMT.
DST Minutes 0 The number of minutes to add to the local time during daylight saving time. Daylight saving time is set to ON or OFF in the Advanced Settings page.
DNSAvailTimeSec Seconds 300 During initialization the code is waiting for DNS queries to succeed. The queried addresses are the addresses set in the Basic Settings page. If DNS queries did not succeed during this time the code will finish initialization and will start recovery cycles.
MACAddress MAC Address
  • Wired: 00-AA-BB-CC-DE-02
  • WiFi: 00-00-00-00-00-00
  • Wired: the wired Ethernet adapter can be assigned with a MAC address. This MAC address can then be used to assign a static IP address to the device by the router.
  • WiFi: used to make the device connect to a specific access point by its MAC address. If the default value is used, the device will connect to an arbitrary access point. If there is only one access point (router) then this is not important. But if there are several access points, then it is important that each device will connect to a specific access point in order to specifically monitor and recover it.
Different functionality in case of wired ethernet and WiFi.
RouterInitTimeSec Seconds 10 It was observed that some routers when started together with the device may assign a bad IP address to the device if the wired Ethernet is initialized very soon after the router was started. So this value sets the time to wait from starting the device until the wired Ethernet adapter is initialized. Valid only in wired Ethernet adapter.
TimeUpdatePeriodMin Minutes 20 The device repeatedly queries the time server to compensate for time skews. This value sets the time between queries. Valid only in wired Ethernet adapter. When WiFi is used the time library is doing it according to logic implemented in it.
IP IP Address 0.0.0.0 The IP address to assign to the device . If set to 0.0.0.0 the router will assign the address. The address assigned by the router may vary from time to time and so it will be difficult to realize which address the device is assign with in order to access its HTML interface. So in case using the router for assigning the IP address it is advisable to configure the router to assign a static address. In case this value is other than 0.0.0.0, gateway and subnet parameters must also be set with valid values.
Gateway IP Address 0.0.0.0 The IP address of the Internet gateway. This is usually the IP address of the router. Must have a valid address in case IP address is set other than 0.0.0.0, otherwise the IP address is ignored and the router will assign an IP address to the device.
Subnet Subnet mask 0.0.0.0 This is the subnet mask value. Usually it is set to 255.255.255.0 Must have a valid value in case IP address is set other than 0.0.0.0, otherwise the IP address is ignored and the router will assign an IP address to the device.
ModemRelay GPIO Pin Number 26 The GPIO pin number for switching the modem power. This must be 26 if the proposed PCB is used. Ignored in case of single device configuration (see below).
RouterRelay GPIO Pin Number 25 The GPIO pin number for switching the router power. This must be 25 if the proposed PCB is used.
SingleDevice Boolean false The device can be configured to recover only one device. This is done by setting the value to true. For more information about this configuration see Controlling a Single Device wiki page
DeviceName String Router It is possible to rename the Router with a different name such as Access Point or anything else. This was mainly done for the case of single device configuration, but it can be used regardless.
SkipRouterTime Seconds 3600 The recovery logic is set so usually router recovery is first attempted and if connectivity is not resumed then modem recovery is attempted. This logic is modified to attempt modem recovery first if connectivity is lost sooner than this configuration value after a successful router recovery. This is done in order to overcome the situation where router recovery resumes Internet connectivity for a short time and then connectivity is lost again and only modem recovery can resume connectivity for longer time.
SSID String The WiFi SSID to connect to. Only valid when WiFi is used.
Password String The password to use for connecting to the WiFi. Only valid when WiFi is used.
HardResetPeriodDays Days 3 Number of days between hard resets.
HardResetTime Time (hh:mm) 3:00 The time when to initiate hard reset. The time is always in 24 hours format.