ip.buffer OEM Manual
2. Configuration Table
c - Base Configuration
c.alerts - Alerts Config
c.battery - Battery Config
c.certs - Certificate Options
c.chnl - Channel Configuration
c.chnl.dst - Channel Delivery
c.chnl.dst.com - COM Port Delivery
c.chnl.dst.emul - Legacy Emulation Delivery
c.chnl.dst.ftpc - FTP Push Delivery
c.chnl.dst.ftps - FTP Server Delivery
c.chnl.dst.httpc - HTTP POST Delivery
c.chnl.dst.smtp - Email Delivery
c.chnl.dst.tcpc - TCP Push Delivery
c.chnl.dst.tcps - TCP Server Delivery
c.chnl.dst.trig - Delivery Trigger
c.chnl.mem - Channel Memory
c.chnl.notify - Channel Notification
c.chnl.src - Channel Source
c.chnl.src.cloud - Cloud Server Source
c.chnl.src.com - Serial Source
c.chnl.src.ftps- FTP Server Source
c.chnl.src.pass - Pass-Through
c.chnl.src.protocol - Source Protocol
c.chnl.src.tcp - TCP Source
c.chnl.src.udp - UDP Source
c.cloud - Cloud Server
c.debug - Debug Output
c.ftps - FTP Server
c.globals - Global Configuration
c.lua - User Lua Placeholder
c.modem - Modem & PPP
c.network - LAN Config
c.proxy - LAN Proxy
c.radius - RADIUS Authentication
c.smtp - Email Servers
c.snmp - SNMP Agent
c.sntp - Time Server
c.web - Web Server
3. Information Table
🗒️ Information Table Overview
i - Global
i.alerts - Alerts
i.chnl.dst - Delivery
i.chnl.src - Source Status
i.chnl.src.cloud - Source Cloud Server
i.chnl.src.com - Source COM Serial
i.chnl.src.ftps - Source FTP Server
i.chnl.src.pass - Source Pass-Through
i.chnl.src.tcp - Source TCP
i.chnl.src.udp - Source UDP
i.cloud - Cloud Data
i.device - Device
i.mem - Flash Memory
i.modem - Modem Status
i.sntp - Time Update
i.system - System
4. Diagnostics Table
d.chnl.src - Source Diagnostics
d.cloud - Cloud Server Diagnostics
d.cloud.cache - Cloud Server Cache Diagnostics
d.modem - Modem Diagnostics
5. Lua Function Hooks
onConfigChanged - Execution Hook
onWebAppSettings- Execution Hook
x.alerts - Alert Hooks
x.auth - Authentication Hooks
x.chnl.dst - Destination Hooks
x.chnl.pass - Pass-through Hooks
x.chnl.src - Source Hooks
x.cloud - Cloud Server Hook
x.ftp - FTP Hook
x.http - Web Server Hooks
x.onrun - Execution Hook
x.onsecond - Timed
6. Lua Library Extensions
_others
applycrlf
asciihex
stripcodes
alert
🗒️ alert Library
alert.alarm
alert.clearall
alert.register_counter
alert.register_holdoff
alert.register_oneshot
alert.register_raw
alert.register_trap
arp
arp.clear
arp.del
arp.find
arp.table
atomic
atomic.execute
atomic.lock
atomic.modify
atomic.testandset
atomic.unlock
auth
auth.hash
auth.hashcompare
auth.hashformat
auth.md5
auth.radius
auth.sha1
bit
🗒️ bit Library
bit.arshift
bit.band
bit.bnot
bit.bor
bit.bxor
bit.cast
bit.lshift
bit.rshift
bit.swap8
bit.swap16
bit.swap32
cloud
cloud.basicfirst
cloud.cachelimit
cloud.chunksize
cloud.datalimit
cloud.flush
cloud.frequency
cloud.infotime
cloud.send
cloud.senddiag
cloud.sendinfo
cloud.sendlog
crc
crc.calc
crc.crc8
crc.crc8_finish, crc16_finish, crc32_finish, crcxmodem_finish
crc.crc8_init, crc16_init, crc32_init, crcxmodem_init
crc.crc8_update, crc16_update, crc32_update, crcxmode_update
crc.crc16
crc.crc32
crc.crcxmodem
dns
dns.clear
dns.empty
dns.hostbyaddr
dns.hostbyname
dns.match
dns.setcache
dns.table
emulation
emulation event callbacks
emulation.connect
emulation.create
emulation.destroy
emulation general functions
emulation.sleep
emulation memory functions
emulation.adv
emulation.close
emulation.erase
emulation.erasefrozen
emulation.freeze
emulation.frozen
emulation.get
emulation.open
emulation.reset
emulation.stopsoon
emulation socket functions
emulation.dead
emulation.flush
emulation.read
emulation.sent
emulation.write
emulation variables
emulation.n (variable)
emulation.peer (variable)
emulation.telnet (variable)
🗒️ emulation Library
float
fao - Float Array Object
🗒️ fao - Float Array Object Intro
fao﹕add
fao﹕clr
fao﹕copy
fao﹕div
fao﹕each
fao﹕ft
fao﹕get
fao﹕mul
fao﹕push
fao﹕range
fao﹕set
fao﹕sin
fao﹕size
fao﹕sqrt
fao﹕stat
fao﹕sub
fao﹕sum
fao﹕tab
fao﹕wt
fao﹕xs
mpco - Multi Point Conversion Object
🗒️ mpco - Multi Point Conversion Object Intro
mpco﹕oob
mpco﹕range
mpco﹕set
mpco﹕sort
mpco﹕xy
mpco﹕xyt
mpco﹕y
polyo - Polynomial Object
🗒️ polyo - Polynomial Object Intro
polyo﹕c
polyo﹕terms
polyo﹕y
rro - Running Regression Object
🗒️ rro - Running Regression Object Intro
rro﹕add
rro﹕clear
rro﹕get
rro﹕push
rso - Running Statistics Object
🗒️ rso - Running Statistics Object Intro
rso﹕add
rso﹕clear
rso﹕get
rso﹕push
float.array
float.d2v
float.d2x
float.dp
float.f2v
float.f2x
float.isfin
float.isinf
float.isnan
float.isnor
float.mean
float.mpc
float.poly
float.regr
float.stat
float.v2d
float.v2f
float.x2d
float.x2f
job
jobe - Job Entry Object
🗒️Using Job Lists and Job Entry Objects
jobe﹕clear
jobe﹕enable
jobe﹕func
jobe﹕get
jobe﹕id
jobe﹕run
jobe﹕set
jobe﹕stop
jobe﹕txt
jobe﹕user
jobe﹕utc
🗒️Job Library
Job Schedule Strings
job.add
job.del
job.get
job.new
job.run
job.second
job.set
job.txt
job.utc
job.var
job.variance
jobq
jqo - Job Queue Object
jqo﹕add
jqo﹕del
jqo﹕is
jqo﹕pop
jqo﹕poprun
jqo﹕run
🗒️ Job Queue Library
jobq.new
jobs
🗒️Job List Library
key
🗒️ key Library
key.clear
key.empty
key.exists
key.hash
key.isblank
key.keys
key.license
key.save
key.scriptlicense
key.set
log
log.clear
log.write
mem
mem.resetflags
mem.resetstats
mem.store
mem.wipefile
mem.wipestore
mem.write
modbus
Modbus Format Strings
Modbus Object
modbus.cmd
modbus.fs2t
modbus.ft2s
modbus.rdi
modbus.rhr
modbus.rir
modbus.rmc
modbus.rsid
modbus.rx
modbus.set
modbus.tx
modbus.wmr
modbus.wsc
modbus.wsr
modem
modem event callback functions
modem.bytes
modem.clearfplmn
modem.cmd
modem.debug
modem.decided
modem.fplmn
modem.hangup
modem.iscell
modem.isedge
modem.isgprs
modem.ismodem
modem.ispstn
modem.powercycle
modem.poweroverride
modem.reset
modem.simrb
modem.sims
modem.simwb
modem.stot
net
🗒️ net Library
net.arp
net.arpclear
net.arpdel
net.arpfind
net.dnsclear
net.firewall
net.hdap
net.hostbyname
net.lowpower
net.ping
net.power
nmea
nmea.tab
nmea.txt
os
os.localtime
os.utctime
pcb
pcb Helper API Methods
pcb._pk
pcb.bits2string
pcb.cmd
pcb.rd
pcb.rd1, .rd2, .rd4
pcb.rdvar
pcb.reasons2string
pcb.rndb
pcb.string2bits
pcb.string2reasons
pcb.t
pcb.var
pcb.wr
pcb.wr1, .wr2, .wr4
pcb.user - Access User Data
🗒️ pcb.user - Access User Data
pcb.user.read
pcb.user.write
pcb.alive
pcb.debug
pcb.info
pcb.led
pcb.led_clear
pcb.led_set
pcb.mv
pcb.off
pcb.ok
pcb.onfor
pcb.power_clear
pcb.power_off
pcb.power_on
pcb.power_out
pcb.random
pcb.reasons
pcb.reset_cause
pcb.temp
pcb.version
pcb.wakeup
profiler
profiler.bootms
profiler.getms
profiler.getus
profiler.log
profiler.restart
profiler.time
sdi12
🗒️ SDI-12 Example
sdi12.ack
sdi12.brk
sdi12.chg
sdi12.crc
sdi12.done
sdi12.go
sdi12.id
sdi12.mrk
sdi12.rx
sdi12.set
sdi12.t
sdi12.tx
sdit SDI-12 Table Structure
semaphore
Semaphore Objects
🗒️ Semaphore Object Intro
semo﹕clear
semo﹕release
semo﹕value
semo﹕wait
🗒️ Semaphore Library
semaphore.mutex
semaphore.new
serial
comport Objects
🗒️ COMport Object Intro
cpo﹕acquire
cpo﹕brk
cpo﹕cmd
cpo﹕cts
cpo﹕dir
cpo﹕dsr
cpo﹕dtr
cpo﹕mrk
cpo﹕nrx
cpo﹕okr
cpo﹕pin
cpo﹕prot
cpo﹕release
cpo﹕rts
cpo﹕rx
cpo﹕rxe
cpo﹕rxf
cpo﹕rxu
cpo﹕rxw
cpo﹕set
cpo﹕tx
cpo﹕txf
cpo﹕wtx
serial.control
serial.getcts
serial.getdir
serial.getdsr
serial.getdtr
serial.getpin
serial.getrts
serial.port
serial.rxbreak
serial.setdir
serial.setdtr
serial.setrts
serial.txbreak
serial.txing
snmp
🗒️ snmp Library
snmp.decode
snmp.decoderset
snmp.trap
socket
socket object
socko﹕accept
socko﹕close
socko﹕flush
socko﹕inflight
socko﹕isopen
socko﹕open
socko﹕recv
socko﹕send
socko﹕setbacklog
socko﹕ssl
socko﹕sslclose
socko﹕wait
socket.list (Table)
socket.new
socket.select
source
source.close
source.debug
source.dodata
source.error
source.event_wait
source.inject
source.injecta
source.injectclear
source.push
source.pushclose
source.pushopen
source.read
source.readbytes
source.readline
source.readuntil
source.record
source.sleep
source.splitline
source.stopping
source.store
source.storebinary
source.timestamp
source.unwindline
source.web
source.webreset
source.write
source.writebytes
sources (Table)
string
string.findm
string.iterate
string.matchm
struct
Format Strings
struct.pack
struct.size
struct.unpack
thread
Thread Object
threado﹕die
threado﹕run
threado﹕running
threado﹕wait
thread.count
thread.list (table)
thread.new
time
time.calcdst
time.dayofweek
time.localtoutc
time.set
time.setlocal
time.setutc
time.utctolocal
tools
tools.abortdst
tools.abortpass
tools.abortsrc
tools.alive
tools.ascii
tools.batteryoff
tools.bool
tools.checkforupdates
tools.clearmenu
tools.debug
tools.disablecrypto
tools.disablefeatures
tools.fixending
tools.gc
tools.get
tools.getfield
tools.gethwid
tools.getmanuf
tools.istls
tools.ledduty
tools.lock
tools.neterrstr
tools.reboot
tools.run
tools.set
tools.setfield
tools.setmenu
tools.sleep
tools.unlock
tools.unquote
trigger
🗒️trigger Library
trigger.cancel
trigger.cancelall
trigger.push
twi
twi.qy
twi.rd
twi.wr
utc
utc.fmt
utc.fn
utc.inr
utc.job
utc.now
utc.split
utc.spm
utc.txt
utc.val
utc.wds
util
util.add
util.addi
util.au8
util.au16
util.cmpi
util.csvt
util.cuti
util.dct
util.find
util.iter
util.remi
util.tia
util.tio
util.u8a
util.u8u16
util.u16u8
zlib
zlib.check
zlib.deflate
zlib.inflate
7. Advanced Functions
Writing New Protocol Scripts
1. Writing the Protocol
2. Protocol Functions
3. Testing the Protocol
4. Protocol Sets
Calling code after boot completes
Executing Lua every time data is stored
Filtering data for pass-through operations
Reporting Channel Status on Web
8. Example Lua Scripts
Discarding Data
Duplicating Data
Masking Telephone Digits
Simple Prefix
Versions
v2.90 2014-02-14
v2.91 2014-10-23
v2.92 2015-11-03
v2.93 2016-07-20
v2.95 2018-03-20
v3.00 2020-12-15
v3.01 2021-03-02
v3.02 2021-12-20
v3.10 2024-07-30
v3.20 2024-12-23
index
Get Job Entry ID String
#Firmware/v320
id = jobe:id()
Returns
Type
Description
id
string
The unique identifier for the job list.