GET /api/settings/get/?meta&general&dateTime&display&access&recorder&network&ntp&web&modbus&vpnWireguard&channels&protection

Отримує одну або кілька груп верхнього рівня з постійними налаштуваннями.

Авторизація: Bearer.

Паролі access доступні лише для запису й не включаються до відповідей за жодного рівня доступу. Закритий ключ vpnWireguard.privateKey повертається лише для powerUser; для user значення поля — null.

Параметри запиту

Кожен ключ запиту є прапорцем, що запитує відповідну групу. Допустимі ключі:

meta, general, dateTime, display, access, recorder, network, ntp, web, modbus, vpnWireguard, channels, protection

Потрібен принаймні один ключ.
Невідомий ключ → 404 ERROR_NOT_FOUND.
Відсутні ключі → 400 ERROR_API_PARSING.
Перевищено обсяг доступної пам’яті → 507 ERROR_NO_MEMORY.

Відповідь `200`

{
  "meta": {
    "sequence": 1,
    "fwVersion": "1.0",
    "isDefault": false,
    "savedAt": "2026-04-16T15:00:00Z",
    "dataLength": 512,
    "dataCrc32": "075bcd15",
    "headerCrc32": "3ade68b1"
  },
  "general": {
    "language": "en",
    "logDebugMask": 0
  },
  "dateTime": {
    "timezoneOffset": 180,
    "dst": {
      "mode": 0,
      "deltaMin": 60,
      "startLocal": "2026-03-29T03:00:00",
      "endLocal": "2026-10-25T03:00:00"
    }
  },
  "display": {
    "contrast": 50,
    "activeBacklightPercent": 80,
    "idleBacklightEnable": false,
    "idleBacklightPercent": 20,
    "idleTimeoutSec": 300
  },
  "access": {
    "devPasswordEnable": true,
    "webUserPassEnable": true,
    "webPwrPassEnable": true,
    "modbusPasswordEnable": true
  },
  "recorder": {
    "enabled": false,
    "periodSec": 600
  },
  "network": {
    "enabled": true,
    "dhcpEnable": true,
    "dns": ["8.8.8.8", "8.8.4.4"],
    "ipAddress": "192.168.1.50",
    "subnetMask": "255.255.255.0",
    "gateway": "192.168.1.1"
  },
  "ntp": {
    "enabled": true,
    "syncPeriodSec": 3600,
    "server1": "pool.ntp.org",
    "server2": "time.google.com"
  },
  "web": {
    "enabled": true,
    "port": 80,
    "vpnTrusted": false,
    "vpnAccessLevel": 1
  },
  "modbus": {
    "enabled": false,
    "unitId": 1,
    "port": 502,
    "timeoutSec": 90,
    "protectMode": 0,
    "vpnAccessLevel": 0
  },
  "vpnWireguard": {
    "enabled": false,
    "autoConfigEnable": false,
    "autoConfigUrl": "https://overvis.io:4359/api/handshake/",
    "privateKey": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
    "address": "10.0.0.2/24",
    "peerPublicKey": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
    "peerHostname": "vpn.example.com",
    "peerPort": 51820,
    "allowedIps": ["0.0.0.0/0", "0.0.0.0/0"],
    "keepaliveSec": 25
  },
  "channels": {
    "filterLevel": 1,
    "items": [
      {
        "enabled": true,
        "sensorTypeId": 1,
        "userOffset": 0,
        "ptcMinikaNominal": 0,
        "linked": 0
      }
    ]
  },
  "protection": {
    "trip": {
      "delaySec": 1,
      "channels": [{ "threshold": 120, "hysteresis": 5 }]
    },
    "alarm": {
      "delaySec": 1,
      "channels": [{ "threshold": 100, "hysteresis": 5 }]
    },
    "fan": {
      "mode": 1,
      "delaySec": 1,
      "channels": [{ "threshold": 80, "hysteresis": 5 }]
    },
    "fault": {
      "delaySec": 1
    }
  }
}

Повертаються лише явно запитані групи.

Група `meta`

Поле	Тип	Опис
`sequence`	число	Порядковий номер збереження налаштувань
`fwVersion`	рядок	Версія прошивки, яка створила знімок
`isDefault`	логічний	Налаштування за замовчуванням
`savedAt`	рядок	Час останнього збереження (ISO 8601 UTC)
`dataLength`	число	Довжина даних
`dataCrc32`	рядок	CRC32 даних (шістнадцяткове число, 8 символів)
`headerCrc32`	рядок	CRC32 заголовка (шістнадцяткове число, 8 символів)

Група `general`

Поле	Тип	Опис
`language`	рядок	Мова інтерфейсу
`logDebugMask`	число	Бітова маска модулів журналу налагодження (`bit0` = WireGuard)

Група `dateTime`

Поле	Тип	Опис
`timezoneOffset`	число	Зміщення часового поясу у хвилинах
`dst`	об’єкт	Налаштування сезонного переведення годинника
`dst.mode`	число	Режим DST
`dst.deltaMin`	число	Величина зміщення у хвилинах
`dst.startLocal`	рядок	Початок DST (місцевий час)
`dst.endLocal`	рядок	Завершення DST (місцевий час)

Група `display`

Поле	Тип	Опис
`contrast`	число	Контрастність
`activeBacklightPercent`	число	Яскравість активного підсвічування, %
`idleBacklightEnable`	логічний	Чи зменшується яскравість підсвічування під час бездіяльності
`idleBacklightPercent`	число	Яскравість підсвічування під час бездіяльності, %
`idleTimeoutSec`	число	Час бездіяльності до зменшення яскравості, секунд

Група `access`

Поле	Тип	Опис
`devPasswordEnable`	логічний	Вимагати пароль під час входу до локального меню
`webUserPassEnable`	логічний	Вимагати пароль Web-доступу рівня `user`
`webPwrPassEnable`	логічний	Вимагати пароль Web-доступу рівня `powerUser`
`modbusPasswordEnable`	логічний	Вимагати пароль для розблокування захищених операцій Modbus TCP

Поля devPassword, webUserPass, webPwrPass і modbusPassword навмисно вилучено з відповіді. API не розкриває ані збережені паролі, ані факт установлення власного значення. Клієнти мають визначати стан захисту лише за прапорцями ...PasswordEnable. На рівні user ці прапорці повертаються зі значенням null; їхні значення доступні для powerUser.

Група `recorder`

Поле	Тип	Опис
`enabled`	логічний	Реєстрацію температури увімкнено
`periodSec`	число	Період записування у секундах

Група `network`

Поле	Тип	Опис
`enabled`	логічний	Ethernet увімкнено
`dhcpEnable`	логічний	DHCP увімкнено
`dns`	масив рядків	DNS-сервери
`ipAddress`	рядок	Статична IP-адреса
`subnetMask`	рядок	Маска підмережі
`gateway`	рядок	Шлюз

Група `ntp`

Поле	Тип	Опис
`enabled`	логічний	NTP увімкнено
`syncPeriodSec`	число	Період синхронізації (секунди)
`server1`	рядок	Основний NTP-сервер
`server2`	рядок	Резервний NTP-сервер

Група `web`

Поле	Тип	Опис
`enabled`	логічний	Web-сервер увімкнено
`port`	число	Порт HTTP
`vpnTrusted`	логічний	Довіряти Web-доступу через VPN
`vpnAccessLevel`	число	Доступ через VPN: `0` = стандартна авторизація за паролем, `1` = user, `2` = powerUser

Група `modbus`

Поле	Тип	Опис
`enabled`	логічний	Modbus TCP увімкнено
`unitId`	число	Ідентифікатор пристрою
`port`	число	Порт TCP
`timeoutSec`	число	Час очікування (секунди)
`protectMode`	число	Режим захисту: `0` = немає, `1` = захист від запису, `2` = захист від читання та запису
`vpnAccessLevel`	число	Доступ через VPN: `0` = вимкнено, `1` = використовує загальний захист, `2` = лише читання, `3` = читання й запис

Група `vpnWireguard`

Поле	Тип	Опис
`enabled`	логічний	WireGuard увімкнено
`autoConfigEnable`	логічний	Режим автоматичної конфігурації Overvis (параметри отримуються з хмари за ідентифікатором пристрою)
`autoConfigUrl`	рядок	URL сервера автоматичної конфігурації
`privateKey`	рядок	Статичний закритий ключ WireGuard у форматі base64
`address`	рядок	Адреса локального інтерфейсу у нотації CIDR, наприклад `10.0.0.2/24`
`peerPublicKey`	рядок	Статичний відкритий ключ вузла WireGuard у форматі base64
`peerHostname`	рядок	Ім’я вузла
`peerPort`	число	Порт вузла
`allowedIps`	масив рядків	Рівно 2 маршрути вузла у форматі CIDR
`keepaliveSec`	число	Постійний інтервал keepalive у секундах

Коли autoConfigEnable = false, використовуються всі статичні поля vpnWireguard, зокрема ключі та кінцева точка.
Коли autoConfigEnable = true, статичні поля vpnWireguard під час роботи ігноруються; WireGuard/Overvis отримує параметри через API службової ідентифікації для автоматичної конфігурації.

Група `channels`

Поле	Тип	Опис
`filterLevel`	число	Рівень фільтра
`items`	масив	Масив із 4 каналів

`channels.items[]`

Поле	Тип	Опис
`enabled`	логічний	Канал увімкнено
`sensorTypeId`	число	Ідентифікатор типу датчика (see `/api/reference/sensor-types/`)
`userOffset`	число	Користувацьке зміщення
`ptcMinikaNominal`	число	Номінальне значення PTC Minika
`linked`	число	Належність до спільної групи порогів і гістерезису TRIP/ALARM/FAN: `0` = незалежний, `1` = пов’язаний

Група `protection`

`protection.trip` / `protection.alarm`

Поле	Тип	Опис
`delaySec`	число	Затримка спрацювання (секунди)
`channels`	масив	Уставки для кожного каналу (4 elements)

`protection.trip.channels[]` / `protection.alarm.channels[]`

Поле	Тип	Опис
`threshold`	число	Уставка температури
`hysteresis`	число	Гістерезис

`protection.fan`

Поле	Тип	Опис
`mode`	число	Режим роботи
`delaySec`	число	Затримка спрацювання (секунди)
`channels`	масив	Уставки для кожного каналу (4 elements)

`protection.fault`

Поле	Тип	Опис
`delaySec`	число	Затримка спрацювання (секунди)

Діапазони та обмеження

Наведені нижче діапазони відповідають обмеженням прошивки в Application/User/settings.h.

general.language: en | pl | ua | ru.
general.logDebugMask: 0..65535 (бітова маска).
dateTime.timezoneOffset: -720..840 хвилин.
dateTime.dst.mode: 0..3 (OFF, EU, US, MANUAL).
dateTime.dst.deltaMin: 0..180 хвилин.
display.contrast: 0..64.
display.activeBacklightPercent: 0..100.
display.idleBacklightEnable: true | false.
display.idleBacklightPercent: 0..100.
display.idleTimeoutSec: 30..3600 секунд.
access.devPasswordEnable, access.webUserPassEnable, access.webPwrPassEnable, access.modbusPasswordEnable: true | false.
Ця кінцева точка не повертає паролі access; обмеження щодо їх запису описано в POST /api/settings/set/.
recorder.enabled: true | false.
recorder.periodSec: 5..3600 секунд.
ntp.syncPeriodSec: 300..86400 секунд.
ntp.server1, ntp.server2: до 31 символів кожен.
web.port: 1..65535.
web.vpnTrusted: true | false.
web.vpnAccessLevel: 0..2 (password, user, powerUser); 0 використовує стандартну авторизацію за паролем.
modbus.unitId: 0..247; 0 — приймати запити з будь-яким Unit ID.
modbus.port: 1..65535.
modbus.timeoutSec: 1..3600 секунд.
modbus.protectMode: 0..2 (none, write-protect, read-write-protect).
modbus.vpnAccessLevel: 0..3 (disabled, password, read-only, read-write).
vpnWireguard.peerPort: 1..65535.
vpnWireguard.keepaliveSec: 1..300 секунд.
channels.filterLevel: 1..10.
channels.items[].sensorTypeId: 0..MSR_SENSOR_COUNT-1; допустимі значення опубліковано через GET /api/reference/sensor-types/.
channels.items[].userOffset: -10.0..10.0 °C.
channels.items[].ptcMinikaNominal: 60.0..180.0 °C.
channels.items[].linked: 0..1.
protection.trip.delaySec, protection.alarm.delaySec, protection.fan.delaySec, protection.fault.delaySec: 0..60 секунд.
protection.trip.channels[].threshold, protection.alarm.channels[].threshold, protection.fan.channels[].threshold: -40.0..240.0 °C.
protection.trip.channels[].hysteresis, protection.alarm.channels[].hysteresis, protection.fan.channels[].hysteresis: 0.0..100.0 °C.
protection.fan.mode: 0..3.

GET /api/settings/get/?meta&general&dateTime&display&access&recorder&network&ntp&web&modbus&vpnWireguard&channels&protection

Параметри запиту

Відповідь 200

Група meta

Група general

Група dateTime

Група display

Група access

Група recorder

Група network

Група ntp

Група web

Група modbus

Група vpnWireguard

Група channels

channels.items[]

Група protection

protection.trip / protection.alarm

protection.trip.channels[] / protection.alarm.channels[]

protection.fan

protection.fault