iot
iot/wiliot
Type: Settings Directory
| Argument | Type | Description |
|---|---|---|
| spoof-gps | bool | |
| lat | num | |
| long | num | |
| server | enum (none) | |
| scanner | enum (none) | |
| advertiser | enum (none) | |
| wi-fi | interface_enum { , none:nv::BADID } | |
| features | ubit (gateway, bridge) |
| Read-only Argument | Type | Description |
|---|---|---|
| status | string | |
| gateway-id | string | |
| type | string | |
| owner | string |
iot/wiliot/clear
Type: Command
iot/wiliot/enable
Type: Command
| Read-only Argument | Type | Description |
|---|---|---|
| status | string |
iot/wiliot/disable
Type: Command
| Read-only Argument | Type | Description |
|---|---|---|
| status | string |
iot/wiliot/options
Type: Settings Directory
| Argument | Type | Description |
|---|---|---|
| token-refresh-handicap | num | |
| pckt-limit | num |
iot/wiliot/bluetooth-traffic
Type: Directory
| Read-only Argument | Type | Description |
|---|---|---|
| time | date_arg | |
| address | macAddr | |
| rssi | num | |
| payload | string |
iot/wiliot/bluetooth-traffic/clear
Type: Command
iot/wiliot/mqtt-traffic
Type: Directory
| Read-only Argument | Type | Description |
|---|---|---|
| time | date_arg | |
| topic | string | |
| data | string |
iot/wiliot/mqtt-traffic/clear
Type: Command
iot/wiliot/servers
Type: Directory
| Argument | Type | Description |
|---|---|---|
| name ( mandatory ) | string | |
| address ( mandatory ) | string | |
| port | num | |
| ssl | bool | |
| certificate | enum (none) |
iot/wiliot/servers/defaults
Type: Command
iot/modbus
Type: Settings Directory
| Argument | Type | Description |
|---|---|---|
| disabled | bool | |
| hardware-port | enum | |
| tcp-port | num | |
| timeout | num | |
| rx-switch-offset | num | |
| interframe-gap | num | |
| disable-security-rules | bool |
iot/modbus/read-holding-registers
Type: Command
| Argument | Type | Description |
|---|---|---|
| ip | ipAddr | |
| port | num | |
| timeout | num | |
| slave-id | num | |
| reg-addr | num | |
| num-regs | num |
| Read-only Argument | Type | Description |
|---|---|---|
| values | multi_arg { array-id, num } |
iot/modbus/transceive
Type: Command
| Argument | Type | Description |
|---|---|---|
| address | num | |
| function | num | |
| data | string | |
| values | multi_arg { array-id, num } | |
| rx-switch-offset | num |
| Read-only Argument | Type | Description |
|---|---|---|
| address | num | |
| function | num | |
| data | string | |
| values | multi_arg { array-id, num } | |
| time | date_arg | |
| status | enum (ok | error) | |
| error | num | |
| error-description | string |
iot/modbus/security-rules
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | disabled |
| Argument | Type | Description |
|---|---|---|
| ip-range ( mandatory ) | ip_range_arg | |
| allowed-function-codes ( mandatory ) | multi_arg { array-id, num } |
iot/mqtt
Type: Settings Directory
iot/mqtt/brokers
Type: Directory
| Flag | Name | Description |
|---|---|---|
| W | Will message enabled |
| Argument | Type | Description |
|---|---|---|
| name ( mandatory ) | string | |
| address ( mandatory ) | string | |
| port | num | |
| ssl | bool | |
| client-id | string | |
| username | string | |
| password | string | |
| will-topic | string | |
| will-message | string | |
| will-qos | num | |
| will-retain | bool | |
| certificate | enum (none) | |
| auto-connect | bool | |
| keep-alive | num | |
| parallel-scripts-limit | num |
| Read-only Argument | Type | Description |
|---|---|---|
| connected | bool |
iot/mqtt/subscriptions
Type: Directory
| Argument | Type | Description |
|---|---|---|
| broker | enum () | |
| topic | string | |
| qos | num | |
| on-message | string |
iot/mqtt/subscriptions/monitor-data
Type: Command
| Read-only Argument | Type | Description |
|---|---|---|
| data | string | |
| time | date_arg | |
| topic | string | |
| broker | enum () |
iot/mqtt/subscriptions/recv
Type: Directory
| Read-only Argument | Type | Description |
|---|---|---|
| broker | enum () | |
| topic | string | |
| data | string | |
| time | date_arg |
iot/mqtt/subscriptions/recv/clear
Type: Command
iot/mqtt/publish
Type: Command
| Argument | Type | Description |
|---|---|---|
| broker | enum () | |
| topic | string | |
| message | string | |
| qos | num | |
| retain | bool | |
| disconnect-after | bool | |
| force | bool |
iot/mqtt/subscribe
Type: Command
| Argument | Type | Description |
|---|---|---|
| broker | enum () | |
| topic | string | |
| qos | num | |
| force | bool |
iot/mqtt/unsubscribe
Type: Command
| Argument | Type | Description |
|---|---|---|
| broker | enum () | |
| topic | enum () |
iot/mqtt/connect
Type: Command
| Argument | Type | Description |
|---|---|---|
| broker | enum () |
iot/mqtt/disconnect
Type: Command
| Argument | Type | Description |
|---|---|---|
| broker | enum () |
iot/gpio
Syscap: gpio
Type: Directory
iot/gpio/analog
Type: Directory
| Argument | Type | Description |
|---|---|---|
| offset | num |
| Read-only Argument | Type | Description |
|---|---|---|
| name | string | |
| value | num |
iot/gpio/digital
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | disabled |
| Argument | Type | Description |
|---|---|---|
| direction | enum (input | output) | |
| output | enum (0 | 1) | |
| script | alt { , string } |
| Read-only Argument | Type | Description |
|---|---|---|
| name | string | |
| input | enum (0 | 1) |
iot/lora
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | disabled |
| Argument | Type | Description |
|---|---|---|
| gateway-id | string { } | |
| name | string | |
| servers | multi_arg { enum } | |
| tx-immediate-delay-us | num | |
| channel-plan | enum (custom | eu-868 | as-923 | kr-920 | in-865 | il-917 | us-915-1 | us-915-2 | us-915-3 | us-915-4 | us-915-5 | us-915-6 | us-915-7 | us-915-8 | au-915-1 | au-915-2 | ru-864 | ru-864-mid | 2.4-ghz) | |
| antenna-gain | num | |
| forward | ubit (crc-validation, dev-addr-validation, proprietary-traffic) | |
| network | enum (public | private) | |
| lbt-enabled | bool | |
| listen-time | num | |
| rssi-threshold | num | |
| spoof-gps | bool | |
| lat | num | |
| long | num | |
| alt | num | |
| antenna | enum (internal-antenna | external-antenna) |
| Read-only Argument | Type | Description |
|---|---|---|
| status | string | |
| firmware-id | string | |
| version | string | |
| rx-packets | num | |
| tx-packets | num | |
| tx-toa | num | |
| band | enum (unknown | 863-870 | 902-928 | 2.4-ghz) |
iot/lora/reset-devices
Type: Command
iot/lora/send
Type: Command
| Argument | Type | Description |
|---|---|---|
| device-id | num | |
| payload | string | |
| power | num | |
| frequency | num | |
| bandwidth | enum (125KHZ | 250KHZ | 500KHZ) | |
| spread-factor | enum (SF7 | SF8 | SF9 | SF10 | SF11 | SF12 | MULTI) | |
| modulation | enum (MOD_CW | MOD_LORA | MOD_FSK) | |
| preamble | num | |
| inverted | bool |
iot/lora/radios
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | disabled |
| Argument | Type | Description |
|---|---|---|
| center-freq | num | |
| tx-freq-min | num | |
| tx-freq-max | num |
| Read-only Argument | Type | Description |
|---|---|---|
| name | string | |
| type | enum (SX1255 | SX1257 | SX1272 | SX1276 | SX1280 | SX1250) | |
| rssi-off | num | |
| tx-enabled | bool |
iot/lora/channels
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | disabled |
| Argument | Type | Description |
|---|---|---|
| radio | enum (radio0 | radio1 | radio2 | radio3) | |
| freq-off | num | |
| bandwidth | enum (7.8_kHz | 15.6_kHz | 31.2_kHz | 62.5_kHz | 125_kHz | 250_kHz | 500_kHz | 200_kHz | 400_kHz | 800_kHz | 1600_kHz) | |
| spread-factor | enum (SF7 | SF8 | SF9 | SF10 | SF11 | SF12 | SF5 | SF6) | |
| datarate | num |
| Read-only Argument | Type | Description |
|---|---|---|
| name | string | |
| type | enum (MSF | LoRa | FSK) | |
| freq | num |
iot/lora/servers
Type: Directory
| Argument | Type | Description |
|---|---|---|
| name ( mandatory ) | string | |
| address ( mandatory ) | string | |
| up-port | num | |
| down-port | num | |
| key | string | |
| port | num | |
| interval | num | |
| ssl | bool | |
| certificate | enum (none) | |
| protocol ( mandatory ) | enum (UDP | LNS | CUPS) | |
| netid | multi_arg { enum } | |
| joineui | multi_arg { enum } |
iot/lora/servers/reset-servers
Type: Command
iot/lora/traffic
Type: Directory
| Read-only Argument | Type | Description |
|---|---|---|
| time | date_arg | |
| gwid | string | |
| msgtype | string | |
| devaddr | string | |
| mver | string | |
| fcnt | num | |
| type | string | |
| netid | string | |
| joineui | string | |
| deveui | string | |
| devnonce | string | |
| joinnonce | string | |
| freqhz | num | |
| mod | string | |
| band | string | |
| datarate | string | |
| coderate | string | |
| ifchain | string | |
| crc | string | |
| txmode | string | |
| counter | string | |
| rfchain | string | |
| rssi | string | |
| snr | string | |
| snrmin | string | |
| snrmax | string | |
| rxcrc | string | |
| rfpow | string | |
| invertpol | string | |
| freq | string | |
| preamblen | string | |
| nocrc | string | |
| noheader | string | |
| size | string | |
| data | string |
iot/lora/traffic/clear
Type: Command
iot/lora/traffic/options
Type: Settings Directory
| Argument | Type | Description |
|---|---|---|
| crc-errors | bool | |
| pckt-limit | num |
iot/lora/netid
Type: Directory
| Argument | Type | Description |
|---|---|---|
| name ( mandatory ) | string | |
| logging | bool | |
| type | enum (whitelist | blacklist) | |
| netids | obj_arg { composite_arg { , } { , } } |
iot/lora/joineui
Type: Directory
| Argument | Type | Description |
|---|---|---|
| name ( mandatory ) | string | |
| logging | bool | |
| type | enum (whitelist | blacklist) | |
| joineuis | obj_arg { composite_arg { , } { , } } |
iot/bluetooth
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | offline |
| Argument | Type | Description |
|---|---|---|
| name | string | |
| random-static-address | macAddr | |
| antenna | enum (internal | external) |
| Read-only Argument | Type | Description |
|---|---|---|
| public-address | macAddr | |
| rx-bytes | num | |
| tx-bytes | num | |
| rx-errors | num | |
| tx-errors | num | |
| rx-evt | num | |
| tx-cmd | num | |
| rx-acl | num | |
| tx-acl | num |
iot/bluetooth/reset-counters
Type: Command
iot/bluetooth/advertisers
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | disabled |
| Argument | Type | Description |
|---|---|---|
| min-interval | num | |
| max-interval | num | |
| own-address-type | enum (public | random-static | rpa-fallback-to-public | rpa-fallback-to-random) | |
| channel-map | ubit (37, 38, 39) | |
| phy | enum (1M | 2M | CODED) | |
| legacy | bool | |
| ad-structures | multi_arg { array-id, enum } |
| Read-only Argument | Type | Description |
|---|---|---|
| device | enum | |
| ad-size | num |
iot/bluetooth/advertisers/ad-structures
Type: Directory
| Argument | Type | Description |
|---|---|---|
| name ( mandatory ) | string | |
| type ( mandatory ) | enum (short-local-name | complete-local-name | service-data | manufacturer-data) | |
| data ( mandatory ) | string |
iot/bluetooth/scanners
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | disabled |
| Argument | Type | Description |
|---|---|---|
| type | enum (passive | active) | |
| interval | num | |
| window | num | |
| own-address-type | enum (public | random-static | rpa-fallback-to-public | rpa-fallback-to-random) | |
| filter-policy | enum (default | whitelist) | |
| filter-duplicates | enum (off | keep-oldest | keep-newest | keep-unique) | |
| phy | enum (1M | 2M | CODED) |
| Read-only Argument | Type | Description |
|---|---|---|
| device | enum |
iot/bluetooth/scanners/advertisements
Type: Directory
| Read-only Argument | Type | Description |
|---|---|---|
| device | enum | |
| pdu-type | enum (adv-ind | adv-direct-ind | adv-scan-ind | adv-noconn-ind | scan-rsp | unknown) | |
| time | date_arg | |
| epoch | num | |
| address-type | enum (public | random) | |
| address | macAddr | |
| rssi | num | |
| length | num | |
| data | string | |
| phy | enum (1M | 2M | CODED-S8 | CODED-S2 | NONE) | |
| phy-secondary | enum (1M | 2M | CODED-S8 | CODED-S2 | NONE) | |
| legacy | bool | |
| filter-comment | string |
iot/bluetooth/scanners/advertisements/clear
Type: Command
iot/bluetooth/whitelist
Type: Directory
| Flag | Name | Description |
|---|---|---|
| X | disabled |
| Argument | Type | Description |
|---|---|---|
| device ( mandatory ) | enum | |
| address-type ( mandatory ) | enum (public | random | any) | |
| address ( mandatory ) | string |
iot/bluetooth/peripheral-devices
Type: Directory
| Argument | Type | Description |
|---|---|---|
| address-type ( mandatory ) | enum (public | random) | |
| address ( mandatory ) | macAddr | |
| name | string | |
| persist | bool | |
| mtik-key | string |
| Read-only Argument | Type | Description |
|---|---|---|
| rssi | num | |
| last-data | string | |
| last-seen | date_arg | |
| beacon-types | multi_arg { array-id, enum (unknown | mikrotik | ibeacon | eddystone-uid | eddystone-url | eddystone-tlm | eddystone-eid) { unknown:0, mikrotik:1, ibeacon:2, eddystone-uid:3, eddystone-url:4, eddystone-tlm:5, eddystone-eid:6 } } | |
| mtik-version | num | |
| mtik-encrypted | bool | |
| mtik-acc-x | num | |
| mtik-acc-y | num | |
| mtik-acc-z | num | |
| mtik-temperature | num | |
| mtik-battery | num | |
| mtik-uptime | num | |
| mtik-flags | multi_arg { array-id, enum (reed-switch | tilt | free-fall | impact-x | impact-y | impact-z) { reed-switch:0, tilt:1, free-fall:2, impact-x:3, impact-y:4, impact-z:5 } } | |
| ibeacon-uuid | string | |
| ibeacon-major | num | |
| ibeacon-minor | num | |
| ibeacon-rssi-at-1m | num | |
| eddy-rssi-at-1m | num | |
| eddy-namespace | string | |
| eddy-instance | string | |
| eddy-version | num | |
| eddy-battery-voltage | num | |
| eddy-temperature | num | |
| eddy-packet-count | num | |
| eddy-uptime | num | |
| eddy-tx-power | num | |
| eddy-eid | string |
iot/bluetooth/decode-ad
Type: Command
| Argument | Type | Description |
|---|---|---|
| data | string | |
| key | string |
| Read-only Argument | Type | Description |
|---|---|---|
| type | enum (unknown | mikrotik | ibeacon | eddystone-uid | eddystone-url | eddystone-tlm | eddystone-eid) | |
| version | num | |
| encrypted | bool | |
| acc-x | num | |
| acc-y | num | |
| acc-z | num | |
| temperature | num | |
| uptime | num | |
| flags | multi_arg { array-id, enum (reed-switch | tilt | free-fall | impact-x | impact-y | impact-z) { reed-switch:0, tilt:1, free-fall:2, impact-x:3, impact-y:4, impact-z:5 } } | |
| battery | num | |
| uuid | string | |
| major | num | |
| minor | num | |
| rssi-at-1m | num | |
| namespace | string | |
| instance | string | |
| battery-voltage | num | |
| packet-count | num | |
| tx-power | num | |
| eid | string |
iot/bluetooth/connections
Type: Directory
| Read-only Argument | Type | Description |
|---|---|---|
| name | string | |
| direction | enum (incoming | outgoing) |
iot/bluetooth/connections/characteristics
Type: Directory
| Read-only Argument | Type | Description |
|---|---|---|
| name | string | |
| uuid | string | |
| handle | num | |
| service-name | string | |
| service-uuid | string | |
| props | multi_arg { array-id, enum (bcast | read | write-no-resp | write | notify | indicate | write-signed | ext) { bcast:0x01, read:0x02, write-no-resp:0x04, write:0x08, notify:0x10, indicate:0x20, write-signed:0x40, ext:0x80 } } | |
| pdev | enum |
iot/bluetooth/connections/async-data
Type: Directory
| Read-only Argument | Type | Description |
|---|---|---|
| pdev | string | |
| uuid | string | |
| data-text | string | |
| data-hex | string | |
| data-bytes | multi_arg { array-id, num } | |
| type | enum (notification | indication) | |
| time | date_arg |
iot/bluetooth/connections/async-data/clear
Type: Command
iot/bluetooth/connections/connect
Type: Command
| Argument | Type | Description |
|---|---|---|
| pdev | enum |
iot/bluetooth/connections/write
Type: Command
| Argument | Type | Description |
|---|---|---|
| uuid | enum () | |
| data-hex | string | |
| data-str | string | |
| data-bytes | multi_arg { array-id, num } | |
| pdev | enum () |
iot/bluetooth/connections/write-no-resp
Type: Command
| Argument | Type | Description |
|---|---|---|
| uuid | enum () | |
| data-hex | string | |
| data-str | string | |
| data-bytes | multi_arg { array-id, num } | |
| pdev | enum () |
iot/bluetooth/connections/read
Type: Command
| Argument | Type | Description |
|---|---|---|
| uuid | enum () | |
| pdev | enum () |
| Read-only Argument | Type | Description |
|---|---|---|
| value | string | |
| hex | string | |
| bytes | multi_arg { array-id, num } |
iot/bluetooth/connections/subscribe
Type: Command
| Argument | Type | Description |
|---|---|---|
| uuid | enum () | |
| type | enum (notification | indication) | |
| pdev | enum () |
iot/bluetooth/connections/unsubscribe
Type: Command
| Argument | Type | Description |
|---|---|---|
| uuid | enum () | |
| type | enum (notification | indication) | |
| pdev | enum () |
iot/bluetooth/connections/disconnect
Type: Command
| Argument | Type | Description |
|---|---|---|
| pdev | enum () |