Property:obl fboxname.lua

---

BoxMatrix >> Webinterface >> obl_fboxname.lua

@ BoxMatrix   -   IRC-Chat   -   Translate: de es fr it nl pl

News

Selectors

Models

Accessories

Components

Environment

Config

Commands

System

Webif

Software

Develop

Lexicon

Community

Project

Media

---

UI-Structure

UI-Modules

HTML-Files

XML-Files

Lua-Scripts

Javascript

Browser

SSI-Files

SSI-Directives

HTML-Text

Event-Text

Help-Pages

CSS-Files

Graphics

Research

---

Lua-Script

Lua-Script:	obl_fboxname.lua   -   type Script	Wiki	Freetz	IPPF	whmf	AVM	Web
Location:	Webinterface >> Lua-Scripts   -   Origin: AVM
Path:	Release: /usr/rest_api Lab+Rel: /usr/rest_api
Properties:	Size: 8.0k   -   Firmware: 7.39
Function:	REST-API Demo Module

Goto:   Boxname  -  Functions  -  Dependencies   -   Model-Matrix   -   SMW-Browser

Details

This has been found in Labor, but did not make it to Release. It may be a test case or a future feature.

obl_fboxname.lua is a REST-API Demo Module for testing purposess.
It is loaded by rest_config.lua and provides the obl_fboxname endpoint, which is accessible by:

GET /api/v0/obl_fboxname          # returns hello="world"
GET /api/v0/obl_fboxname/error    # returns a test error
GET /api/v0/obl_fboxname/fboxname # get Fritzbox hostname 
PUT /api/v0/obl_fboxname/fboxname # set the Fritzbox-Name

The last function is a perfect overview of how to set the Fritzbox-Name. See the Boxname section below.

REST-API:

• Lexicon: REST-API
• Commands: scgi_server
• Ports: Port-8187-tcp
• UI-Mods: webui
• API-Root: api.lua
• Includes: api_generic.lua, rest_config.lua, security.lua, espresso.lua
• Includes: rest_api_const.lua, response.lua, error.lua, avmluamessages.lua
• Includes: uimod.lua, api_generic_filter.lua, resource.lua
• Modules: storagenasrights_rest.lua, webusb_rest.lua
• Modules: calllog_rest.lua, faxjournal_rest.lua, phonebook_rest.lua
• Modules: smarthome_rest.lua, boxnotify_rest.lua
• Develop: obl_fboxname.lua, dev_debug.lua, landevice.lua
• Develop: query_tree.lua, fake_modules.lua, obl.lua

Boxname

The setFboxName function is a good explanation where the Fritzbox-Name is changed.
This is just a collection. Which of these are set depends on the operating mode and device type.

ctlmgr_ctl w box settings/hostname "<name>"
ctlmgr_ctl w box settings/dhcpc_hostname "<name>"

ctlmgr_ctl w wlan settings/ssid "<name>"
ctlmgr_ctl w wlan settings/ssid_scnd "<name>"
ctlmgr_ctl w wlan settings/ssid_thrd "<name>"
ctlmgr_ctl w wlan settings/guest_ssid "<name> Guest"

ctlmgr_ctl w ctlusb settings/fritznas_share "<name>"
ctlmgr_ctl w ctlusb settings/samba-server-string "<name>"
ctlmgr_ctl w mediasrv settings/name "<name> Mediaserver"

ctlmgr_ctl w plc settings/device[<uid>]/usr "<name>"

ctlmgr_ctl w emailnotify settings/From "<name> <addr>"

aha.SetName(1000, "<name>") # libaha.so for 546e

Functions

The function names of scripts often help to understand function blocks (and show gaps in the docs). fw 7530-7.39-96136 functions:

$ grep -e '^function' -e '^local function' /usr/rest_api/obl_fboxname.lua

# Get obl_fboxname ressources.
function obl_fboxname.getRestRessources(rootPath)

# Sends hello="world" to the client
# GET /api/v0/obl_fboxname
function obl_fboxname.helloWorld()

# Sends a test Error test to the client
# GET /api/v0/obl_fboxname/error
function obl_fboxname.getError()

# Get the Fritzbox hostname 
# GET /api/v0/obl_fboxname/fboxname
function obl_fboxname.getFboxName()

# Helper for setFboxName
local function saveFboxName(newName)

# Set all Fritzbox names
# PUT /api/v0/obl_fboxname/fboxname
function obl_fboxname.setFboxName() 

Dependencies

Daily updated index of all dependencies of this script. Last update: 2024-04-26 08:50 GMT.
A * in the Mod column marks info from Supportdata-Probes, which will always stay incomplete.
If an Object includes itself then this is a file with the same name but another Path and the dependencies are merged.

Relation	Typ	Object	Mod	Firmware	Info	Origin
Accesses	uimod	box	13	7.39	Global box settings	AVM
Accesses	uimod	ctlusb	13	7.39	USB-Host related config	AVM
Accesses	uimod	emailnotify	13	7.39	Push-Mail settings	AVM
Accesses	uimod	mediasrv (uimod)	13	7.39	UPnP-AV mediaserver	AVM
Accesses	uimod	plc (uimod)	13	7.39	Powerline devices	AVM
Accesses	uimod	rext	13	7.39	Range extender (Repeater)	AVM
Accesses	uimod	wlan (uimod)	13	7.39	WLAN configuration	AVM
Requires	lib	libaha.so	13	7.39	Lua-Library for AVM home automation	AVM
Requires	lua	fake_modules.lua	13	7.39	REST-API helper for obl_fboxname.lua	AVM
Requires	lua	response.lua	13	7.39	REST-API Response API	AVM
Requires	lua	rest_api_const.lua	13	7.39	REST-API Const Tables	AVM
Includes	js	box.js	13	7.39	TODO	AVM
12 dependencies for this script

Model-Matrix

Daily updated index of the presence, path and size of this script for each model. Last update: 2024-04-26 06:23 GMT.
Showing all models using this script. Click any column header (click-wait-click) to sort the list by the respective data.
The (main/scrpn/boot/arm/prx/atom) label in the Model column shows which CPU is meant for models with multiple Linux instances.
Note that this list is merged from Firmware-Probes of all known AVM firmware for a model, including Recovery.exe and Labor-Files.

Model	Firmware	Path	Size/Bytes
FRITZ!Box 6591 Cable (arm)	7.39	/usr/rest_api	8.0k
FRITZ!Box 6591 Cable (atom)	7.39	/usr/rest_api	8.0k
FRITZ!Box 6660 Cable (arm)	7.39	/usr/rest_api	8.0k
FRITZ!Box 6660 Cable (atom)	7.39	/usr/rest_api	8.0k
FRITZ!Box 6690 Cable (arm)	7.39	/usr/rest_api	8.0k
FRITZ!Box 6690 Cable (atom)	7.39	/usr/rest_api	8.0k
FRITZ!Box 6890 LTE	7.39	/usr/rest_api	8.0k
FRITZ!Box 6890 LTE v1	7.39	/usr/rest_api	8.0k
FRITZ!Box 6890 LTE v2	7.39	/usr/rest_api	8.0k
FRITZ!Box 7530	7.39	/usr/rest_api	8.0k
FRITZ!Box 7590	7.39	/usr/rest_api	8.0k
FRITZ!Box 7590 AX	7.39	/usr/rest_api	8.0k
FRITZ!Repeater 2400	7.39	/usr/rest_api	8.0k
13 models use this script

SMW-Browser

Property:obl fboxname.lua

Information is currently being retrieved from the backend.