Widget Player

Widget Player is a utility that you can use to run a widget as a standalone application.

Widget Player is useful for:

  • Launching a widget inside a touch panel connected to an industrial or home automation controller.
  • Starting some important monitoring widget without running Iotellect Client itself.

Connection Parameters Dialog

If widget player is started without command line parameters, it shows the Server Connection Parameters dialog.

In this dialog, you can specify the parameters that will be used by Widget Player to connect to Iotellect Server, authorize, and display a widget:

Parameter

Name

Type

Description

IP Address or Host Name

address

String

IP address or host name of the Iotellect Server. For example, localhost.

Port Number

port

Integer

Iotellect Server port for client connections. Default port for client connections is 6460.

Username

username

String

Name of a user account to use for logging in to the server.

Password

password

String

User account password.

Widget Path

widgetPath

String

Full path to a widget context. For example, users.admin.widgets.myCustomWidget.

Default Context Path

defaultContextPath

String

Path to a default context for a widget. This parameter is relevant only for relative widgets.

Full Screen

fullScreen

Boolean

Full-screen mode flag. If true, Widget Player starts in the full-screen mode.

Command-Line Options

Widget Player is launched by running widget_player executable file (its extension is OS-dependent).

You can specify Widget Player connection parameters with command-line arguments. If Widget Player cannot connect to the Iotellect Server with the specified command line parameters, it displays the Connection Parameters dialog.

To run Widget Player, use the following format:

widget_player [server_address server_port username password] widget_context_path [other_options]

  • server_address is the IP address or host name of the Iotellect Server
  • server_port is the Iotellect Server port for client connections (6460 by default)
  • username is the name of a user account to use for logging in to the server
  • password is the user account password
  • widget_context_path is a full path to the context of a widget to be launched, e.g. users.admin.widgets.myCustomWidget

Other Options

-c default_context_path

Specifies a full path of the default context that will be used during widget operation, e.g. users.admin.devices.myDevice. This parameter is relevant only for relative widgets.

-f

Enables full-screen mode.

-h

Displays command-line parameters help.

Configuration File

Widget Player creates a configuration file widget-player.properties on the first launch.

This file is used for hidden mode of the Widget Player. In this mode, Widget Player reads all connection settings from the configuration file and asks only for user credentials:

To enable hidden mode, set the hiddenMode parameter to true in the configuration file.

Widget Player configuration file has the following options:

Name

Description

serverAddress

IP address or host name of the Iotellect Server.

serverPort

Iotellect Server port for client connections.

widgetPath

Full path to a widget context.

defaultContextPath

Path to a default context for a widget. This parameter is relevant only for relative widgets.

fullScreen

Full-screen mode flag. If true, Widget Player starts in the full-screen mode.

hiddenMode

Hidden mode flag. If true, Widget Player reads all connection settings from the configuration file.

Full-Screen Mode

Any widget can be expanded to full screen by pressing F11 key.

Full screen mode is disabled by pressing ESC or F11.

Was this page helpful?