8.5.31 DeviceFrameDefinition

A DeviceFrameDefinition document defines tabs to be shown in a sat-nms device screen. It resembles the content of a file in the dframes directory of the sat-nms M&C software.

DeviceFrameDefinition documents are returned by a GET /api/v1/dframes/{name} call.

Data Model

Key Type Value
name String The file name of the dframe definition
allowPresets Boolean true = the UI shall show the load/save preset buttons for this dframe
presetPrivilege Number the privilege level required to launch the preset load/save dialogs. This only is meaningful with allowPresets=true
tabs Array Contains a list of DeviceFrameTab objects, each describing one tab of the device frame