Property:datatype.lua

---

BoxMatrix >> Webinterface >> datatype.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

REST-API

Lua-Scripts

Javascript

Browser

SSI-Files

SSI-Directives

HTML-Text

Event-Text

Help-Pages

CSS-Files

Graphics

Research

---

RESTAPI-Script

RESTAPI-Script:	datatype.lua   -   type Script	Wiki	Freetz	IPPF	whmf	AVM	Web
Location:	Webinterface >> RESTAPI-Scripts   -   Origin: AVM
Path:	Release: /usr/rest_api Lab+Rel: /usr/rest_api
Properties:	Size: 5.8k   -   Firmware: 7.90 - 8.00
Function:	REST-API Datatype Conversion

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

Details

datatype.lua provides REST-API Datatype Conversion functions. It is included by plugin_common.lua.
These functions convert values between internal (backend) and external (api) datatypes.

Local conversion functions are organized in a conversion matrix table.
Excerpt from the fw 8.00 conversion table comments:

A table that defines conversion functions between internal and external types.
As currently only strings are valid backend values, this only deals with
conversions from or to strings. If additional data sources/sinks are added to the plugin
framework, this can be changed, but it is unclear whether a complete NxN conversion matrix
would be useful (do conversions between integer and boolean make sense? boolean->string 
outside of ctlmgr?)

REST-API:

• Lexicon: REST, API, SCGI
• 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, rest_api_const.lua, response.lua, error.lua
• Includes: avmluamessages.lua, uimod.lua, api_generic_filter.lua, resource.lua, datatype.lua, plugin_common.lua
• Modules: storagenasrights_rest.lua, webusb_rest.lua
• Modules: calllog_rest.lua, faxjournal_rest.lua, phonebook_rest.lua, smarthome_rest.lua, boxnotify_rest.lua
• Develop: obl_fboxname.lua, dev_debug.lua, landevice.lua, query_tree.lua, fake_modules.lua, obl.lua
• Common: array.lua, common.lua, func.lua, math.lua, string.lua, table.lua, typecheck.lua, validcheck.lua
• Plugins: configflags.lua, eventlog.lua, info.lua, monitor.lua, phonebook.lua, smarthome.lua, timermix.lua
• Misc-Plugins: misc.lua, boxname.lua, configuration.lua, handsets.lua, update_status.lua, wan_status.lua
• Setup-Plugins: setup.lua

Functions

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

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

# local functions
local function validate_type(ty)
local function parse_intern_boolean(str)
local function parse_intern_integer(str)
local function validate_number_format(num, format_extern, field)

# Converts a backend value to the appropriate external value
# and adds API errors if conversion is not possible
function datatype.convert_to_extern(resource, value)

# Converts a external value to the appropriate backend value
# and adds API errors if conversion is not possible
function datatype.convert_to_intern(resource, value, field) 

Dependencies

Daily updated index of all dependencies of this script. Last update: 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
Requires	rest	func.lua	25	7.90 - 8.00	REST-API common collection of higher order functions	AVM
Requires	rest	math.lua	25	7.90 - 8.00	REST-API common extension of the Lua math module	AVM
Requires	rest	response.lua	25	7.90 - 8.00	REST-API Response API	AVM
Requires	rest	rest_api_const.lua	25	7.90 - 8.00	REST-API Const Tables	AVM
Required by	rest	plugin_common.lua	25	7.90 - 8.00	REST-API Plugin helper functions	AVM
5 dependencies for this script

Model-Matrix

Daily updated index of the presence, path and size of this script for each model. Last update: 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/rtl) label in the Model column shows which CPU is meant for Multi-Linux models.
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 4040	7.90 - 8.00	/usr/rest_api	5.8k
FRITZ!Box 4050	7.90	/usr/rest_api	5.8k
FRITZ!Box 4060	7.90	/usr/rest_api	5.8k
FRITZ!Box 5530 Fiber (main)	8.00	/usr/rest_api	5.8k
FRITZ!Box 5590 Fiber (main)	7.90 - 8.00	/usr/rest_api	5.8k
FRITZ!Box 5590 Fiber (prx)	7.90 - 8.00	/usr/rest_api	5.8k
FRITZ!Box 6591 Cable (arm)	8.00	/usr/rest_api	5.8k
FRITZ!Box 6591 Cable (atom)	7.90	/usr/rest_api	5.8k
FRITZ!Box 6660 Cable (arm)	7.90 - 8.00	/usr/rest_api	5.8k
FRITZ!Box 6660 Cable (atom)	7.90	/usr/rest_api	5.8k
FRITZ!Box 6670 Cable (arm)	7.90	/usr/rest_api	5.8k
FRITZ!Box 6670 Cable (atom)	7.90	/usr/rest_api	5.8k
FRITZ!Box 6690 Cable (arm)	7.90	/usr/rest_api	5.8k
FRITZ!Box 6690 Cable (atom)	7.90	/usr/rest_api	5.8k
FRITZ!Box 6850 5G	7.90	/usr/rest_api	5.8k
FRITZ!Box 6850 LTE	7.90	/usr/rest_api	5.8k
FRITZ!Box 7510	7.90 - 8.00	/usr/rest_api	5.8k
FRITZ!Box 7520	8.00	/usr/rest_api	5.8k
FRITZ!Box 7520 v2 (main)	7.90 - 8.00	/usr/rest_api	5.8k
FRITZ!Box 7530	7.90 - 8.00	/usr/rest_api	5.8k
FRITZ!Box 7530 AX	8.00	/usr/rest_api	5.8k
FRITZ!Box 7583 VDSL (main)	8.00	/usr/rest_api	5.8k
FRITZ!Box 7590 (main)	7.90 - 8.00	/usr/rest_api	5.8k
FRITZ!Box 7590 AX (main)	8.00	/usr/rest_api	5.8k
FRITZ!Box 7690	7.90	/usr/rest_api	5.8k
25 models use this script

SMW-Browser

Property:datatype.lua

Information is currently being retrieved from the backend.