> For the complete documentation index, see [llms.txt](https://docs.oktopus.app.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oktopus.app.br/getting-started/enterprise-edition/scripts.md). # Scripts ## 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](https://www.lua.org/manual/5.1/) ### 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](https://github.com/yuin/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: ```json { "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: {% tabs %} {% tab title="Get" %} ```lua 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 ``` {% endtab %} {% tab title="Set" %} ```lua local uspMsg = [[ { "header": { "msg_id": "b7dc38ea-aefb-4761-aa55-edaa97adb2f0", "msg_type": 4 }, "body": { "request": { "set": { "allow_partial":true, "update_objs":[ { "obj_path":"Device.LocalAgent.", "param_settings":[ { "param":"X_VANTIVA-COM_PreConnectTimeout", "value": "55", "required":true } ] } ] } } } } ]] 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 ``` {% endtab %} {% tab title="Delete" %} ```lua local uspMsg = [[ { "header": { "msg_id": "b7dc38ea-aefb-4761-aa55-edaa97adb2f0", "msg_type": 10 }, "body": { "request": { "delete": { "allow_partial": true, "obj_paths": [ "Device.LocalAgent.Subscription.*." ] } } } } ]] local serial_number = "oktopus-0-mqtt" 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, _ in pairs(uspMessageResult) do print(key) end end ``` {% endtab %} {% tab title="Add" %} ```lua local uspMsg =[[ { "header": { "msg_id": "b7dc38ea-aefb-4761-aa55-edaa97adb2f0", "msg_type": 8 }, "body": { "request": { "add": { "allow_partial": true, "create_objs": [ { "obj_path": "Device.LocalAgent.Subscription.", "param_settings": [ { "param": "NotifType", "value": "OperationComplete", "required": true }, { "param": "Persistent", "value": "1", "required": true }, { "param": "ReferenceList", "value": "Device.IP.Diagnostics.DownloadDiagnostics(),Device.IP.Diagnostics.UploadDiagnostics()", "required": true }, { "param": "NotifRetry", "value": "0", "required": true }, { "param": "Enable", "value": "1", "required": true }, { "param": "Recipient", "value": "Device.LocalAgent.Controller.1", "required": true } ] } ] } } } } ]] local serial_number = "oktopus-0-mqtt" 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, _ in pairs(uspMessageResult) do print(key) end end ``` {% endtab %} {% endtabs %} ### 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: ```json { "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: {% tabs %} {% tab title="GetParameterValues" %} 
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
{% endtab %} {% tab title="AddObject" %} 
local addObjectType = 2

local xmlContentAdd = [[
<?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:AddObject>
      <ObjectName>InternetGatewayDevice.LANDevice.1.WLANConfiguration.</ObjectName>
      <ParameterKey></ParameterKey>
    </cwmp:AddObject>
  </soap:Body>
</soap:Envelope>
]]
local serial_number = "HUAWNFYC-OPA123-0"

local addTest = send_cwmp_message(serial_number, xmlContentAdd, addObjectType)
if addTest["error_message"] ~= nil then
    print("SN: " .. serial_number .. " | Error Message: " .. addTest["error_message"] .. " | Code: " .. addTest["error_code"])
 else
    print("instance_number: " .. addTest.instance_number)
    print("status: " .. addTest.status)
end
{% endtab %} {% tab title="SetParameterValues" %} ```lua local setParameterValuesType = 1 local xmlContentSet = [[ InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Enable 1 ]] local serial_number = "HUAWNFYC-35454645" local setTest = send_cwmp_message(serial_number, xmlContentSet, setParameterValuesType) if type(setTest) == "table" then print("SN: " .. serial_number .. " | Error Message: " .. setTest["error_message"] .. " | Code: " .. setTest["error_code"]) else print("SetParameterValues worked") end ``` {% endtab %} {% tab title="DeleteObject" %} ```lua local deleteObjectType = 3 local xmlContentDelete = [[ InternetGatewayDevice.LANDevice.1.WLANConfiguration.8. ]] local serial_number = "HUAWNFYC-OPA123-0" local deleteTest = send_cwmp_message(serial_number, xmlContentDelete, deleteObjectType) if type(deleteTest) == "table" then print("SN: " .. serial_number .. " | Error Message: " .. deleteTest["error_message"] .. " | Code: " .. deleteTest["error_code"]) else print("DeleteObject worked") end ``` {% endtab %} {% tab title="GetParameterNames" %} ```lua local getParameterNamesType = 4 local xmlContentGetParameterNames = [[ InternetGatewayDevice.LANDevice.1.WLANConfiguration. 1 ]] local serial_number = "HUAWNFYC-OPA123-0" local getParameternames = send_cwmp_message(serial_number, xmlContentGetParameterNames, getParameterNamesType) if getParameternames["error_message"] ~= nil then print("SN: " .. serial_number .. " | Error Message: " .. getParameternames["error_message"] .. " | Code: " .. getParameternames["error_code"]) else for _, value in pairs(getParameternames) do print("Parameter Name" .. value) end end ``` {% endtab %} {% endtabs %} ### send\_cwmp\_async\_message() Works the same way as the[ send\_cwmp\_message()](#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) 5. Discard if processing \[boolean] (optional)\ When `true`, an incoming event for a device that already has an event being processed (i.e. still running the callback) is discarded instead of waiting for a free worker slot. Useful to avoid piling up stale events for a slow or unresponsive device. Defaults to `false`, which queues the event until a worker slot frees up. Return: ```json { "serial_number": "HUAWNFYC-35454645", "event": "0" } ``` Example: ```lua 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) ``` To process up to 10 events concurrently, and discard new events arriving for a device that's still being processed: ```lua 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, 10, true) ``` ### 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: ```json { "sn": "HUAWNFYC-35454645", "model": "WS7001-40", "vendor": "Huawei Technologies Co., Ltd.", "version": "", "product_class": "Huawei", "alias": "", "status": 2, "cwmp": true, "usp": false, "data_model": "TR-098" } ``` `data_model` reflects the CWMP root data model reported by the CPE, either `"TR-098"` (`InternetGatewayDevice.`) or `"TR-181"` (`Device.`); it is empty for USP-only devices. Example: ```lua 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 ```json { "sn": "HUAWNFYC-35454645", "model": "WS7001-40", "vendor": "Huawei Technologies Co., Ltd.", "version": "", "product_class": "Huawei", "alias": "", "status": 2, "cwmp": true, "usp": false } ``` Example: ```lua 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: ```lua 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: ```lua 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: ```lua 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: ```lua 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: ```lua 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: ```lua if refresh_device_parameters("sn-test-1") == false then print("Failed to refresh device parameters") else print("Device parameters refreshed successfully") end ``` ### http\_request() Make an HTTP call to a third-party REST API to gather or send data. Useful for integrating scripts with external systems (billing, ticketing, monitoring, etc). Only `http`/`https` URLs are accepted; URLs with embedded credentials (e.g. `http://user:pass@host/`) are rejected; this function can only reach external/public hosts. #### Params: 1. Method \[string] HTTP method, e.g. `"GET"`, `"POST"`, `"PUT"`, `"PATCH"`, `"DELETE"`. Defaults to `"GET"` if empty. 2. URL \[string] Full request URL. Must start with `http://` or `https://`. 3. Headers \[table] (optional) Table of header name/value pairs to send with the request. 4. Body \[string] (optional) Request body. Commonly used with `POST`/`PUT`/`PATCH`. Use [json\_encode()](#json_encode) to build a JSON body. Return: A *table* is always returned: ```json { "ok": true, "status_code": 200, "body": "{\"plan\": \"gold\"}", "headers": { "Content-Type": "application/json" }, "error_message": "" } ``` * `ok` is `true` when the request completed with a `2xx` status code. * `error_message` is populated when the request could not be completed at all (invalid URL, blocked target, timeout, connection error) — it does not mean the remote API returned an HTTP error. * Use `body` together with [json\_decode()](#json_decode) to parse JSON responses. Example: {% tabs %} {% tab title="GET" %} ```lua local response = http_request("GET", "https://api.example.com/customers/12345", { ["Authorization"] = "Bearer some-api-token", ["Accept"] = "application/json", }, "") if response.ok == false then print("HTTP request failed | status: " .. tostring(response.status_code) .. " | error: " .. tostring(response.error_message)) return end local data, err = json_decode(response.body) if err ~= nil then print("Failed to decode JSON response: " .. err) return end print("Customer plan: " .. tostring(data["plan"])) ``` {% endtab %} {% tab title="POST" %} ```lua local payload, encErr = json_encode({ status = "active", updated_by = "lua-script" }) if encErr ~= nil then print("Failed to encode JSON payload: " .. encErr) return end local response = http_request("POST", "https://api.example.com/customers/12345", { ["Authorization"] = "Bearer some-api-token", ["Content-Type"] = "application/json", }, payload) if response.ok then print("Customer updated successfully") else print("Failed to update customer | status: " .. tostring(response.status_code)) end ``` {% endtab %} {% endtabs %} ### json\_decode() Parse a JSON string into a Lua table (or scalar value). Commonly used to read the `body` returned by [http\_request()](#http_request). #### Params: 1. JSON string \[string] Return: Two values are returned: the decoded value (table, string, number, boolean or `nil`), and an error message \[string] that is `nil` when decoding succeeds. Example: ```lua local data, err = json_decode('{"sn": "HUAWNFYC-35454645", "online": true}') if err ~= nil then print("Failed to decode JSON: " .. err) else print("sn: " .. data.sn) end ``` ### json\_encode() Convert a Lua table (or scalar value) into a JSON string. Commonly used to build the `body` sent through [http\_request()](#http_request). #### Params: 1. Value \[table, string, number or boolean] Return: Two values are returned: the encoded JSON \[string], and an error message \[string] that is `nil` when encoding succeeds. Example: ```lua local json, err = json_encode({ sn = "HUAWNFYC-35454645", online = true }) if err ~= nil then print("Failed to encode JSON: " .. err) else print(json) end ``` ### get\_service\_instances() List the [service instances](/getting-started/enterprise-edition/services.md#service-instances) attached to a device. #### Params: 1. Serial Number \[string] The CPE unique identifier. Return: A table with `ok` \[boolean], `error_message` \[string], `error_code` \[number] and, on success, `instances` \[table] — an array of tables, each with `id`, `device_id`, `service_id`, `status` and `variables`: ```json { "ok": true, "error_message": "", "error_code": 200, "instances": [ { "id": "665f1b2e8c2a4a1b2c3d4e5f", "device_id": "HUAWNFYC-35454645", "service_id": "665f1a1e8c2a4a1b2c3d4e5e", "status": "provisioned", "variables": { "pppoe_username": "customer123" } } ] } ``` Example: ```lua local result = get_service_instances("HUAWNFYC-35454645") if not result.ok then print("Failed to list service instances: " .. result.error_message) else for _, instance in ipairs(result.instances) do print(instance.id .. " -> " .. instance.status) end end ``` ### create\_service\_instance() Attach a service definition to a device, creating a new service instance. #### Params: 1. Serial Number \[string] — the CPE unique identifier. 2. Service Definition ID \[string]. 3. Variables \[table, optional] — the service-specific variable values for this device. Return: A table with `ok` \[boolean], `error_message` \[string] and `error_code` \[number]. The created instance's id is not returned — call [get\_service\_instances()](#get_service_instances) to look it up. Example: ```lua local result = create_service_instance("HUAWNFYC-35454645", "665f1a1e8c2a4a1b2c3d4e5e", { pppoe_username = "customer123", pppoe_password = "s3cr3t", }) if not result.ok then print("Failed to create service instance: " .. result.error_message) end ``` ### edit\_service\_instance() Replace an existing service instance's device and variables. The service definition id cannot be changed. #### Params: 1. Service Instance ID \[string]. 2. Serial Number \[string] — the CPE unique identifier. 3. Service Definition ID \[string] — must match the instance's current service definition. 4. Variables \[table, optional] — the new service-specific variable values. Return: A table with `ok` \[boolean], `error_message` \[string] and `error_code` \[number]. Example: ```lua local result = edit_service_instance( "665f1b2e8c2a4a1b2c3d4e5f", "HUAWNFYC-35454645", "665f1a1e8c2a4a1b2c3d4e5e", { pppoe_username = "customer123", pppoe_password = "new-password" } ) if not result.ok then print("Failed to edit service instance: " .. result.error_message) end ``` ### delete\_service\_instance() Delete a service instance. #### Params: 1. Service Instance ID \[string]. Return: A table with `ok` \[boolean], `error_message` \[string] and `error_code` \[number]. Example: ```lua local result = delete_service_instance("665f1b2e8c2a4a1b2c3d4e5f") if not result.ok then print("Failed to delete service instance: " .. result.error_message) end ``` ### apply\_service\_instance() Run a service instance's provisioning script against its device right away, instead of waiting for its trigger event (see [Manual Execution](/getting-started/enterprise-edition/services.md#manual-execution)). #### Params: 1. Service Instance ID \[string]. Return: A table with `ok` \[boolean], `error_message` \[string], `error_code` \[number] and, on success, `status` \[string] (`"provisioned"` or `"failed"`). `ok` reflects whether the request itself succeeded; `status` is the actual provisioning outcome — a script can legitimately fail provisioning even though the request succeeded (`ok = true`, `status = "failed"`). Example: ```lua local result = apply_service_instance("665f1b2e8c2a4a1b2c3d4e5f") if not result.ok then print("Failed to apply service instance: " .. result.error_message) elseif result.status ~= "provisioned" then print("Service instance provisioning failed") else print("Service instance provisioned") end ``` ### apply\_service\_instance\_and\_forget() Trigger a service instance's provisioning script the same way [apply\_service\_instance()](#apply_service_instance) does, but don't wait for it to run to completion — the request is enqueued and the function returns immediately. Because it doesn't wait for a response, it can't report the final `status`, and `ok` only reflects whether the message was enqueued locally, not whether the zero-touch-provisioning service actually received or ran it. Use this when applying a service instance whose script may run long (e.g. it calls [sleep()](#sleep) or does several sequential CPE round trips) and the caller doesn't need to wait for the outcome. #### Params: 1. Service Instance ID \[string]. Return: A table with `ok` \[boolean], `error_message` \[string] and `error_code` \[number]. There is no `status` field. Example: ```lua local result = apply_service_instance_and_forget("665f1b2e8c2a4a1b2c3d4e5f") if not result.ok then print("Failed to enqueue service instance apply: " .. result.error_message) end ```