Documentation
JavaScript

Javascript and REST API

The default homepage uses mainly the REST API. In order to simplify the processing of the JSON data and to unify the dynamic generation of the homepage, multiple Javascript classes are used.

Each JSON object in the JSON structures has a type "JSON+typeName" and the corresponding revision of this type "JSON+typeRevision". For every of these objects, there is a Javascript class with the same name as the object's type name.

class description
jObject The abstract class for all the following classes.
jApiKey a pair of access keys for the REST API (see Accessing Data)
jApiKeys the complete apikeys object
jBoard the complete assembleBoard object
jData the complete data object
jData(Ai,Ao,Di,Do) values of individual IOs
jProperties the complete properties object
jHostEntry a configuration of a network interface
jNetworkInterface the settings and all configurations of a network interface
jPcb information about the PCB
jProcess the complete process object
jProcess(Ai,Ao,Di,Do) configuration of individual IOs
jSntpEntry SNTP Client configuration
jMqttEntry MQTT Client configuration
jUser the complete httpXX object of one user

For more information about our REST API click here: REST API

basic.js

The basic.js Javascript file implements various functions, which help to dynamically generate the homepage. These dynamically generated contents include the navigation, the breadcrumb, the informational text regarding the access rights of the currently loaded page and much more. For a detailed description see the file basic.js.