Developer documentation

Overview

Manager is implemented as server application with web-based front-end GUI. Back-end implements most of communication functionalities while front-end provides thin layer responsible only for data visualization and user interaction. All front-ends share and operate on single back-end state.

Communication between back-end and front-end is based on juggler with addition of RPC messages. Front-end can request execution of RPC actions while back-end continuously updates and shares it’s state as juggler’s state data.

Back-end’s configuration parameters can be modified during Manager execution and persisted as configuration file.

Devices

Manager devices provide modular encapsulation of functionality associated with specific communication protocols.

Each manager device implementation includes:

• configuration

  Device specific configuration parameters which enable reconstruction of device state between manager executions.

• state data

  Dynamically changed JSON serializable data representing device state which should be visible on front-end GUI.

• actions

  RPC actions available for front-end mapping of user interactions to back-end functionality execution.

Manager device implementation is responsible for providing custom communication logic (in accordance to targeted communication protocol) and appropriate front-end visualization and user interaction.

During manager execution, device can be in following states:

• STOPPED

  Manager device is not connected to remote device/component. Changes to device configuration parameters are possible.

• STARTING

  Connection to remote device is trying to be established. In case of server/slave devices, listening endpoint is being created.

• STARTED

  Connection to remote device is established. In case of server/slave devices, remote devices can establish connection to server/slave.

• STOPPING

  Connection to remote device is being closed.

Starting/stopping of devices is done based on user’s requests. In case of enabled auto start parameter, connection to remote device is repeatedly automatically started each time connection is lost.

Supported device implementations:

• Orchestrator device
• Monitor server device
• Event server device
• Modbus master device
• Modbus slave device
• IEC 60870-5-104 master device
• IEC 60870-5-104 slave device

Back-end/front-end communication

Back-end state definition:

type: object
required:
    - log
    - devices
    - settings
properties:
    log:
        type: array
        descriptions: |
            list of log entries shown on GUI
        items:
            type: object
            required:
                - timestamp
                - message
            properties:
                timestamp:
                    type: number
                message:
                    type: string
    devices:
        type: object
        description: |
            dictionary of device states where key is device identifier
            and value is device state with structure dependant on device
            type
        patternProperties:
            ".+":
                type: object
                required:
                    - type
                    - name
                    - autostart
                    - status
                    - data
                properties:
                    type:
                        type: string
                    name:
                        type: string
                    autostart:
                        type: boolean
                    status:
                        enum:
                            - stopped
                            - starting
                            - started
                            - stopping
                    data: {}
    settings:
        type: object
        required:
            - ui
            - log
        properties:
            ui:
                type: object
                required:
                    - address
                properties:
                    address:
                        type: string
                        default: 'http://127.0.0.1:23024'
            log:
                type: object
                required:
                    - level
                    - syslog
                    - console
                properties:
                    level:
                        type: string
                        default: INFO
                    syslog:
                        type: object
                        required:
                            - enabled
                            - host
                            - port
                        properties:
                            enabled:
                                type: boolean
                                default: false
                            host:
                                type: string
                                default: '127.0.0.1'
                            port:
                                type: integer
                                default: 6514
                    console:
                        type: object
                        required:
                            - enabled
                        properties:
                            enabled:
                                type: boolean
                                default: false

Available RPC actions:

• set_settings(path: json.Path, value: json.Data) -> None

  change settings parameter

• save() -> None

  save current configuration to disk

• add(device_type: str) -> str

  add new device and return newly created device’s identifier

• remove(device_id: str) -> None

  remove device

• start(device_id: str) -> None

  start device

• stop(device_id: str) -> None

  stop device

• set_name(device_id: str, name: str) -> None

  change device name

• set_autostart(device_id: str, autostart: bool) -> None

  change device auto start property

• execute(device_id: str, action: str, *args: json.Data) -> json.Data

  execute device action and return it’s result (supported actions are dependant on device type)