iot

---

iot/bluetooth

Package: iot
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/advertisers

Package: iot
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)	Address type used in AdvA field
channel-map	ubit (37, 38, 39)
phy	enum (1M | 2M | CODED)
legacy	bool
ad-structures	multi { array-id, enum }

Read-only Argument	Type	Description
device	enum
ad-size	num

iot/bluetooth/advertisers/ad-structures

Package: iot
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/connections

Package: iot
Type: Directory

Read-only Argument	Type	Description
name	string
direction	enum (incoming | outgoing)

iot/bluetooth/connections/async-data

Package: iot
Type: Directory

Read-only Argument	Type	Description
pdev	string
uuid	string
data-text	string
data-hex	string
data-bytes	multi { array-id, num }
type	enum (notification | indication)
time	date

iot/bluetooth/connections/async-data/clear

Package: iot
Type: Command

iot/bluetooth/connections/characteristics

Package: iot
Type: Directory

Read-only Argument	Type	Description
name	string
uuid	string
handle	num
service-name	string
service-uuid	string
props	multi { 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/connect

Package: iot
Type: Command

Argument	Type	Description
pdev	enum

iot/bluetooth/connections/disconnect

Package: iot
Type: Command

Argument	Type	Description
pdev	enum ()

iot/bluetooth/connections/read

Package: iot
Type: Command

Argument	Type	Description
uuid	enum ()
pdev	enum ()

Read-only Argument	Type	Description
value	string
hex	string
bytes	multi { array-id, num }

iot/bluetooth/connections/subscribe

Package: iot
Type: Command

Argument	Type	Description
uuid	enum ()
type	enum (notification | indication)
pdev	enum ()

iot/bluetooth/connections/unsubscribe

Package: iot
Type: Command

Argument	Type	Description
uuid	enum ()
type	enum (notification | indication)
pdev	enum ()

iot/bluetooth/connections/write

Package: iot
Type: Command

Argument	Type	Description
uuid	enum ()
data-hex	string
data-str	string
data-bytes	multi { array-id, num }
pdev	enum ()

iot/bluetooth/connections/write-no-resp

Package: iot
Type: Command

Argument	Type	Description
uuid	enum ()
data-hex	string
data-str	string
data-bytes	multi { array-id, num }
pdev	enum ()

iot/bluetooth/decode-ad

Package: iot
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 { 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/peripheral-devices

Package: iot
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	Advertisement data in hex format
last-seen	date
beacon-types	multi { 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 { 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/reset-counters

Package: iot
Type: Command

iot/bluetooth/scanners

Package: iot
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)	Address type used in scan requests
filter-policy	enum (default | whitelist)
filter-duplicates	enum (off | keep-oldest | keep-newest | keep-unique)	Discard duplicate advertisements from the same advertiser
phy	enum (1M | 2M | CODED)

Read-only Argument	Type	Description
device	enum

iot/bluetooth/scanners/advertisements

Package: iot
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
epoch	num	Milliseconds since Unix Epoch
address-type	enum (public | random)
address	macAddr	Advertiser Bluetooth address
rssi	num	Signal strength
length	num	Advertisement data length
data	string	Advertisement data in hex format
phy	enum (1M | 2M | CODED-S8 | CODED-S2 | NONE)	Advertisement primary PHY
phy-secondary	enum (1M | 2M | CODED-S8 | CODED-S2 | NONE)	Advertisement secondary PHY
legacy	bool	Advertisement legacy compatibility
filter-comment	string	Comment of the matching whitelist filter

iot/bluetooth/scanners/advertisements/clear

Package: iot
Type: Command

iot/bluetooth/whitelist

Package: iot
Type: Directory

Flag	Name	Description
X	disabled

Argument	Type	Description
device ( mandatory )	enum
address-type ( mandatory )	enum (public | random | any)
address ( mandatory )	string

iot/gpio

Syscap: gpio
Package: iot
Type: Directory

iot/gpio/analog

Package: iot
Type: Directory

Argument	Type	Description
offset	num

Read-only Argument	Type	Description
name	string
value	num

iot/gpio/digital

Package: iot
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

Package: iot
Type: Directory

Flag	Name	Description
X	disabled

Argument	Type	Description
gateway-id	string { }
name	string
servers	multi { 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/channels

Package: iot
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/joineui

Package: iot
Type: Directory

Argument	Type	Description
name ( mandatory )	string
logging	bool
type	enum (whitelist | blacklist)
joineuis	object { composite { , } { , } }

iot/lora/netid

Package: iot
Type: Directory

Argument	Type	Description
name ( mandatory )	string
logging	bool
type	enum (whitelist | blacklist)
netids	object { composite { , } { , } }

iot/lora/radios

Package: iot
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/reset-devices

Package: iot
Type: Command

iot/lora/send

Package: iot
Type: Command

Argument	Type	Description
device-id	num	device id
payload	string	TX packet payload
power	num	RF power in dBm
frequency	num	Radio TX frequency in MHz (e.g.868500000)
bandwidth	enum (125KHZ | 250KHZ | 500KHZ)	LoRa bandwidth in khz [125, 250, 500]
spread-factor	enum (SF7 | SF8 | SF9 | SF10 | SF11 | SF12 | MULTI)	Spread Factor
modulation	enum (MOD_CW | MOD_LORA | MOD_FSK)	modulation type
preamble	num	preamble length
inverted	bool	invert polarity

iot/lora/servers

Package: iot
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 { enum }
joineui	multi { enum }

iot/lora/servers/reset-servers

Package: iot
Type: Command

iot/lora/traffic

Package: iot
Type: Directory

Read-only Argument	Type	Description
time	date
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

Package: iot
Type: Command

iot/lora/traffic/options

Package: iot
Type: Settings Directory

Argument	Type	Description
crc-errors	bool	log packets with CRC errors
pckt-limit	num	limit packets in log

iot/modbus

Package: iot
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

Package: iot
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 { array-id, num }

iot/modbus/security-rules

Package: iot
Type: Directory

Flag	Name	Description
X	disabled

Argument	Type	Description
ip-range ( mandatory )	ipRange
allowed-function-codes ( mandatory )	multi { array-id, num }

iot/modbus/transceive

Package: iot
Type: Command

Argument	Type	Description
address	num
function	num
data	string
values	multi { array-id, num }
rx-switch-offset	num

Read-only Argument	Type	Description
address	num
function	num
data	string
values	multi { array-id, num }
time	date
status	enum (ok | error)
error	num
error-description	string

iot/mqtt

Package: iot
Type: Settings Directory

iot/mqtt/brokers

Package: iot
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/connect

Package: iot
Type: Command

Argument	Type	Description
broker	enum ()

iot/mqtt/disconnect

Package: iot
Type: Command

Argument	Type	Description
broker	enum ()

iot/mqtt/publish

Package: iot
Type: Command

Argument	Type	Description
broker	enum ()
topic	string
message	string
qos	num
retain	bool
disconnect-after	bool
force	bool

iot/mqtt/subscribe

Package: iot
Type: Command

Argument	Type	Description
broker	enum ()
topic	string
qos	num
force	bool

iot/mqtt/subscriptions

Package: iot
Type: Directory

Argument	Type	Description
broker	enum ()
topic	string
qos	num
on-message	string

iot/mqtt/subscriptions/monitor-data

Package: iot
Type: Command

Read-only Argument	Type	Description
data	string
time	date
topic	string
broker	enum ()

iot/mqtt/subscriptions/recv

Package: iot
Type: Directory

Read-only Argument	Type	Description
broker	enum ()
topic	string
data	string
time	date

iot/mqtt/subscriptions/recv/clear

Package: iot
Type: Command

iot/mqtt/unsubscribe

Package: iot
Type: Command

Argument	Type	Description
broker	enum ()
topic	enum ()

iot/wiliot

Package: iot
Type: Settings Directory

Argument	Type	Description
spoof-gps	bool
lat	num
long	num
server	enum (none)	Used MQTT server
scanner	enum (none)
advertiser	enum (none)
wi-fi	iface_enum { , none:nv::BADID }
features	ubit (gateway, bridge)	supported Wiliot features

Read-only Argument	Type	Description
status	string
gateway-id	string
type	string
owner	string

iot/wiliot/bluetooth-traffic

Package: iot
Type: Directory

Read-only Argument	Type	Description
time	date
address	macAddr	Advertiser Bluetooth address
rssi	num	Signal strength
payload	string	Payload

iot/wiliot/bluetooth-traffic/clear

Package: iot
Type: Command

iot/wiliot/clear

Package: iot
Type: Command

iot/wiliot/disable

Package: iot
Type: Command

Read-only Argument	Type	Description
status	string

iot/wiliot/enable

Package: iot
Type: Command

Read-only Argument	Type	Description
status	string

iot/wiliot/mqtt-traffic

Package: iot
Type: Directory

Read-only Argument	Type	Description
time	date
topic	string
data	string

iot/wiliot/mqtt-traffic/clear

Package: iot
Type: Command

iot/wiliot/options

Package: iot
Type: Settings Directory

Argument	Type	Description
token-refresh-handicap	num	handicap for refreshing token
pckt-limit	num	mqtt log packet limit

iot/wiliot/servers

Package: iot
Type: Directory

Argument	Type	Description
name ( mandatory )	string
address ( mandatory )	string
port	num
ssl	bool
certificate	enum (none)

iot/wiliot/servers/defaults

Package: iot
Type: Command