Skip to main content
Version: current

iot


iot/wiliot

Type: Settings Directory

ArgumentTypeDescription
spoof-gpsbool
latnum
longnum
serverenum (none)
scannerenum (none)
advertiserenum (none)
wi-fiinterface_enum { , none:nv::BADID }
featuresubit (gateway, bridge)
Read-only ArgumentTypeDescription
statusstring
gateway-idstring
typestring
ownerstring

iot/wiliot/clear

Type: Command

iot/wiliot/enable

Type: Command

Read-only ArgumentTypeDescription
statusstring

iot/wiliot/disable

Type: Command

Read-only ArgumentTypeDescription
statusstring

iot/wiliot/options

Type: Settings Directory

ArgumentTypeDescription
token-refresh-handicapnum
pckt-limitnum

iot/wiliot/bluetooth-traffic

Type: Directory

Read-only ArgumentTypeDescription
timedate_arg
addressmacAddr
rssinum
payloadstring

iot/wiliot/bluetooth-traffic/clear

Type: Command

iot/wiliot/mqtt-traffic

Type: Directory

Read-only ArgumentTypeDescription
timedate_arg
topicstring
datastring

iot/wiliot/mqtt-traffic/clear

Type: Command

iot/wiliot/servers

Type: Directory

ArgumentTypeDescription
name ( mandatory )string
address ( mandatory )string
portnum
sslbool
certificateenum (none)

iot/wiliot/servers/defaults

Type: Command

iot/modbus

Type: Settings Directory

ArgumentTypeDescription
disabledbool
hardware-portenum
tcp-portnum
timeoutnum
rx-switch-offsetnum
interframe-gapnum
disable-security-rulesbool

iot/modbus/read-holding-registers

Type: Command

ArgumentTypeDescription
ipipAddr
portnum
timeoutnum
slave-idnum
reg-addrnum
num-regsnum
Read-only ArgumentTypeDescription
valuesmulti_arg { array-id, num }

iot/modbus/transceive

Type: Command

ArgumentTypeDescription
addressnum
functionnum
datastring
valuesmulti_arg { array-id, num }
rx-switch-offsetnum
Read-only ArgumentTypeDescription
addressnum
functionnum
datastring
valuesmulti_arg { array-id, num }
timedate_arg
statusenum (ok | error)
errornum
error-descriptionstring

iot/modbus/security-rules

Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
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

FlagNameDescription
WWill message enabled
ArgumentTypeDescription
name ( mandatory )string
address ( mandatory )string
portnum
sslbool
client-idstring
usernamestring
passwordstring
will-topicstring
will-messagestring
will-qosnum
will-retainbool
certificateenum (none)
auto-connectbool
keep-alivenum
parallel-scripts-limitnum
Read-only ArgumentTypeDescription
connectedbool

iot/mqtt/subscriptions

Type: Directory

ArgumentTypeDescription
brokerenum ()
topicstring
qosnum
on-messagestring

iot/mqtt/subscriptions/monitor-data

Type: Command

Read-only ArgumentTypeDescription
datastring
timedate_arg
topicstring
brokerenum ()

iot/mqtt/subscriptions/recv

Type: Directory

Read-only ArgumentTypeDescription
brokerenum ()
topicstring
datastring
timedate_arg
iot/mqtt/subscriptions/recv/clear

Type: Command

iot/mqtt/publish

Type: Command

ArgumentTypeDescription
brokerenum ()
topicstring
messagestring
qosnum
retainbool
disconnect-afterbool
forcebool

iot/mqtt/subscribe

Type: Command

ArgumentTypeDescription
brokerenum ()
topicstring
qosnum
forcebool

iot/mqtt/unsubscribe

Type: Command

ArgumentTypeDescription
brokerenum ()
topicenum ()

iot/mqtt/connect

Type: Command

ArgumentTypeDescription
brokerenum ()

iot/mqtt/disconnect

Type: Command

ArgumentTypeDescription
brokerenum ()

iot/gpio

Syscap: gpio
Type: Directory

iot/gpio/analog

Type: Directory

ArgumentTypeDescription
offsetnum
Read-only ArgumentTypeDescription
namestring
valuenum

iot/gpio/digital

Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
directionenum (input | output)
outputenum (0 | 1)
scriptalt { , string }
Read-only ArgumentTypeDescription
namestring
inputenum (0 | 1)

iot/lora

Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
gateway-idstring { }
namestring
serversmulti_arg { enum }
tx-immediate-delay-usnum
channel-planenum (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-gainnum
forwardubit (crc-validation, dev-addr-validation, proprietary-traffic)
networkenum (public | private)
lbt-enabledbool
listen-timenum
rssi-thresholdnum
spoof-gpsbool
latnum
longnum
altnum
antennaenum (internal-antenna | external-antenna)
Read-only ArgumentTypeDescription
statusstring
firmware-idstring
versionstring
rx-packetsnum
tx-packetsnum
tx-toanum
bandenum (unknown | 863-870 | 902-928 | 2.4-ghz)

iot/lora/reset-devices

Type: Command

iot/lora/send

Type: Command

ArgumentTypeDescription
device-idnum
payloadstring
powernum
frequencynum
bandwidthenum (125KHZ | 250KHZ | 500KHZ)
spread-factorenum (SF7 | SF8 | SF9 | SF10 | SF11 | SF12 | MULTI)
modulationenum (MOD_CW | MOD_LORA | MOD_FSK)
preamblenum
invertedbool

iot/lora/radios

Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
center-freqnum
tx-freq-minnum
tx-freq-maxnum
Read-only ArgumentTypeDescription
namestring
typeenum (SX1255 | SX1257 | SX1272 | SX1276 | SX1280 | SX1250)
rssi-offnum
tx-enabledbool

iot/lora/channels

Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
radioenum (radio0 | radio1 | radio2 | radio3)
freq-offnum
bandwidthenum (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-factorenum (SF7 | SF8 | SF9 | SF10 | SF11 | SF12 | SF5 | SF6)
dataratenum
Read-only ArgumentTypeDescription
namestring
typeenum (MSF | LoRa | FSK)
freqnum

iot/lora/servers

Type: Directory

ArgumentTypeDescription
name ( mandatory )string
address ( mandatory )string
up-portnum
down-portnum
keystring
portnum
intervalnum
sslbool
certificateenum (none)
protocol ( mandatory )enum (UDP | LNS | CUPS)
netidmulti_arg { enum }
joineuimulti_arg { enum }

iot/lora/servers/reset-servers

Type: Command

iot/lora/traffic

Type: Directory

Read-only ArgumentTypeDescription
timedate_arg
gwidstring
msgtypestring
devaddrstring
mverstring
fcntnum
typestring
netidstring
joineuistring
deveuistring
devnoncestring
joinnoncestring
freqhznum
modstring
bandstring
dataratestring
coderatestring
ifchainstring
crcstring
txmodestring
counterstring
rfchainstring
rssistring
snrstring
snrminstring
snrmaxstring
rxcrcstring
rfpowstring
invertpolstring
freqstring
preamblenstring
nocrcstring
noheaderstring
sizestring
datastring

iot/lora/traffic/clear

Type: Command

iot/lora/traffic/options

Type: Settings Directory

ArgumentTypeDescription
crc-errorsbool
pckt-limitnum

iot/lora/netid

Type: Directory

ArgumentTypeDescription
name ( mandatory )string
loggingbool
typeenum (whitelist | blacklist)
netidsobj_arg { composite_arg { , } { , } }

iot/lora/joineui

Type: Directory

ArgumentTypeDescription
name ( mandatory )string
loggingbool
typeenum (whitelist | blacklist)
joineuisobj_arg { composite_arg { , } { , } }

iot/bluetooth

Type: Directory

FlagNameDescription
Xoffline
ArgumentTypeDescription
namestring
random-static-addressmacAddr
antennaenum (internal | external)
Read-only ArgumentTypeDescription
public-addressmacAddr
rx-bytesnum
tx-bytesnum
rx-errorsnum
tx-errorsnum
rx-evtnum
tx-cmdnum
rx-aclnum
tx-aclnum

iot/bluetooth/reset-counters

Type: Command

iot/bluetooth/advertisers

Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
min-intervalnum
max-intervalnum
own-address-typeenum (public | random-static | rpa-fallback-to-public | rpa-fallback-to-random)
channel-mapubit (37, 38, 39)
phyenum (1M | 2M | CODED)
legacybool
ad-structuresmulti_arg { array-id, enum }
Read-only ArgumentTypeDescription
deviceenum
ad-sizenum

iot/bluetooth/advertisers/ad-structures

Type: Directory

ArgumentTypeDescription
name ( mandatory )string
type ( mandatory )enum (short-local-name | complete-local-name | service-data | manufacturer-data)
data ( mandatory )string

iot/bluetooth/scanners

Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
typeenum (passive | active)
intervalnum
windownum
own-address-typeenum (public | random-static | rpa-fallback-to-public | rpa-fallback-to-random)
filter-policyenum (default | whitelist)
filter-duplicatesenum (off | keep-oldest | keep-newest | keep-unique)
phyenum (1M | 2M | CODED)
Read-only ArgumentTypeDescription
deviceenum

iot/bluetooth/scanners/advertisements

Type: Directory

Read-only ArgumentTypeDescription
deviceenum
pdu-typeenum (adv-ind | adv-direct-ind | adv-scan-ind | adv-noconn-ind | scan-rsp | unknown)
timedate_arg
epochnum
address-typeenum (public | random)
addressmacAddr
rssinum
lengthnum
datastring
phyenum (1M | 2M | CODED-S8 | CODED-S2 | NONE)
phy-secondaryenum (1M | 2M | CODED-S8 | CODED-S2 | NONE)
legacybool
filter-commentstring
iot/bluetooth/scanners/advertisements/clear

Type: Command

iot/bluetooth/whitelist

Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
device ( mandatory )enum
address-type ( mandatory )enum (public | random | any)
address ( mandatory )string

iot/bluetooth/peripheral-devices

Type: Directory

ArgumentTypeDescription
address-type ( mandatory )enum (public | random)
address ( mandatory )macAddr
namestring
persistbool
mtik-keystring
Read-only ArgumentTypeDescription
rssinum
last-datastring
last-seendate_arg
beacon-typesmulti_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-versionnum
mtik-encryptedbool
mtik-acc-xnum
mtik-acc-ynum
mtik-acc-znum
mtik-temperaturenum
mtik-batterynum
mtik-uptimenum
mtik-flagsmulti_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-uuidstring
ibeacon-majornum
ibeacon-minornum
ibeacon-rssi-at-1mnum
eddy-rssi-at-1mnum
eddy-namespacestring
eddy-instancestring
eddy-versionnum
eddy-battery-voltagenum
eddy-temperaturenum
eddy-packet-countnum
eddy-uptimenum
eddy-tx-powernum
eddy-eidstring

iot/bluetooth/decode-ad

Type: Command

ArgumentTypeDescription
datastring
keystring
Read-only ArgumentTypeDescription
typeenum (unknown | mikrotik | ibeacon | eddystone-uid | eddystone-url | eddystone-tlm | eddystone-eid)
versionnum
encryptedbool
acc-xnum
acc-ynum
acc-znum
temperaturenum
uptimenum
flagsmulti_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 } }
batterynum
uuidstring
majornum
minornum
rssi-at-1mnum
namespacestring
instancestring
battery-voltagenum
packet-countnum
tx-powernum
eidstring

iot/bluetooth/connections

Type: Directory

Read-only ArgumentTypeDescription
namestring
directionenum (incoming | outgoing)

iot/bluetooth/connections/characteristics

Type: Directory

Read-only ArgumentTypeDescription
namestring
uuidstring
handlenum
service-namestring
service-uuidstring
propsmulti_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 } }
pdevenum

iot/bluetooth/connections/async-data

Type: Directory

Read-only ArgumentTypeDescription
pdevstring
uuidstring
data-textstring
data-hexstring
data-bytesmulti_arg { array-id, num }
typeenum (notification | indication)
timedate_arg
iot/bluetooth/connections/async-data/clear

Type: Command

iot/bluetooth/connections/connect

Type: Command

ArgumentTypeDescription
pdevenum

iot/bluetooth/connections/write

Type: Command

ArgumentTypeDescription
uuidenum ()
data-hexstring
data-strstring
data-bytesmulti_arg { array-id, num }
pdevenum ()

iot/bluetooth/connections/write-no-resp

Type: Command

ArgumentTypeDescription
uuidenum ()
data-hexstring
data-strstring
data-bytesmulti_arg { array-id, num }
pdevenum ()

iot/bluetooth/connections/read

Type: Command

ArgumentTypeDescription
uuidenum ()
pdevenum ()
Read-only ArgumentTypeDescription
valuestring
hexstring
bytesmulti_arg { array-id, num }

iot/bluetooth/connections/subscribe

Type: Command

ArgumentTypeDescription
uuidenum ()
typeenum (notification | indication)
pdevenum ()

iot/bluetooth/connections/unsubscribe

Type: Command

ArgumentTypeDescription
uuidenum ()
typeenum (notification | indication)
pdevenum ()

iot/bluetooth/connections/disconnect

Type: Command

ArgumentTypeDescription
pdevenum ()