{"id":13312,"date":"2016-06-22T10:47:09","date_gmt":"2016-06-22T15:47:09","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=13312"},"modified":"2023-06-29T07:49:02","modified_gmt":"2023-06-29T12:49:02","slug":"system","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/system\/","title":{"rendered":"system"},"content":{"rendered":"<p>Description: system attributes : OBJECT<\/p>\n<table border=\"1\" cellspacing=\"0\" cellpadding=\"0\">\n<thead>\n<tr>\n<td style=\"background-color: #3e70c1;\"><span style=\"color: #ffffff;\"><b>Element<\/b><\/span><\/td>\n<td style=\"background-color: #3e70c1;\"><span style=\"color: #ffffff;\"><b>Type<\/b><\/span><\/td>\n<td style=\"background-color: #3e70c1;\"><span style=\"color: #ffffff;\"><b>Description<\/b><\/span><\/td>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td valign=\"top\" width=\"173\">accessoryCards<\/td>\n<td valign=\"top\" width=\"54\">ARRAY<\/td>\n<td valign=\"top\" width=\"331\">Specifies the list of installed accessory cards<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">apiVersion<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the API version<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">capabilities<\/td>\n<td valign=\"top\" width=\"54\">OBJECT<\/td>\n<td valign=\"top\" width=\"331\">Reports hardware capabilities<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 adc<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports analog inputs<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 battery<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports backup battery<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 bluetooth<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports Bluetooth<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 cell<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports Cellular<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 cellWwan<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the cellular radio supports QMI WWAN interface<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 din<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports digital inputs<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 docker<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports Docker<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 dout<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports digital outputs<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 ethSwitch<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports Ethernet Switch<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 externalSerialPort<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports an external serial port<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 flexibleSerialPort<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports a flexible serial port<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 gpio<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports GPIO<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 gps<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports GPS<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 lora<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports LoRa<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 loraNetworkServer<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the LoRa Network Server is installed<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 nodeRed<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the if Node-RED server is installed false<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 rs232<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports RS-232 interface<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 rs422<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports RS-422 interface<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 rs485<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports RS-485 interface<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 serial<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports external serial port<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 tpm<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports Trusted Platform Module (TPM)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 wifi<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device supports Wi-Fi<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 cellPpp<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the cellular radio supports the PPP data connecton protocol<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">cmdtty<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the TTY device that issues AT commands to the device<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">date<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the current system date<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">datetime<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the current system date and time<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">dbDirty<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the database is in a dirty state<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">defaultDeviceName<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the default name of the device<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">deviceHostname<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Device hostname<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">deviceId<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the device ID<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">deviceName<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the configured name of the device<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">ethSwitch<\/td>\n<td valign=\"top\" width=\"54\">OBJECT<\/td>\n<td valign=\"top\" width=\"331\">Provides the details about available Ethernet Switch ports*<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 chip<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the chip model*<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 ports<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Lists the available ports*<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 \u00a0 portName<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">The name of the port*<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 \u00a0 \u00a0 id<\/td>\n<td valign=\"top\" width=\"54\">UINT<\/td>\n<td valign=\"top\" width=\"331\">The port ID*<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 \u00a0 \u00a0 mac<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">The port mac address*<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">firmware<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the firmware version<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">firmwareDate<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the date the firmware was built<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">firmwareImageId<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the firmware Image ID value<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">firstTimeSetup<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the device is set to default values<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">hardwareVersion<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the hardware version of the device<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">imei<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the international mobile station equipment identity<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">imsi<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the international mobile subscriber identity<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">loraEui<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">EUI of the build-in LoRa card<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">loraFpgaVersion<\/td>\n<td valign=\"top\" width=\"54\">UINT<\/td>\n<td valign=\"top\" width=\"331\">FPGA firmware version of the build-in LoRa card<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">loraHwVersion<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Hardware Version of the build-in LoRa card<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">loraProductId<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Product ID of the build-in LoRa card<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">macAddress<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the MAC address of the device\u2019s Ethernet port<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">macAddress1<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\"><\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">macBluetooth<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the MAC address of the device\u2019s Bluetooth module<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">macWifi<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the MAC address of the device\u2019s Wi-Fi module<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">memory<\/td>\n<td valign=\"top\" width=\"54\">OBJECT<\/td>\n<td valign=\"top\" width=\"331\">Contains a list of the current memory statistics<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">mode<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the system level mode of the device (default:ROUTER)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">oemConfigSet<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether the OEM configuration is set (default: false)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">oemId<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies configurable device id<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">oemString1<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\"><\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">oemString2<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\"><\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">permission<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the authorization level of the active user<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">platform<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">NOTE: this is not a part of public API (do not share)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">ppptty<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the TTY device that PPP uses to make connections<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">productId<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the product ID<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">radio<\/td>\n<td valign=\"top\" width=\"54\">OBJECT<\/td>\n<td valign=\"top\" width=\"331\">Specifies the radio\u2019s model number and type<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 carrier<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the carrier currently providing cellular connectivity<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 code<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the radio model\u2019s code number: H5, H6, EV3, C2, G3, LAT1, VW2 or LEU1<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 firmware<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies radio firmware version<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">\u00a0 type<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the type of radio, GSM, CMDA or LTE<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">restartNeeded<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Specifies whether settings have been changed and a restart is required to reflect those changes in services<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">signedFirmwareValidation<\/td>\n<td valign=\"top\" width=\"54\">BOOL<\/td>\n<td valign=\"top\" width=\"331\">Enable to require a signed firmware and perform a signature validation before the firmware upgrade. (default:true)<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">time<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the current system time of the device<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">uptime<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies how long the device has been running<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">user<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the user currently logged in<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">uuid<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">uuid<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">vendorId<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the vendor of the device<\/td>\n<\/tr>\n<tr>\n<td valign=\"top\" width=\"173\">webTitle<\/td>\n<td valign=\"top\" width=\"54\">STRING<\/td>\n<td valign=\"top\" width=\"331\">Specifies the title configured to display in a browser<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><em>*For Conduit 300 only<\/em><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Description: system attributes : OBJECT Element Type Description accessoryCards ARRAY Specifies the list of installed accessory cards apiVersion STRING Specifies the API version capabilities OBJECT Reports hardware capabilities \u00a0 adc BOOL Specifies whether the device supports analog inputs \u00a0 battery BOOL Specifies whether the device supports backup battery \u00a0 bluetooth BOOL Specifies whether the device [&hellip;]<\/p>\n","protected":false},"author":1872,"featured_media":0,"parent":13129,"menu_order":62,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-13312","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13312","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1872"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=13312"}],"version-history":[{"count":20,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13312\/revisions"}],"predecessor-version":[{"id":33446,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13312\/revisions\/33446"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=13312"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}