Page cover image

Scripts

Automate your workflow with tasks based on events, jobs, schedules, and more. Limitless capabilities with custom resources to fit your needs.

Introduction

Code is wrritten in Lua, which is a lightweight, high-level programming language designed for embedded use, known for its simplicity and efficiency. Created in Brazil in 1993, it features dynamic typing, first-class functions, and a powerful table data structure, making it versatile for various applications. Lua is widely used in game development for scripting game logic, as well as in embedded systems and applications due to its extensibility and small footprint, allowing developers to easily integrate it with other languages and platforms.

LUA 5.1 Manual

How It Works

To extend Oktopus capabilities and adress the most diverse possible use cases we opted to use a scripting language on top of the actual code, so the gopher-lua library provides Go APIs that allows to easily embed LUA scripts to Go programs.

The Go software can interact to the LUA script and vice-versa. That way, it's possible to pass functions, parameters and events through both USP Controller/ACS and the user created automations.

Core Concepts

A "custom function", is as a function called from LUA which translates to a Go function that can interact with NATS, MongoDB, USP Controller, TR-069 ACS and all the other components of the software stack.

Diagram of Lua Scripts

The "custom functions" will be detailed above in the next topics as just "functions" and separated into domain areas. We hope to provide usefull examples, and the limitation is on each person creativity.

Functions

send_usp_message()

Params:

  1. Serial Number [string]

    The CPE unique identifier.

  2. JSON payload [string]

    Request body to be sent to the CPE. Current supported bodies are : - Get - Set

Return:

  • If the usp message generates an error:

{
    "error_message": "error to set param test.software",
    "error_code: "500"
}

  • In the case of a successful transaction each key of the table will correspond to one of the parameters requested in the payload.

Example:

local uspMsg = [[
{
    "header": {
        "msg_id": "b7dc38ea-aefb-4761-aa55-edaa97adb2f0",
        "msg_type": 1
    },
    "body": {
        "request": {
            "get": {
                "paramPaths": [
                    "Device.STOMP."
                ],
                "maxDepth": 2
            }
        }
    }
}
]]

local serial_number = "oktopus-0-stomp"

local uspMessageResult = send_usp_message(serial_number, uspMsg)
if uspMessageResult["error_message"] ~= nil then
    print("SN: " .. serial_number .. " | Error Message: " .. uspMessageResult["error_message"] .. " | Code: " .. uspMessageResult["error_code"])
else
    for key, value in pairs(uspMessageResult) do
      print(key .. ": " .. value)
    end
end

send_cwmp_message()

Params:

  1. Serial Number [string]

    The CPE unique identifier.

  2. XML payload [string]

    Request body to be sent to the CPE.

  3. Message Type [integer]

    CWMP message type. 0 = getParameterValues 1 = setParameterValues 2 = addObject 3 = deleteObject 4 = getParameterNames

Return:

The data returned depends on the TR-069 message type:

  • If the CWMP message generates an error:

{
    "error_message": "error to set param test.software",
    "error_code: "500"
}

  • If it is a read or add operation the function will return a table.

  • If it is a delete or set operation the data returned will be a boolean indicating if the result was a success or failure.

Example:

local getParameterValuesType = 0

local xmlContentGet = [[
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:cwmp="urn:dslforum-org:cwmp-1-0" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:schemaLocation="urn:dslforum-org:cwmp-1-0 ..\schemas\wt121.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Header/>
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <cwmp:GetParameterValues>
      <ParameterNames>
        <string>InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.</string>
       </ParameterNames>
    </cwmp:GetParameterValues>
  </soap:Body>
</soap:Envelope>
]]
local serial_number = "HUAWNFYC-35454645"

local getTest = send_cwmp_message(serial_number, xmlContentGet, getParameterValuesType)
if getTest["error_message"] ~= nil then
   print("SN: " .. serial_number .. " | Error Message: " .. getTest["error_message"] .. " | Code: " .. getTest["error_code"])
else
  for key, value in pairs(getTest) do
    print(key .. ": " .. value)
  end
end

send_cwmp_async_message()

Works the same way as the send_cwmp_message() function, but does not use the CWMP Connection Request mechanism, which means this RPC will only reach the CPE in the next Inform event of it. This allows to reach CPEs behind NAT, although it takes longer for the RPC to reach and be processed by the device.

listen_to_cwmp_event()

Listen to TR-069 events as defined in the standard.

Params:

  1. Event [string] (optional) Possible events:

    "0"- BOOTSTRAP
"1"- BOOT
"2"- PERIODIC
"3"- SCHEDULED
"4"- VALUE CHANGE
"5"- KICKED
"6"- CONNECTION REQUEST
"7"- TRANSFER COMPLETE
"8"- DIAGNOSTICS COMPLETE
"9"- REQUEST DOWNLOAD
"10"- AUTONOMOUS TRANSFER COMPLETE
"11"- DU STATE CHANGE COMPLETE
"12"- AUTONOMOUS DU STATE CHANGE COMPLETE

    If no value is set or the value is "*", than it listens to all events.

  2. Serial Number [string] (optional) CPE unique identifier. If it's not set or the value is "*", then it listens to all CPEs event(s).

  3. Callback function (required)

  4. Number of events to process in parallel [integer] (optional)

Return:

{
    "serial_number": "HUAWNFYC-35454645",
    "event": "0"
}

Example:

function listen_to_cwmp_event_callback(cwmp_event)
    for key, value in pairs(cwmp_event) do
        print(key .. ": " .. tostring(value))
    end
end
listen_to_cwmp_event(listen_to_cwmp_event_callback)

get_device()

Get device attributes from its unique identifier.

Params:

  1. Serial Number [string]

    The CPE unique identifier.

Return:

If the CPE was not found in the database the function returns a boolean with false value. In case the CPE is found it returns a table with all attributes:

{
    "sn": "HUAWNFYC-35454645",
    "model": "WS7001-40",
    "vendor": "Huawei Technologies Co., Ltd.",
    "version": "",
    "product_class": "Huawei",
    "alias": "",
    "status": 2,
    "cwmp": true,
    "usp": false
}

Example:

SERIAL_NUMBER = "HUAWNFYC-35454645"
local deviceAttributes = get_device(SERIAL_NUMBER)
if type(deviceAttributes) == "boolean" then
  print("device " .. SERIAL_NUMBER .. " not found")
else
  for key, value in pairs(deviceAttributes) do
    print(key .. ": " .. tostring(value))
  end
end

listen_to_new_device()

Receive all new device attributes that connect to Oktopus, independent of the protocol.

Params:

  1. Callback function with new device data

{
    "sn": "HUAWNFYC-35454645",
    "model": "WS7001-40",
    "vendor": "Huawei Technologies Co., Ltd.",
    "version": "",
    "product_class": "Huawei",
    "alias": "",
    "status": 2,
    "cwmp": true,
    "usp": false
}

Example:

function listen_to_new_device_callback(new_device)
  for key, value in pairs(new_device) do
    print(key .. ": " .. tostring(value))
  end
end
listen_to_new_device("*", "*", listen_to_new_device_callback)

sleep()

Blocks the code execution for certain time.

Params:

  1. Time duration [integer] Seconds of blocking the code execution.

Example:

while true do
  print("I'm going to appear again after 20 seconds")
  sleep(20)
end

create_or_update_device_credential()

Params:

  1. Username [string]

  2. Password [string]

Return:

Bool value indicating true if the operation was successfull or false if there was an error.

Example:

local username = "test"
local password = "test"

if create_or_update_device_credential(username, password) then
  print("success")
else
  print("error")
end

generate_random_string()

Params:

  1. Length [int] Size of the string to be generated

Example:

local username = "deviceX"
local password = generate_random_string(10)

if create_or_update_device_credential(username, password) then
  print("success")
else
  print("error")
end

delete_device()

Remove device from database.

Params:

  1. Serial Number [string]

    The unique identifier of the CPE to be removed.

Return:

Bool value indicating true if the operation was successfull and the device was removed from database or false if there was an error.

Example:

local sn = "mqtt_client_92"
if delete_device(sn) then
  print("device " .. sn .. " successfully deleted")
else
  print("error to delete device ".. sn)
end

get_all_devices()

Retrieve all devices saved on the database.

Return:

List of device objects.

[
    {
        "sn": "HUAWNFYC-35454645",
        "model": "WS7001-40",
        "vendor": "Huawei Technologies Co., Ltd.",
        "version": "",
        "product_class": "Huawei",
        "alias": "",
        "status": 2,
        "cwmp": true,
        "usp": false
    },
    {
        "sn": "HUAWNFYC-test",
        "model": "WS7001-40",
        "vendor": "Huawei Technologies Co., Ltd.",
        "version": "",
        "product_class": "Huawei",
        "alias": "",
        "status": 2,
        "cwmp": true,
        "usp": false
    },
    ...
]

Example:

local devices = get_all_devices()

for i = 1, #devices do
    local device = devices[i]
    print("  SN: " .. device.sn)
end

refresh_device_parameters()

Sync device saved parameters, as PPPoE user, IP address and WAN MAC.

Params:

  1. Serial number / USP agent endpoint id [string] The unique identifier of the CPE to be removed.

Return: Bool value indicating f the operation was successfully executed ot not.

Example:

if refresh_device_parameters("sn-test-1") == false then
    print("Failed to refresh device parameters")
else
    print("Device parameters refreshed successfully")
end

PreviousEnterprise EditionNextIntegrations

Last updated

Was this helpful?