--------------------------------------------------------------------------------
                 CyBroMiniScada (c) 2011-2019 Cybrotech Ltd.
--------------------------------------------------------------------------------

CyBroMiniScada is visualization system for Cybro controllers. It can be used
for industry, solar plants, building management, home automation, or any other
application where Cybro controllers are used. Both Cybro-2 and Cybro-3 are
supported.

Function and appearance are defined by xml configuration file, and external
images. Configuration (config.xml) is a standard text file in xml format.
Images are standard graphic files in png or jpg format. Png transparency is
fully suported.

Both local (phone---cybro) and internet (phone---server---cybro) connection
is supported. Local connection is always available. Internet connection is
based on a secure server which is not available for public access. To check
the commercial options, please contact your sales agent.

When app is installed, default configuration is automatically activated. To
check other examples, follow instructions on Play store. Each configuration
can also be downloaded to PC, to learn how the given function is realized.

To control your local Cybro controller, simple demo application is available.
To start demo, follow the instructions:

CyPro

- set alias address to 1000
- send empty program

Mini Scada for Android

- read from "www.cybrotech.com" configuration "landemo"
- set Home Network to "Any SSID"

To edit configuration file with your phone, install some text editor and open:

/Android/data/com.cybrotech.miniscada/landemo/config.xml

For a more advanced development, the recommended toolchain is:

- use PC to create xml and graphic files
- use Mini Scada for Windows to position objects
- rename CyBroMiniScada.xml to config.xml, modify for Android
- copy configuration to your phone

To distribute your configuration, zip all files (without directory), and upload
to your server download directory. Here is an example:

- configuration: solar.zip
- server address: www.solar-cybro.com
- file location on server: /home/users/cybrotech/data/solar.zip
- download URL for browser: http://www.solar-cybro.com/data/solar.zip
- download with mini scada: www.solar-cybro.com, solar

Note that configuration name is entered without ".zip" extension.


Pages
--------------------------------------------------------------------------------

Page is a basic unit of organization. It can be rendered in canvas or list mode.

Canvas mode: graphical screen, position of each object is specified by x and y
coordinates. Canvas is always displayed full screen. It may keep aspect ratio
(keep), or stretch in both directions (fill). Icon and description tags are not
displayed.

List mode: scrollable list of objects. Icon is displayed to the left, then name
and description, and value to the right. If description tag is not specified,
variable description from plc program is used.


<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<scada>

<!-- general -->

<httpserver>www.solar.com</httpserver>  <!-- server for internet connection -->
<httpuser>guest</httpuser>              <!-- username given by administrator -->
<httppass>guest</httppass>              <!-- password given by administrator -->
<password></password>                   <!-- optional A-bus password -->

<rendering>canvas</rendering>           <!-- rendering mode: canvas | list -->
<width>1280</width>                     <!-- canvas width in pixels -->
<height>720</height>                    <!-- canvas height in pixels -->
<aspect>keep</aspect>                   <!-- aspect ratio: keep | fill -->
<background>#000000</background>        <!-- background color #RRGGBB, 00..FF -->

<helpfile>help.txt</helpfile>           <!-- custom help file -->

<!-- pages -->

<page>
  <name>Page</name>                     <!-- first page -->
  <object>...</object>
  <object>...</object>
  ...
</page>

<page>
  <name>Page</name>                     <!-- second page -->
  <object>...</object>
  <object>...</object>
  ...
</page>

</scada>                                <!-- end of file -->


Page rendering, size and background can be defined on root level or page level.
Page level has precedence.

Page to page transition is performed by sliding left-right, or using menu system
based on "page" action. Both methods are available in list and canvas mode.


Objects
--------------------------------------------------------------------------------

Each object may have a name and description.

    <name>Total power</name>            <!-- object name -->
    <description>reactive</description> <!-- object description (list mode only) -->
    <font>Roboto</font>                 <!-- font family -->
    <size>42</size>                     <!-- font size -->
    <bold>0</bold>                      <!-- text property -->
    <italic>0</italic>                  <!-- text property -->
    <h-align>center</h-align>           <!-- left | inner-l | center | inner-r | right -->
    <v-align>middle</v-align>           <!-- over | top | middle | bottom | below -->
    <color>#7F7F7F</color>              <!-- font color, #RRGGBB, 00..FF -->
    <background>#000000</background>    <!-- background color, #RRGGBB, 00..FF -->

In canvas mode, name is aligned to the body:

                   over
    o----------------------------------
    |              top                |
    |                                 |
left|inner-l   center/middle   inner-r|right
    |                                 |
    |             bottom              |
    -----------------------------------
                  below

In list mode, each object may also have an icon, aligned to the left:

    <icon>power.png</icon>              <!-- object icon -->
    <iconsize>100</iconsize>            <!-- icon size in percents, relative to system default -->


List of available objects
--------------------------------------------------------------------------------

Bitmap - display a static bitmap (canvas mode only).

  <object>
    <type>bitmap</type>                 <!-- static bitmap -->
    <file>background.png</file>         <!-- png or jpg image -->
    <x></x>
    <y></y>
  </object>

Coordinates are defined in canvas pixels, relative to top left.

Bitlist - display one of specified bitmaps, depending on variable value.

  <object>
    <type>bitlist</type>                <!-- bitmap list -->
    <name>kitchen</name>                <!-- object name -->
    <var>c1000.output</var>             <!-- cybro variable -->
    <file>lightbulb off.png</file>      <!-- image for 0 -->
    <file>lightbulb on.png</file>       <!-- image for 1 -->
    <x></x>
    <y></y>
  </object>

  <object>
    <type>bitlist</type>                <!-- bitmap list -->
    <name>HVAC mode</name>              <!-- object name -->
    <var>c1000.hvac_mode</var>          <!-- cybro variable -->
    <value>0</value>                    <!-- list of values -->
    <value>1</value>
    <value>2</value>
    <file>hvac_off.png</file>           <!-- image for 1st value -->
    <file>hvac_heating.png</file>       <!-- image for 2nd value -->
    <file>hvac_cooling.png</file>       <!-- image for 3rd value -->
    <x></x>
    <y></y>
  </object>

Button - display button used to trigger an action.

  <object>
    <type>button</type>                 <!-- button -->
    <name>Reset all</name>              <!-- object name -->
    <file>button red 32x96.png</file>   <!-- png or jpg image -->
    <x></x>
    <y></y>
  </object>

Text - display static text, dynamic text and decimal numbers.

  <object>
    <type>text</type>                   <!-- text object -->
    <text>Temp: </text>                 <!-- static text -->
    <decimal>                           <!-- decimal number -->
      <var>c1000.temperature</var>      <!-- cybro variable -->
      <digits>4</digits>                <!-- total number of digits including decimal point and decimals -->
      <decimals>1</decimals>            <!-- number of digits after decimal point -->
      <zeroblanking>1</zeroblanking>    <!-- suppress leading zeros -->
    </decimal>
    <text>\n</text>                     <!-- new line -->
    <text>Hvac: </text>                 <!-- static text -->
    <textlist>                          <!-- dynamic text -->
      <var>c1000.hvac_mode</var>        <!-- cybro variable -->
      <value>0</value>                  <!-- list of values -->
      <value>1</value>
      <value>2</value>
      <text>Off</text>                  <!-- text for 1st value -->
      <text>Heating</text>              <!-- text for 2nd value -->
      <text>Cooling</text>              <!-- text for 3rd value -->
    </textlist>
    <x></x>
    <y></y>
  </object>

Bargraph - display bargraph and value. Minimum and maximum are related to
actual variable content, not displayed value.

  <object>
    <type>bargraph</type>               <!-- bar of variable size -->
    <name>Power usage</name>            <!-- object name -->
    <direction>vertical</direction>     <!-- horizontal | vertical -->
    <reverse>0</reverse>                <!-- 0-left to right, 1-right to left -->
    <var>c1000.output_power</var>
    <min>0</min>                        <!-- value for zero size -->
    <max>2500</max>                     <!-- value for full size -->
    <barcolor>#00FF00</barcolor>        <!-- line color, empty for transparent -->
    <background>#1F1F1F</background>    <!-- background color, leave empty for transparent -->
    <width>50</width>                   <!-- bargraph width in pixels -->
    <height>400</height>                <!-- bargraph height in pixels -->
    <x></x>
    <y></y>
  </object>

Spacer - static spacer between groups (list mode only).

  <object>
    <type>spacer</type>                 <!-- spacer -->
    <name>Heating & cooling</name>      <!-- object name -->
  </object>


Events and actions
--------------------------------------------------------------------------------

Default function of an object is to display a value. With events and actions,
object can also change variables, or execute an additional task. Each object
may contain multiple events, each event may contain multiple actions.

Available events:

    <shortpress>
    </shortpress>

    <shortrelease>
    </shortrelease>

    <longpress>
      <delay>25</delay> <!-- in 100ms units -->
    </longpress>

    <longrelease>
      <delay>25</delay> <!-- in 100ms units -->
    </longrelease>

Available actions:

Write - write a single value

      <action>
        <type>write</type>
        <var>c1000.write_req</var>
        <value>1</value>
      </action>

Toggle - toggle between specified values

      <action>
        <type>toggle</type>
        <var>c1000.mode</var> <!-- default values are 0/1 -->
      </action>

      <action>
        <type>toggle</type>
        <var>c1000.mode</var>
        <value>0</value>
        <value>1</value>
        <value>2</value>
      </action>

Increment - increment/decrement by a specified value

      <action>
        <type>increment</type>
        <var>c1000.setpoint</var>
        <min>100</min>
        <max>300</max>
        <step>5</step> <!-- negative for decrement -->
      </action>

Combo - popup dialog, list of specified options

      <action>
        <type>combo</type>
        <var>c1000.mode</var>
        <value>0</value>
        <value>1</value>
        <value>2</value>
        <text>off</text>
        <text>heating</text>
        <text>cooling</text>
      </action>

Incdec - popup dialog, +/- buttons to change value

      <action>
        <type>incdec</type>
        <var>c1000.setpoint</var>
        <min>100</min>
        <max>300</max>
        <step>5</step>
        <decimals>1</decimals>
        <direct>0</direct>
      </action>

Slider - popup dialog, linear slider to change value

      <action>
        <type>slider</type>
        <var>c1000.setpoint</var>
        <min>100</min>
        <max>300</max>
        <step>5</step>
        <decimals>1</decimals>
        <direct>0</direct>
      </action>

Knob - popup dialog, rotational slider to change value

      <action>
        <type>knob</type>
        <var>c1000.setpoint</var>
        <min>100</min>
        <max>300</max>
        <step>5</step>
        <decimals>1</decimals>
        <direct>0</direct>
      </action>

Decimal - popup dialog, numeric keypad to enter value

      <action>
        <type>decimal</type>
        <var>c1000.setpoint</var>
        <min>100</min>
        <max>300</max>
        <decimals>1</decimals>
      </action>

Tag <direct> has fthe following function:

  0: dialog has "Ok"/"Cancel" buttons, value is written when Ok is pressed
  1: dialog has "Close" button, value is written immediately with each change

Page - jump to a page referenced by page name

      <action>
        <type>page</type>
        <page>heating</page>
      </action>

Link - open a specified URL

      <action>
        <type>link</type>
        <url>http://192.168.1.117/camera_stream.mp4</url>
      </action>

Link can specify an IP camera stream, or an web application of choice. It can
also be used to directly trigger an action within a web application.

Command - start a specified app

      <action>
        <type>command</type>
        <command>com.android.calculator2</command>
        <activity></activity>
      </action>

App is specified by package name and optional activity name. To get the name,
open Android settings, apps, running, and check for process name. Another method
is to open Play store, navigate to application, then check id within URL. When
activity is empty, default is executed. List of available activities can be
obtained from internet activity dbase, by a specialized application, or directly
from the develper.


Windows/Android differences
--------------------------------------------------------------------------------

Android version supports, Windows not

- connection over internet
- automatic switching LAN/WAN
- list rendering mode
- spacer object
- support for jpg images
- page background color
- link action
- custom help file

Windows version supports, Android not

- fullscreen, setresolution, closetotray, showhints
- imagedir (separate directory for image files)
- direct (ethernet connection using limited broadcast)
- timeout, retrycount (communication parameters)
- verbose (error log file)
- bitevent (event executed when variable is changed)
- pageindex (current page indicator)

- editenable, gridsize (page editor, ctrl E)

- style definitions
- template definitions
- password-protected page

- led object
- slider object
- gauge object
- bittable object
- timeplot object
- alarmtable object

- thermostat object
- fan-coil object
- weather object
- webbox object
- statustale object
- template object

- text object <width> tag

- keypad action
- blankscreen action
- editmode action
- exit action