===================
IO-Profiles example
===================

Below is a small snippet of IO-profile.

.. code-block:: xml

    <ioprofile>
            <name>ECBlue</name>
            <description>IO Profile for ECBlue modbusRTU</description>
            <protocol>modbusrtu</protocol>
            <iodata>
                <r3 dir="both" autocreate="true">
                    <initdata>
                        <description>Modbus nopeusohje</description>
                        <dispUnit>%</dispUnit>
                    </initdata>
                    <pointschema>AV</pointschema>
                    <alias>MB1ADDR247ECBlueRTUSpeedControlOut</alias>
                    <url>holding/2</url>
                    <ioparams>
                        <scale>1.0</scale>
                        <datatype>uint16</datatype>
                        <hilimit>100</hilimit>
                        <lowlimit>0</lowlimit>
                    </ioparams>
                </r3>
                <r34 dir="in" autocreate="true">
                    <initdata>
                        <description>Puhaltimen ottoteho</description>
                        <dispUnit>W</dispUnit>
                    </initdata>
                    <pointschema>AV</pointschema>
                    <alias>MB1ADDR247ECBlueRTUFanInputPower</alias>
                    <url>input/33</url>
                    <ioparams>
                        <scale>1.0</scale>
                        <datatype>uint16</datatype>
                    </ioparams>
                </r34>
            </iodata>
    </ioprofile>             
    


.. note:: Here custom element names start with "r" and is followed by the register number: ``r34`` for register numbered 34. However element name can be anything as long as it follows XML syntax.

.. important:: Element's name will be used as the point's name by default when using automatic point creation. If you want to use different default point name, add <alias> element to determine custom name. 

Each register's information is stored in custom elements.

``initdata``-element contains information that goes into the fields of the point, e.g. ``description``, ``dispUnit`` or ``activeText``

``ioparams``-element has all the relevant information to manipulate the raw value of the register to make it usable in database, e.g. ``scale``, ``offset``, ``hilimit``, ``bitmask``

Other relevant information is stored as tags or attributes too:

    dir:
       Tells if point will use just dataSource and/or dataTarget. ``both`` or  ``in``
    autocreate:
       Tell Actiweb9 to autocreate this point from IO-Profile if using AutoCreateList. ``true`` or ``false``
    pointschema:
       Schema that will be used to create the point
    url:
       register type and number separated by ``/``
    alias:
        Custom name to be used instead of elements tag name when using AutoCreateList.

.. note:: Order of the elements does not matter when Actiweb9 parses the XMl tree.