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.
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 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.
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:
Serial Number [string]
The CPE unique identifier.
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
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
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
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:
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:
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.
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:
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:
Username [string]
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:
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:
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
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:
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
Works the same way as the 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.
