-- ********************************************************** -- Definitions apply to -- Device Model: STB MONITOR 2.18A (20/11/2023) -- File : help.txt (Auto-generated file) -- Supported ASCII COMMANDS -- ********************************************************** -- for more information support@kvarta.net -- Kvarta Soft Ltd (www.kvarta.net) -- ********************************************************** -- *************************************************************************************************************************** -- The 'GENERAL' group; -- *************************************************************************************************************************** MODEL read-only Device model VERSION read-only Firmware version DEVICE_NAME read-write Name of the device(Location) DEVICE_ID read-only Device ID SUPPORT read-only Firmware version CPU_NOW read-only CPU CPU_5MIN_PEAK read-only CPU 5min peak percentage RAM_USED read-only Ram used in MB RAM_USED_PERCENTAGE read-only Ram used in percent DISK_USED read-only Disk used in MB DISK_USED_PERCENTAGE read-only Disc used in percent TEMPERATURE read-only Temperature in degrees celcius SYSTEM_UP_TIME read-only System up time in seconds APP_UP_TIME read-only Application up time in seconds LOG read-write Logs All Ip connections { Disabled(0) Enabled(1) } AUTO_UPDATE read-write Automatic online updates every x days. { Off(0) 1 5 10 30 45 60 90 } AUTO_UPDATE_COUNTER read-write Automatic online updates counter. UPDATE_LOCATION read-write Update location DATETIME read-write Get/Set Date & Time NTP_ON read-write NTP server { Disabled(0) Enabled(1) } NTP_SERVER read-write NTP server url address NTP_BACKUP_SERVER read-write NTP backup server url address NTP_SYNC COMMAND NTP sync now CT_TIMEZONE read-write Timezone string GOOGLE_ANALYTICS read-write Google analytics tag: Ex.: UA-121893620-1 ALARM_CHECK_TIME read-write Alarm check time before confirming and sending e-mail or snmp trap. ALARM_SILENT_TIME read-write Silent mode: Suspension of sending alarms (minutes). SHOW_UNCONFIRMED read-write Show unconfirmed alamrs with red. { Disabled(0) Enabled(1) } -- *************************************************************************************************************************** -- The 'GENERAL_NET' group; -- *************************************************************************************************************************** PRIMARY_MANAGEMENT_PORT read-write Default management & internet port. Default Gateway port. MANAGEMENT_FROM_ALL_PORTS read-write Allow management from all ports. { Disabled(0) Enabled(1) } HTTPS read-write HTTPS. Requires server.crt and server.key to be uploaded on the server! { OFF(0) MANUAL(1) AUTO(2) } HTTPS_DELETE COMMAND Delete HTTPS certificates HTTPS_DOMAIN read-write HTTPS domain name (server name) HTTPS_EMAIL read-write HTTPS domain registration email (lets encrypt) HTTPS_AUTO_STATUS read-write HTTPS auto status) HTTPS_AUTO_DO_INSTALL read-write HTTPS auto install flag) { Disabled(0) Enabled(1) } VLAN_ON read-write VLAN { Disabled(0) Enabled(1) } VLAN_COUNT read-write VLAN Count BANNED_IP_1 read-write Banned IP Address 1 BANNED_IP_2 read-write Banned IP Address 2 BANNED_IP_3 read-write Banned IP Address 3 BANNED_IP_4 read-write Banned IP Address 4 BANNED_IP_5 read-write Banned IP Address 5 -- *************************************************************************************************************************** -- The 'LAN' table; LAN -- *************************************************************************************************************************** LAN(?).IP read-write IP Address LAN(?).MASK read-write Sub. network mask LAN(?).GATEWAY read-write Gateway IP Address LAN(?).DNS read-write DNS Server IP LAN(?).DHCP read-write DHCP { Disabled(0) Enabled(1) } LAN(?).IP_1 read-write IP Address 1 LAN(?).MASK_1 read-write Sub. network mask 1 LAN(?).IP_2 read-write IP Address 2 LAN(?).MASK_2 read-write Sub. network mask 2 LAN(?).IP_3 read-write IP Address 3 LAN(?).MASK_3 read-write Sub. network mask 3 LAN(?).IP_4 read-write IP Address 4 LAN(?).MASK_4 read-write Sub. network mask 4 LAN(?).IP_5 read-write IP Address 5 LAN(?).MASK_5 read-write Sub. network mask 5 LAN(?).ID read-only Reads the device ID LAN(?).STATE read-only Reads the device state LAN(?).LINK read-only Reads the device link state LAN(?).MAC read-only Reads the MAC address LAN(?).CURRENT_IP read-only Reads the current IP address LAN(?).CURRENT_MASK read-only Reads the current sub. network mask LAN(?).CURRENT_GATEWAY read-only Reads the current gateway IP address LAN(?).DHCP_STATUS read-only Reads DHCP status -- *************************************************************************************************************************** -- The 'VLAN' table; VLAN -- *************************************************************************************************************************** VLAN(?).VLAN read-write VLAN ID VLAN(?).ETHERNET read-write VLAN ETHERNET -- *************************************************************************************************************************** -- The 'USER' table; Web Users -- *************************************************************************************************************************** USER(?).ACCESS read-write User access { Disabled(0) Enabled(1) } USER(?).USERNAME read-write Username USER(?).PASSWORD write-only Password USER(?).WRITE read-write Write permission { Disabled(0) Enabled(1) } -- *************************************************************************************************************************** -- The 'TCP' table; TCP UDP Ports -- *************************************************************************************************************************** TCP(?).TYPE read-write Remote port type { OFF(0) TCP(1) UDP(2) } TCP(?).PORT read-write Remote port TCP/UDP port number TCP(?).FILTER read-write Remote port input IP filter TCP(?).PROTOCOL read-write Remote port protocol { OFF(0) ASCII(1) SNMP(2) ASCIISNMP(3) } -- *************************************************************************************************************************** -- The 'SNMP' group; SNMP -- *************************************************************************************************************************** SNMP.SERVER read-write SNMP Server { Disabled(0) Enabled(1) } SNMP.SNMP_V1_V2_ACCESS read-write SNMP v1,2c access { Disabled(0) Enabled(1) } SNMP.RO_PASSWORD write-only SNMP v1,2c read only community string SNMP.RW_PASSWORD write-only SNMP v1,2c read write community string SNMP.TRAP_PASSWORD write-only SNMP v1,2c trap password SNMP.ENGINE_ID read-write SNMP v3 Engine ID -- *************************************************************************************************************************** -- The 'SNMP_USER' table; SNMP Users -- *************************************************************************************************************************** SNMP_USER(?).ACCESS read-write User access { Disabled(0) Enabled(1) } SNMP_USER(?).USERNAME read-write Username SNMP_USER(?).WRITE read-write Write permission { Disabled(0) Enabled(1) } SNMP_USER(?).SECURITY read-write Security mode { noAuthnoPriv(0) authNoPriv(1) authPriv(3) } SNMP_USER(?).AUTH_ENC read-write Auth encryption { MD5(0) SHA(1) SHA224(2) SHA256(3) SHA384(4) SHA512(5) } SNMP_USER(?).AUTH_PASS write-only Auth password SNMP_USER(?).PRIV_ENC read-write Priv encryption { DES(0) AES(1) AES192(2) AES256(3) DES3(4) } SNMP_USER(?).PRIV_PASS write-only Priv password SNMP_USER(?).PRIV_EXTEND read-write AES192/256 Privacy extend with engineID { Disabled(0) Enabled(1) } -- *************************************************************************************************************************** -- The 'SNMP_TRAP' table; SNMP Trap servers -- *************************************************************************************************************************** SNMP_TRAP(?).IP read-write Trap server IP SNMP_TRAP(?).PORT read-write Trap server port SNMP_TRAP(?).TYPE read-write Trap server type { Off(0) SNMPv1(1) SNMPv2c(2) SNMPv3User1(31) SNMPv3User2(32) SNMPv3User3(33) SNMPv3User4(34) } -- *************************************************************************************************************************** -- The 'SMTP' group; -- *************************************************************************************************************************** SMTP.SEND COMMAND SMTP Send e-mail command SMTP.ALARM read-write SMTP e-mail alarms { Disabled(0) Enabled(1) } SMTP.SERVER read-write SMTP server url address SMTP.AUTH read-write SMTP authentication { Disabled(0) Enabled(1) } SMTP.USER read-write SMTP authentication username SMTP.PASSWORD write-only SMTP authentication password SMTP.SSL read-write SMTP SSL { Off(0) On(1) } SMTP.FROM read-write E-mail From address SMTP.TO read-write E-mail To address SMTP.CC read-write E-mail CC address SMTP.BCC read-write E-mail BCC address SMTP.SUBJECT read-write E-mail subject.Macro can be used. SMTP.TEXT read-write E-mail signature -- *************************************************************************************************************************** -- The 'SOUND_ALARM' group; -- *************************************************************************************************************************** SOUND_ALARM.SOUND_ALARM read-write Sound alarms { Disabled(0) Enabled(1) } SOUND_ALARM.SOUND_PERIOD read-write Sound alarm every X seconds if there is alarm on the device. SOUND_ALARM.BEEP_FREQUENCY read-write Sound alarm beep frequency 40HZ - 6000Hz (Default:1000Hz) SOUND_ALARM.BEEP_TYPE read-write Sound alarm beep type (Default:0,sine) { sine(0) square(1) sawtooth(2) triangle(3) } SOUND_ALARM.BEEP_VOLUME read-write Sound alarm beep volume 0-100% SOUND_ALARM.BEEP_DURATION read-write Sound alarm beep duration 0-5000ms (Default: 250ms) -- *************************************************************************************************************************** -- The 'COMMANDS' group; -- *************************************************************************************************************************** RESTART_NETWORK COMMAND Restart of all network interfaces RESTART_LAN COMMAND Restart of all LAN interfaces RESET_NETWORK_NAMES_OLD COMMAND Set network names to eth0,eth1,etc. RESET_NETWORK_NAMES_DEFAULT COMMAND Set network names default to os. RESTART_ALARMS COMMAND Software reboot of the device REBOOT COMMAND OS Reboot RESTART COMMAND Software reboot of the device FACTORY_RESET COMMAND Software reset (except IP) and reboot of the device UPDATE_AVAILABLE read-only Reads if there is update available { Disabled(0) Enabled(1) } UPDATE_START write-only Starts the update { Disabled(0) Enabled(1) } ONLINE_UPDATE write-only Download update from www.kvarta.net { Disabled(0) Enabled(1) } -- *************************************************************************************************************************** -- The 'SYSTEM_ALARMS' table; System alarms -- *************************************************************************************************************************** SYSTEM_ALARMS(?).CPU_HIGH_ALARM read-write System CPU high alarm threshold in Kbps SYSTEM_ALARMS(?).CPU_HIGH_ALARM_ON read-write System CPU high alarm { Disabled(0) Enabled(1) } SYSTEM_ALARMS(?).RAM_HIGH_ALARM read-write System RAM high alarm threshold in Kbps SYSTEM_ALARMS(?).RAM_HIGH_ALARM_ON read-write System RAM high alarm { Disabled(0) Enabled(1) } SYSTEM_ALARMS(?).DISK_HIGH_ALARM read-write System DISK high alarm threshold in Kbps SYSTEM_ALARMS(?).DISK_HIGH_ALARM_ON read-write System DISK high alarm { Disabled(0) Enabled(1) } SYSTEM_ALARMS(?).TEMP_HIGH_ALARM read-write System Temperature high alarm threshold in Kbps SYSTEM_ALARMS(?).TEMP_HIGH_ALARM_ON read-write System Temperature high alarm { Disabled(0) Enabled(1) } -- *************************************************************************************************************************** -- The 'ACTIVE_ALARMS' table; Currently active alarms -- *************************************************************************************************************************** ACTIVE_ALARMS(?).DATETIME read-only Alarm time ACTIVE_ALARMS(?).ALARM read-only Alarm message ACTIVE_ALARMS(?).MODE read-only Alarm mode ACTIVE_ALARMS(?).NAME read-only Alarm frequency/name ACTIVE_ALARMS(?).VALUE read-only Alarm value ACTIVE_ALARMS(?).THRESHOLD read-only Alarm threshold ACTIVE_ALARMS(?).CONFIRMED read-only Alarm confirmed -- *************************************************************************************************************************** -- The 'LOGGED_ALARMS' table; Latest logged alarms after reboot -- *************************************************************************************************************************** LOGGED_ALARMS(?).ID read-only Alarm ID LOGGED_ALARMS(?).DATETIME read-only Alarm time LOGGED_ALARMS(?).MESSAGE read-only Alarm message LOGGED_ALARMS(?).COLOR read-only Alarm color LOGGED_ALARMS(?).EMAIL read-only Alarm email sent flag LOGGED_ALARMS(?).TRAP read-only Alarm trap sent flag -- *************************************************************************************************************************** -- The 'REMOTE_CONFIG' group; Remote control config -- *************************************************************************************************************************** REMOTE_NAME read-write Remote control name REMOTE_MODE read-write Remote control mode TX(0)/RX(1) (Default:TX(0)) { TX(0) RX(1) } RC_CLICK write-only RC CLICK RC_RESTART write-only RC Restart power NEW_REMOTE_NAME read-write New remote name NEW_REMOTE_KEY read-write New remote key NEW_KEY_DELETE write-only New remote key REMOTE_RECORD write-only New remote do record command REMOTE_DELETE write-only Delete remote control DESIGN_NAME read-write Remote control design name DESIGN_MODEL read-write Remote control design model DESIGN_BRAND read-write Remote control design model DESIGN_WIDTH read-write Remote control design width DESIGN_HEIGHT read-write Remote control design height -- *************************************************************************************************************************** -- The 'DESIGN_ITEM' table; Remote control design item -- *************************************************************************************************************************** DESIGN_ITEM(?).TYPE read-write Design item type DESIGN_ITEM(?).COLUMNS read-write Design item columns 0-12 DESIGN_ITEM(?).CLASS read-write Design item class DESIGN_ITEM(?).ACTION read-write Design item action DESIGN_ITEM(?).TEXT read-write Design item text DESIGN_ITEM(?).ICON read-write Design item icon DESIGN_ITEM(?).DO write-only Design item icon -- *************************************************************************************************************************** -- The 'STB_ALARM' table; STB Test alarms -- *************************************************************************************************************************** STB_ALARM(?).NAME read-write Alarm profile name. STB_ALARM(?).TEST_CHECK_ON read-write STB Test check alarm { Disabled(0) Enabled(1) } STB_ALARM(?).DEVICE_CHECK_ON read-write STB Test check device status { Disabled(0) Enabled(1) } -- *************************************************************************************************************************** -- The 'TIME_PROFILE' table; Time Profiles -- *************************************************************************************************************************** TIME_PROFILE(?).NAME read-write Time profile name TIME_PROFILE(?).SCHEDULE_COUNT read-write Count of schedules TIME_PROFILE(?).SCHEDULE1_ON read-write Schedule 1 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE1_WEEKDAY read-write Schedule 1 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE1_INTERVAL read-write Schedule 1 interval TIME_PROFILE(?).SCHEDULE1_CONFIRMATION read-write Schedule 1 alarm confirmation time (Empty/-1 for default) TIME_PROFILE(?).SCHEDULE2_ON read-write Schedule 2 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE2_WEEKDAY read-write Schedule 2 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE2_INTERVAL read-write Schedule 2 interval TIME_PROFILE(?).SCHEDULE2_CONFIRMATION read-write Schedule 2 alarm confirmation time (Empty/-1 for default) TIME_PROFILE(?).SCHEDULE3_ON read-write Schedule 3 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE3_WEEKDAY read-write Schedule 3 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE3_INTERVAL read-write Schedule 3 interval TIME_PROFILE(?).SCHEDULE3_CONFIRMATION read-write Schedule 3 alarm confirmation time (Empty/-1 for default) TIME_PROFILE(?).SCHEDULE4_ON read-write Schedule 4 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE4_WEEKDAY read-write Schedule 4 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE4_INTERVAL read-write Schedule 4 interval TIME_PROFILE(?).SCHEDULE4_CONFIRMATION read-write Schedule 4 alarm confirmation time (Empty/-1 for default) TIME_PROFILE(?).SCHEDULE5_ON read-write Schedule 5 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE5_WEEKDAY read-write Schedule 5 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE5_INTERVAL read-write Schedule 5 interval TIME_PROFILE(?).SCHEDULE5_CONFIRMATION read-write Schedule 5 alarm confirmation time (Empty/-1 for default) TIME_PROFILE(?).SCHEDULE6_ON read-write Schedule 6 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE6_WEEKDAY read-write Schedule 6 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE6_INTERVAL read-write Schedule 6 interval TIME_PROFILE(?).SCHEDULE6_CONFIRMATION read-write Schedule 6 alarm confirmation time (Empty/-1 for default) TIME_PROFILE(?).SCHEDULE7_ON read-write Schedule 7 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE7_WEEKDAY read-write Schedule 7 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE7_INTERVAL read-write Schedule 7 interval TIME_PROFILE(?).SCHEDULE7_CONFIRMATION read-write Schedule 7 alarm confirmation time (Empty/-1 for default) TIME_PROFILE(?).SCHEDULE8_ON read-write Schedule 8 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE8_WEEKDAY read-write Schedule 8 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE8_INTERVAL read-write Schedule 8 interval TIME_PROFILE(?).SCHEDULE8_CONFIRMATION read-write Schedule 8 alarm confirmation time (Empty/-1 for default) TIME_PROFILE(?).SCHEDULE9_ON read-write Schedule 9 ON { Disabled(0) Enabled(1) } TIME_PROFILE(?).SCHEDULE9_WEEKDAY read-write Schedule 9 weekday { Off(0) Monday(1) Tuesday(2) Wednesday(3) Thursday(4) Friday(5) Saturday(6) Sunday(7) Everyday(10) Weekday(11) Weekend(12) } TIME_PROFILE(?).SCHEDULE9_INTERVAL read-write Schedule 9 interval TIME_PROFILE(?).SCHEDULE9_CONFIRMATION read-write Schedule 9 alarm confirmation time (Empty/-1 for default) -- *************************************************************************************************************************** -- The 'STB_CONFIG' group; STB configuration -- *************************************************************************************************************************** STB_MODE read-write STB mode { MANUAL(0) AUTO(1) } STB_ACCEPT_TIME read-write STB accept time (ms) STB_CHANNEL_TUNE read-write STB Channel tune time (Default:3000) STB_CHANNEL_CONFIRM read-write STB Channel tune confirm key. For faster channel tune. (Default:KEY OK) STB_TEST_LOCK read-write STB Lock to test ID STB_RECORD read-write STB Manual Start/Stop Recording { Disabled(0) Enabled(1) } STB_SCREENSHOT read-write STB Manual Screenshot { Disabled(0) Enabled(1) } WEBRTC_DISABLE read-write Webrtc Disable { Disabled(0) Enabled(1) } HLS_CONFIG read-write HLS Configuration { DEFAULT(0) LOWBITRATE(1) } HDMI_PORT read-write STB Manual HDMI port STB_RESTART write-only STB Restart power STB_RESTART_TYPE read-write STB Restart Type. { HARDWARE(0) HARDWARE1KEY(1) HARDWARE2KEYS(2) SOFTWARE(3) SOFTWARE1KEY(4) } STB_POWER_OFF_TIME read-write STB Power off time. STB_WAIT_AFTER_POWER read-write STB wait after power applied. STB_RESTART_KEY1 read-write STB Power up key.(Default:KEY_POWER) STB_RESTART_KEY1_WAIT read-write STB After key wait. STB_RESTART_KEY2 read-write STB Power up second key.(Default:(none)) STB_RESTART_KEY2_WAIT read-write STB Power off time. STB_AUTO_RESTART_TYPE read-write STB Auto Restart Type. { OFF(0) DAILY(2) SCAN50(50) SCAN100(100) SCAN200(200) SCAN500(500) SCAN1000(1000) } DELETE_ALL write-only Delete all tests -- *************************************************************************************************************************** -- The 'STB_TEST' table; STB Tests -- *************************************************************************************************************************** STB_TEST(?).ID read-write Test ID STB_TEST(?).NAME read-write Test name STB_TEST(?).ENABLED read-write Test enabled { Disabled(0) Enabled(1) } STB_TEST(?).PRIORITY read-write Test priority { Disabled(0) Enabled(1) } STB_TEST(?).TIME_PROFILE read-write Time profile { On(0) T1(1) T2(2) T3(3) T4(4) T5(5) } STB_TEST(?).HDMI_PORT_SELECT read-write HDMI Switch port select (Default:0 do not select) STB_TEST(?).TYPE read-write Test type { CHANNEL(0) CUSTOM(1) } STB_TEST(?).CHANNEL read-write Test channel number STB_TEST(?).CHANNEL_CHECK read-write Test channel check { OFF(0) AUDIO_VIDEO(1) AUDIO(2) VIDEO(3) } STB_TEST(?).TEMPLATE_ID read-write STB Test set template STB_TEST(?).DELETE write-only Delete test STB_TEST(?).ACTION_INDEX(?) read-write Test action index STB_TEST(?).ACTION(?) read-write Test action STB_TEST(?).CONFIG(?) read-write Test config STB_TEST(?).DELETE_ACTION(?) read-write Test action delete -- *************************************************************************************************************************** -- The 'HDMI_SWITCH' group; HDMI Switch Configuration -- *************************************************************************************************************************** SWITCH_CONTROL read-write HDMI Switch mode (0 - IR, 1 - Ethernet) HDMI_SWITCH_REMOTE read-write HDMI Switch remote control name SWITCHING_TIME read-write HDMI Switching time (ms) SWITCH_IP read-write HDMI Switch IP SWITCH_PORT read-write HDMI Switch Port SWITCH_MASK read-write HDMI Switch Mask SWITCH_GATEWAY read-write HDMI Switch Gateway SWITCH_ETH_CONFIG read-write HDMI Switch Eth Do Config Flag { Disabled(0) Enabled(1) } -- *************************************************************************************************************************** -- The 'HDMI_PORT' table; HDMI Ports -- *************************************************************************************************************************** HDMI_PORT(?).ENABLED read-write HDMI Port enabled { Disabled(0) Enabled(1) } HDMI_PORT(?).NAME read-write HDMI Port Name HDMI_PORT(?).REMOTE read-write HDMI Port remote control (Default remote is empty string)