Skip to main content
Version: Next

Introduction

Welcome to the Configuration API section. Here you can find the overview of all the Configuration APIs using Lua script.

On this page you can find all the Configuration APIs that enable device functionality with help of Lua scripts. Following APIs are divided into different categories fit for specific device types.

The currently implemented Lua version is 5.1.5. Please, consult Configuration API firmware changelog for potential changes and older versions.

interesting

Please note, that you may filter the articles based on the devices. The device filter can be found in the upper right corner.

Details

Example GIF Filter by device

Categories​

These are the following categories. Note, that they are not mutually exclusive.

Common​

This category contains functions that are used for all the devices. It contains all the basic functions.

LoRaWAN​

This category contains functions specific to LoRaWAN devices needed for configuration and communication within LoRaWAN.

NB-IoT​

This category contains functions specific to NB-IoT devices needed for configuration and communication within NB-IoT.

S0 Pulse​

This category contains functions specific to pulse S0 devices, that are required for their configuration, readout and others.

M-Bus​

This category contains functions specific to M-Bus devices, that are required for their configuration, readout and others.

Wireless M-Bus​

This category contains functions specific to Wireless M-Bus devices, that are required for their configuration, readout and others.

RS-485, Modbus​

This category contains functions specific to RS-485 or Modbus devices, that are required for their configuration, readout and others.

DIO​

This category contains functions, that enable pulse devices to use DIO (digital input/output).

DALI​

This category contains functions, that are used for DALI interface communication.

Supported Lua Libraries​

The following Lua functions are implemented in the firmware:

  • "byte"
  • "char"
  • "dump"
  • "find"
  • "format"
  • "gfind"
  • "gmatch"
  • "gsub"
  • "len"
  • "lower"
  • "match"
  • "rep"
  • "reverse"
  • "sub"
  • "upper"