Settings

Get Settings

Read settings from active or saved area.

• Active area: Current settings the device is working with.
• Saved area: Settings saved in non-volatile memory, applied at next startup.

GET /api/settings/active/get/?key1&key2... GET /api/settings/saved/get/?key1&key2...

Access Level: 🟨 1

Example Response:

{
    "key1": "value1",
    "key2": "value2"
}

Set Settings

Write settings to the saved area.

POST /api/settings/saved/set/

Access Level: 🟨 1

Example Request:

{
    "key": "value"
}

Response:

Empty JSON upon success.

{}

Available Settings Keys

The following keys can be used with GET and POST requests for settings.

Key	Description	Access Level
timeGmt	GMT time offset correction	🟨 1
ethernet	Ethernet interface settings	🟨 1
wifi	Wi-Fi module settings	🟨 1
ownSrv	Connection to own server	🟨 1
wgCloud	Cloud VPN connection settings	🟨 1
wgManual	Custom WireGuard VPN parameters	🟨 1
cbCloud	Cloud Modbus connection settings	🟨 1
areset	Automatic reset settings	🟨 1
protect	Device protection parameters	🟨 1
download	File server settings	🟨 1
firmware	Firmware management	🟨 1
httpd	Built-in HTTP server parameters	🟨 1
language	Interface language	🟨 1
serial	Serial port settings	🟨 1
astro	Astronomical settings (sunrise/sunset)	🟨 1
ntp	NTP time synchronization settings	🟨 1
tsMode	Daylight saving time mode	🟨 1
tsManual	Manual daylight saving time settings	🟨 1
logFlags	Logging flags	🟨 1
lora	LoRa interface settings	🟨 1
lorasensDevices	Bound LoraSens devices list	🟨 1
rmSrv	Remote control server	🟨 1
forwarding	Port forwarding table	🟨 1
tasksLogging	Programmable logic data logging settings	🟨 1
powerSaving	Power and resource saving settings	🟨 1

timeGmt

Time zone management (GMT offset).

Request Parameters:

Parameter	Type	Description
timeGmt	integer	GMT offset in 15-minute intervals (from -96 to +96).

Example Request:

{
    "timeGmt": 8
}

Note: 8 means +2 hours offset (8 × 15 minutes).

ethernet

Ethernet interface settings.

Request Parameters:

Parameter	Type	Description
ethernet	object
dhcpEnable	boolean	true — enable DHCP on Ethernet interface; false — disable.
dhcpKeepAddressEnable	boolean	true — if DHCP is enabled, keep the leased address until the new is acquired; false - forget the address after lease has expired.
dhcpAggressiveRenewEnable	boolean	true — if DHCP is enabled, shorten the address renewal intervals, to keep it leased; false - use normal renewal at 50% lease period.
macManualEnable	boolean	true — use custom MAC address.
dnssGateEnable	boolean	true — use gateway address as primary DNS.
ip	string	Ethernet interface IP address.
mask	string	Ethernet interface subnet mask.
gate	string	Ethernet interface gateway.
ipDnss	array	Array of 2 DNS server IP addresses for Ethernet.
macManual	string	Custom MAC address for Ethernet interface.

Example Request:

{
    "ethernet": {
        "dhcpEnable": true,
        "dhcpKeepAddressEnable": true,
        "dhcpAggressiveRenewEnable": true,
        "macManualEnable": false,
        "dnssGateEnable": true,
        "ip": "192.168.0.115",
        "mask": "255.255.255.0",
        "gate": "192.168.0.1",
        "ipDnss": ["8.8.8.8", "8.8.4.4"],
        "macManual": "01:02:03:04:05:06"
    }
}

wifi

Wi-Fi module settings.

Request Parameters:

Parameter	Type	Description
wifi	object
dhcpEnable	boolean	true — enable DHCP on Wi-Fi interface, false — disable DHCP
apEnable	boolean	true — enable access point mode (SSID starting wtih MC261, administrator password usually on the device label, with DHCP, address of 192.168.4.1 and HTTP server, while Modbus TCP server is unavailable), false - disable (station mode, join the external point, Modbus TCP server can be enabled)
ip	string	Wi-Fi interface IP address.
mask	string	Wi-Fi interface subnet mask.
gate	string	Wi-Fi interface gateway.
ipDnss	array	Array of 2 DNS server IP addresses for Wi-Fi.
dnssGateEnable	boolean	true — use gateway address as primary DNS.
apChannel	integer / null	Channel used in access point mode (from 1 to 13, or null for automatic channel select).
txPowerLimitPercent	integer	Transmission signal power limit, 20.5dBm * x (from 0 to 100), 0 - module is disabled.
apSsid	string	Access point name, which the device should connect to in station mode (up to 32 characters).
apPassword	string	Access point password, which the device should connect to in station mode (up to 24 characters).

Example Request:

{
    "wifi": {
        "dhcpEnable": true,
        "apEnable": false,
        "ip": "192.168.1.116",
        "mask": "255.255.255.0",
        "gate": "192.168.1.1",
        "dnssGateEnable": true,
        "ipDnss": ["8.8.8.8", "1.1.1.1"],
        "apChannel": null,
        "txPowerLimitPercent": 100,
        "apSsid": "Gateway2.4",
        "apPassword": "example-pass"
    }
}

ownSrv

Connection to own server.

New values of these parameters take effect immediately after they are written by an API request.

Request Parameters:

Parameter	Type	Description
ownSrv	object
vUid	integer / null	Virtual Modbus device address (1-255), or null to disable.
mbeRo	integer / null	Modbus exception code for access denied (1-255), or null to disable response.
mbeTo	integer / null	Modbus exception code for timeout (1-255), or null to disable response.
mbePu	integer / null	Modbus exception code for send error (1-255), or null to disable response.
ethListenPort	integer	TCP server port on Ethernet interface (1-65535).
delayForKeepaliveSec	integer / null	TCP server keep-alive time (0-36000 sec), or null to disable.
atmListenPort	integer / null	TCP server port on Wi-Fi interface (1-65535), or null to disable.
ethClientsProtocol	integer	Data protocol for Ethernet TCP server: 1 - RAW, 2 - ModbusTCP.
atmClientsProtocol	integer	Data protocol for Wi-Fi TCP server: 1 - RAW, 2 - ModbusTCP.

Example Request:

{
    "ownSrv": {
        "vUid": 111,
        "mbeRo": 1,
        "mbeTo": 11,
        "mbePu": 10,
        "ethListenPort": 502,
        "delayForKeepaliveSec": 90,
        "atmListenPort": null,
        "ethClientsProtocol": 2,
        "atmClientsProtocol": 2
    }
}

wgCloud

Cloud VPN connection settings.

Request Parameters:

Parameter	Type	Description
wgCloud	object
hostname	string	VPN server hostname (max 46 chars).
connPort	integer	VPN server TCP port (1-65535).
connMode	integer / null	Connection mode: null (disabled), 1 (Eth pref), 2 (Wi-Fi pref), 3 (Eth only), 4 (Wi-Fi only).
delayForKeepaliveSec	integer	VPN server keep-alive time (0-36000 sec).
delayForConnSec	integer	Delay between connection attempts (1-30000 sec).

Example Request:

{
    "wgCloud": {
        "hostname": "",
        "connPort": 34967,
        "connMode": 1,
        "delayForKeepaliveSec": 20,
        "delayForConnSec": 5
    }
}

wgManual

Custom WireGuard VPN settings.

Request Parameters:

Parameter	Type	Description
wgManual	object
hostname	string	VPN server hostname (max 46 chars).
connPort	integer	VPN server TCP port (1-65535).
connMode	integer / null	Connection mode: null (disabled), 1 (Eth pref), 2 (Wi-Fi pref), 3 (Eth only), 4 (Wi-Fi only).
ip	string	Device IP address in VPN network.
mask	string	Device subnet mask.
deviceKey	string	Device private key (base64).
peerPublicKey	string	Remote peer public key (base64).

Example Request:

{
    "wgManual": {
        "hostname": "",
        "connPort": 34967,
        "connMode": 1,
        "delayForKeepaliveSec": 20,
        "delayForConnSec": 5,
        "deviceIp": "10.0.0.111",
        "deviceMask": "255.255.255.0",
        "deviceKey": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
        "peerPublicKey": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
    }
}

cbCloud

Cloud Modbus connection settings.

Request Parameters:

Parameter	Type	Description
cbCloud	object
hostname	string	Server hostname (max 46 chars).
connPort	integer	Server TCP port (1-65535).
connMode	integer / null	Connection mode: null (disabled), 1 (Eth pref), 2 (Wi-Fi pref), 3 (Eth only), 4 (Wi-Fi only).
delayForKeepaliveSec	integer	Server keep-alive time (0-36000 sec).
delayForConnSec	integer	Delay between connection attempts (1-240 sec).

Example Request:

{
    "cbCloud": {
        "hostname": "",
        "connPort": 8502,
        "connMode": 1,
        "delayForKeepaliveSec": 120,
        "delayForConnSec": 5
    }
}

areset

Automatic reset settings.

Request Parameters:

Parameter	Type	Description
areset	object
delayMin	integer	Time before automatic restart (5-7200 min).
mode	integer / null	null - Disabled; 1 - Reset after delayMin uptime; 2 - Reset after delayMin of no Modbus activity.

Example Request:

{
    "areset": {
        "delayMin": 120,
        "mode": 2
    }
}

protect

Device protection parameters.

Request Parameters:

Parameter	Type	Description
protect	object
mbGateWriteEnable	boolean	false - disable write to connected Modbus devices.
mbGateReadEnable	boolean	false - disable Modbus read.
wgCloudAdminAuthEnable	boolean	true - grant Admin (🟥 2) access to all Cloud requests.
wgManualAdminAuthEnable	boolean	true - grant Admin (🟥 2) access to all WireGuard VPN requests.
passwordAdmin	string	Device administrator password (5-10 ASCII chars, no spaces).
passwordMbGateWrite	string	Password for writing to connected Modbus devices (0-10 chars). "" disables check.
passwordMbRead	string	Password for Modbus read (0-10 chars). "" disables check.

Example Request:

{
    "protect": {
        "mbGateWriteEnable": true,
        "mbGateReadEnable": true,
        "wgCloudAdminAuthEnable": true,
        "wgManualAdminAuthEnable": false,
        "passwordAdmin": "11111",
        "passwordMbGateWrite": "",
        "passwordMbRead": ""
    }
}

download

File server settings.

Request Parameters:

Parameter	Type	Description
download	object
connMode	integer / null	Connection mode: null (disabled), 1 (Eth pref), 2 (Wi-Fi pref), 3 (Eth only), 4 (Wi-Fi only).
loadRatio	integer	Download speed limit (1-50 % of max bandwidth).
delayForConnSec	integer	Delay between connection attempts (1-30000 sec).

Example Request:

{
    "download": {
        "connMode": 1,
        "loadRatio": 15,
        "delayForConnSec": 60
    }
}

firmware

Firmware management.

Request Parameters:

Parameter	Type	Description
firmware	object
checkPeriodSec	integer / null	Update check period (1-1000000 sec), or null to disable.
downloadPeriodHr	integer / null	Automatic download period (0-1439 hours), or null to disable.
updateHour	integer / null	Hour of day for automatic update (0-23), or null to disable.
automaticDowngradeEnable	boolean	false - automatic update only to a newer version.
url	string	Update source URL (1-96 ASCII chars, no spaces).

Example Request:

{
    "firmware": {
        "checkPeriodSec": 900,
        "downloadPeriodHr": 6,
        "updateHour": 3,
        "automaticDowngradeEnable": true,
        "url": "static.mcdownloads.com/firmware/mc261-5-1-current.fus"
    }
}

httpd

Built-in HTTP server parameters.

Request Parameters:

Parameter	Type	Description
httpd	object
port	integer	Web interface port (1-65535).
freeAccessSec	integer	Open access time after button press (5-3600 sec).

Example Request:

{
    "httpd": {
        "port": 80,
        "freeAccessSec": 600
    }
}

language

Interface language code.

Note: If the display does not support the specified code, English will be used.

Request Parameters:

Parameter	Type	Description
language	string	Language code: en - English; ua - Ukrainian.

Example Request:

{
    "language": "en"
}

serial

Serial interface settings.

New values of these parameters take effect immediately after they are written by an API request.

Request Parameters:

Parameter	Type	Description
serial	object
uidRange	string	Modbus UID address range (e.g., 112-255).
hdxMode	integer	Half-duplex mode: 0 - slave; 1 - master; 2 - raw mode.
charFormat	integer	Byte format: 0-5 (see Modbus section).
baudRate	integer	Baud rate (75-230400 bps).
frameMode	integer	Frame format: 0 - RTU, 1 - ASCII.
delayForRtuQ	integer	RTU character delay multiplier (2ⁿ): 0-5.
delayForRtuMs	integer	RTU response delay (0-60000 ms).
delayForAsciiMs	integer	ASCII character delay (0-60000 ms).

Example Request:

{
    "serial": {
        "baudRate": 38400,
        "charFormat": 3,
        "frameMode": 1,
        "delayForRtuMs": 200,
        "delayForAsciiMs": 1000,
        "hdxMode": 1,
        "uidRange": "112-255",
        "delayForRtuQ": 1
    }
}

astro

Astronomical settings (sunrise/sunset).

Request Parameters:

Parameter	Type	Description
astro	object
longDeg	integer	Longitude degrees (0-179).
longMin	integer	Longitude minutes (0-59).
longSec	integer	Longitude seconds (0-59).
latDeg	integer	Latitude degrees (0-179).
latMin	integer	Latitude minutes (0-59).
latSec	integer	Latitude seconds (0-59).
quadrant	integer	Quadrant: 0 - N/E; 1 - N/W; 2 - S/E; 3 - S/W.
sunZenithType	integer	Zenith type: 0 - Official; 1 - Civil; 2 - Nautical; 3 - Astronomical.

Example Request:

{
    "astro": {
        "longDeg": 30,
        "longMin": 19,
        "longSec": 0,
        "latDeg": 59,
        "latMin": 57,
        "latSec": 0,
        "quadrant": 0,
        "sunZenithType": 2
    }
}

ntp

NTP time synchronization settings.

Request Parameters:

Parameter	Type	Description
ntp	object
hostnames	array	Array of NTP server hostnames (max 20 chars each).
connMode	integer / null	Connection mode: null (disabled), 1 (Eth pref), 2 (Wi-Fi pref), 3 (Eth only), 4 (Wi-Fi only).
syncPeriodHr	integer	Synchronization period (0-240 hours).
syncDiffSec	integer	Synchronization threshold (0-180 sec).

Example Request:

{
    "ntp": {
        "hostnames": ["ntp.time.in.ua", "ntp2.stratum1.ru"],
        "connMode": 1,
        "syncPeriodHr": 24,
        "syncDiffSec": 1
    }
}

tsMode

Daylight saving time mode.

Request Parameters:

Parameter	Type	Description
tsMode	integer / null	DST Mode: null (Disabled), 1 (Brazil), 2 (UK), 3 (Germany), 4 (Greece), 5 (Jordan), 6 (Italy), 7 (Namibia), 8 (Poland), 9 (Portugal), 10 (USA), 11 (Turkey), 12 (Ukraine), 13 (Finland), 14 (France), 15 (Manual - see tsManual).

Example Request:

{
    "tsMode": 12
}

tsManual

Manual daylight saving time settings.

Request Parameters:

Parameter	Type	Description
tsManual	object
bwdDow	integer	Winter time transition day of week (1-7, Mon-Sun).
bwdHour	integer	Winter time transition hour (0-23).
bwdMonth	integer	Winter time transition month (1-12).
bwdWeek	integer	Winter time transition week (1-5, 6=last).
fwdDow	integer	Summer time transition day of week (1-7, Mon-Sun).
fwdHour	integer	Summer time transition hour (0-23).
fwdMonth	integer	Summer time transition month (1-12).
fwdWeek	integer	Summer time transition week (1-5, 6=last).

Example Request:

{
    "tsManual": {
        "bwdDow": 7,
        "bwdHour": 2,
        "bwdMonth": 10,
        "bwdWeek": 6,
        "fwdDow": 7,
        "fwdHour": 2,
        "fwdMonth": 3,
        "fwdWeek": 6
    }
}

logFlags

Logging settings.

Request Parameters:

Parameter	Type	Description
logFlags	object
atm	boolean	Wi-Fi interface logging into /LOGS/ATM.LOG file (true/false).
system	boolean	System event logging into /LOGS/SYS.LOG file (true/false).
lwip	boolean	LWIP protocol system event logging (true/false).
forwarding	boolean	Port forwarding system event logging (true/false).
wireguard	boolean	WireGuard system event logging (true/false).
tasks	boolean	Tasks programmed system event logging (true/false).
api	boolean	HTTP REST-API system event logging (true/false).
lora	boolean	LoRa interface system event logging (true/false).
restarts	boolean	Restart event logging into /LOGS/RESTARTS.LOG file (true/false).

Example Request:

{
    "logFlags": {
        "atm": true,
        "system": true,
        "lwip": false,
        "forwarding": false,
        "wireguard": true,
        "tasks": true,
        "api": true,
        "lora": false,
        "restarts": true
    }
}

lora

LoRa interface settings.

Request Parameters:

Parameter	Type	Description
lora	object
uplinkFrequencyKhz	integer	Device to МС261 transmit frequency (from 864025 to 869175)
downlinkFrequencyKhz	integer	МС261 to device transmit frequency (from 864025 to 869175)
bandwidthDivider	integer	Bandwidth divider, 1000kHz / x (2, 4, 8, 16, 24, 32, 48, 64, 96 or 128).
spreadingFactor	integer	Spreading factor (from 6 to 12).
codingRateDivider	integer	Coding rate divider, 4 / x (from 5 to 8).
txPowerLimitPercent	integer	Transmit signal power limit, 17dBm * x (from 0 to 100).
pollingPeriodMs	integer	Poll period, ms (from 50 to 5000).

Example Request:

{
    "lora": {
        "uplinkFrequencyKhz": 868175,
        "downlinkFrequencyKhz": 868100,
        "bandwidthDivider": 16,
        "spreadingFactor": 7,
        "codingRateDivider": 5,
        "txPowerLimitPercent": 100,
        "pollingPeriodMs": 500
    }
}

lorasensDevices

Bound LoraSens devices settings.

Request Parameters:

Parameter	Type	Description
lorasensDevices	array	Array of objects (from 0 to 40 devices)
did	string	Unique device identifier (acquired at bind procedure).
title	string	User device name, up to 16 characters
deviceKindCode	integer	Manufacturer’s device identifier (from 1 to 65535; 43 - LTH-1, 44 - LWG-1)
firmwareVersion	integer	Device firmware version (from 1 to 65535)
txPowerLimitPercent	integer	Minimal required transmission signal power, 17dBm * x (from 0 to 100).
password	integer	Device write password, set at bin procedure (from 0 to 2147483647).
linkPeriodSec	integer	Link seance period (from 0 to 2147483647 seconds)

Example Request:

{
    "lorasensDevices": [
        {
            "did": "139572548502",
            "title": "Sensor 15",
            "deviceKindCode": 46,
            "firmwareVersion": 17,
            "txPowerLimitPercent": 50,
            "password": 197345013,
            "linkPeriodSec": 60
        },
        {
            "did": "286593735491",
            "title": "Sensor 20",
            "deviceKindCode": 46,
            "firmwareVersion": 17,
            "txPowerLimitPercent": 50,
            "password": 1835506362,
            "linkPeriodSec": 300
        }
    ]
}

rmSrv

TCP client settings (Remote Servers).

New values of these parameters take effect immediately after they are written by an API request.

Request Parameters:

Parameter	Type	Description
rmSrv	array	Array of 3 server objects.
ip	string	Server IP address.
connPort	integer	Connection port (1-65535).
delayForRcvMs	integer	Receive delay (1-60000 ms).
delayForConnSec	integer	Delay between connections (1-30000 sec).
connMode	integer / null	Connection mode: null (disabled), 1 (Eth pref), 2 (Wi-Fi pref), 3 (Eth only), 4 (Wi-Fi only).
gateUid	integer / null	MC261 compatible gateway UID (1-255), or null if unknown.
uidRange	string	UID range (e.g., 1-110).
password	string	Password for MC261 compatible gateway.
protocol	integer	Protocol: 1 - RAW, 2 - ModbusTCP.
virtualUids	boolean	Virtual UIDs (true/false).

Example Request:

{
    "rmSrv": [
        {
            "ip": "192.168.0.102",
            "connPort": 502,
            "delayForRcvMs": 1000,
            "delayForConnSec": 20,
            "connMode": 3,
            "gateUid": 112,
            "uidRange": "1-110",
            "password": "11111",
            "protocol": 2,
            "virtualUids": false
        },
        {
            "ip": "192.168.0.113",
            "connPort": 502,
            "delayForRcvMs": 1000,
            "delayForConnSec": 20,
            "connMode": null,
            "gateUid": null,
            "uidRange": "1-255",
            "password": "",
            "protocol": 2,
            "virtualUids": false
        },
        {
            "ip": "192.168.0.114",
            "connPort": 502,
            "delayForRcvMs": 1000,
            "delayForConnSec": 20,
            "connMode": null,
            "gateUid": null,
            "uidRange": "1-255",
            "password": "",
            "protocol": 2,
            "virtualUids": false
        }
    ]
}

forwarding

Port forwarding settings (Ethernet to GSM only).

Request Parameters:

Parameter	Type	Description
fwd	array	Array of 4 forwarding objects.
listenPort	integer / null	Local listening port (null to disable, or 1-65535).
isUdp	boolean	true for UDP, false for TCP.
serverAddr	string	Remote server host address. (If listenPort: 53 & isUdp: true & serverAddr: "", uses DNS settings).
serverPort	integer	Remote server port (1-65535).

Example Request:

{
    "fwd": [
        {
            "serverAddr": "www.cameronsworld.net",
            "serverPort": 443,
            "listenPort": 443,
            "isUdp": false
        },
        {
            "serverAddr": "",
            "serverPort": 0,
            "listenPort": null,
            "isUdp": false
        },
        {
            "serverAddr": "",
            "serverPort": 0,
            "listenPort": 53,
            "isUdp": true
        },
        {
            "serverAddr": "time.google.com",
            "serverPort": 123,
            "listenPort": 123,
            "isUdp": true
        }
    ]
}

tasksLogging

Programmable logic data logging settings.

Note: Logging is only available when an SD card is installed.

Request Parameters:

Parameter	Type	Description
tasksLogging	object
format	integer / null	Log file format:
		null - logging disabled;
		1 - compact binary format .DAT;
		2 - text table .CSV with semicolon delimiter;
		3 - text table .CSV with comma delimiter;
		4 - text table .CSV with tab delimiter;
		5 - text table .CSV without headers, semicolon delimiter;
		6 - text table .CSV without headers, comma delimiter;
		7 - text table .CSV without headers, tab delimiter.
storeIntervalDays	integer / null	Period during which log files are not overwritten (logger mode).
		null - disables old data deletion (disables logger mode).
fileSizeLimitKb	integer	File size limit (minus 1 kilobyte, 0 to 65535).

Example Request:

{
    "tasksLogging": {
        "format": 2,
        "storeIntervalDays": 184,
        "fileSizeLimitKb": 1023
    }
}

powerSaving

Power and resource saving settings.

Request Parameters:

Parameter	Type	Description
powerSaving	object
bodVoltage	integer	Minimum supply voltage in mV, below which the SD card will be safely unmounted (from 0 to 24000)
delayForDisplaySavingMin	integer	Time till the display saving mode is entered (from 5 to 30).
displaySavingBrightness	integer	Brightness in the display saving mode, in percents. (from 0 to 50).

Example Request:

{
    "powerSaving": {
        "bodVoltage": 9000,
        "delayForDisplaySavingMin": 10,
        "displaySavingBrightness": 5
    }
}

Export Settings

Saves settings to a file in the root folder / of the SD card.

POST /api/cmd/settings/export/

Request Parameters:

Field	Type	Description
filename	string	Filename in FAT-32 DOS (8.3) format.

Example Request:

{
    "filename": "sgs.bin"
}

Import Settings

Loads settings from a file in the root folder / of the SD card.

POST /api/cmd/settings/import/

Request Parameters:

Field	Type	Description
filename	string	Filename in FAT-32 DOS (8.3) format.

Example Request:

{
    "filename": "sgs.bin"
}

Reset Settings

Resets all device settings to default values.

POST /api/cmd/settings/reset/

Example Request:

{}