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.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

alert

🗒️ alert Library

alert.register_counter

alert.register_holdoff

alert.register_oneshot

alert.register_raw

alert.register_trap

arp

atomic

atomic.testandset

auth

auth.hashcompare

auth.hashformat

bit

🗒️ bit Library

cloud

cloud.basicfirst

cloud.cachelimit

cloud.chunksize

cloud.datalimit

cloud.frequency

crc

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

dns

emulation

emulation event callbacks

emulation.connect

emulation.create

emulation.destroy

emulation general functions

emulation.sleep

emulation memory functions

emulation.close

emulation.erase

emulation.erasefrozen

emulation.freeze

emulation.frozen

emulation.reset

emulation.stopsoon

emulation socket functions

emulation.flush

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

mpco - Multi Point Conversion Object

🗒️ mpco - Multi Point Conversion Object Intro

polyo - Polynomial Object

🗒️ polyo - Polynomial Object Intro

rro - Running Regression Object

🗒️ rro - Running Regression Object Intro

rso - Running Statistics Object

🗒️ rso - Running Statistics Object Intro

job

jobe - Job Entry Object

🗒️Using Job Lists and Job Entry Objects

🗒️Job Library

Job Schedule Strings

jobq

jqo - Job Queue Object

🗒️ Job Queue Library

jobs

🗒️Job List Library

key

🗒️ key Library

key.scriptlicense

log

mem

modbus

Modbus Format Strings

modem

modem event callback functions

modem.clearfplmn

modem.powercycle

modem.poweroverride

net

🗒️ net Library

nmea

os

pcb

pcb Helper API Methods

pcb.bits2string

pcb.rd1, .rd2, .rd4

pcb.reasons2string

pcb.string2bits

pcb.string2reasons

pcb.wr1, .wr2, .wr4

pcb.user - Access User Data

🗒️ pcb.user - Access User Data

pcb.power_clear

pcb.reset_cause

profiler

profiler.bootms

profiler.restart

sdi12

🗒️ SDI-12 Example

sdit SDI-12 Table Structure

semaphore

Semaphore Objects

🗒️ Semaphore Object Intro

🗒️ Semaphore Library

semaphore.mutex

serial

comport Objects

🗒️ COMport Object Intro

snmp

🗒️ snmp Library

snmp.decoderset

socket

socket object

socko﹕inflight

socko﹕setbacklog

socko﹕sslclose

socket.list (Table)

source

source.event_wait

source.injectclear

source.pushclose

source.pushopen

source.readbytes

source.readline

source.readuntil

source.splitline

source.stopping

source.storebinary

source.timestamp

source.unwindline

source.webreset

source.writebytes

sources (Table)

string

struct

thread

Thread Object

threado﹕running

thread.list (table)

time

time.localtoutc

time.utctolocal

tools

tools.abortpass

tools.batteryoff

tools.checkforupdates

tools.clearmenu

tools.disablecrypto

tools.disablefeatures

tools.fixending

tools.neterrstr

trigger

🗒️trigger Library

trigger.cancelall

twi

utc

util

zlib

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

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

Return Receive Break Count

n = serial.rxbreak(portn)

Returns, and resets, the receive break sequence counter.

Parameter	Type	Description
`portn`	integer	Port number 1-4