Template:Networking rutos manual data to server: Difference between revisions

{{#switch: {{{series}}} | RUTX | RUTM | RUTC | TCR1 | TRB1 | TRB2 | TRB2M | TRB5 | RUT2M | RUT2 | RUT30X | RUT36X | RUT9 | RUT9M | RUT14X | TAP100 | TAP200 = | #default =  

<u><b>Note:</b> On {{{name}}}, Data to Server is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>}}

A <b>Data Sender</b> is an instance that gathers and periodically sends collected data to a specified server. The Data Senders list is empty by default so, in order to begin configuration you must add a new collection first. To add a new collection, click the 'Add' button.

[[File:Networking_rutos_manual_data_to_server_data_senders_add_button_v4.png|border|class=tlt-border]]

After this you should be redirected to the newly added data configuration page.

===Data configuration===

Refer to the table below for descriptions on data configuration fields.

[[File:Networking rutos manual data to server data configuration_v1.png|border|class=tlt-border]]

       <td>string; default: <b>input1</b></td>

       <td>Name of data input.</td>

       <td><span>Base {{!}} {{#ifeq:{{{bluetooth}}}|1|<span style="color:green">Bluetooth</span> {{!}}|}} {{#ifeq:{{{mobile}}}|1| GSM {{!}}|}} {{#ifeq:{{{impulse_counter}}}|1|<span style="color:coral">Impulse counter</span> {{!}}|}} <span style="color:olive">Lua script</span> {{!}} {{#ifeq:{{{m-bus}}}|1|<span style="color:midnightblue ">M-Bus</span>{{!}}|}} {{#ifeq:{{{mobile_usage}}}|1|<span style="color:blue">Mobile usage</span>{{!}}|}} {{#ifeq:{{{MNF}}}|1| MNF info {{!}}|}} {{#ifeq:{{{Modbus}}}|1|<span style="color:red">Modbus</span><span class="asterisk">*</span> {{!}} <span style="color:grey">Modbus Alarms</span> {{!}}|}} {{#ifeq:{{{wifi}}}|1|<span style="color:purple">Wifi scanner</span><span class="asterisk">*</span> {{!}}|}} {{#ifeq:{{{DNP3}}}|1|<span style="color:brown">DNP3</span><span class="asterisk">*</span> {{!}}|}} {{#ifeq:{{{MQTT}}}|1|<span style="color:orange">MQTT</span> {{!}}|}} {{#ifeq:{{{OPC}}}|1|<span style="color:lightblue">OPC UA</span><span class="asterisk">*</span> {{!}}|}} {{#ifeq:{{{gps}}}|1|<span style="color:Black">GPS</span> {{!}}|}} {{#ifeq:{{{DLMS}}}|1|<span style="color:hotpink">DLMS</span><span class="asterisk">*</span>|}} {{#ifeq:{{{io}}}|1|{{!}} <span style="color:slateblue">Input/Output</span>|}}; default: <b>Base</b></span></td>

       <td>Data input type.</td>

       <td>Json {{!}} <span style="color:limegreen">Custom</span> {{!}} <span style="color:cadetblue">Lua script</span> (Some data input types may not work correctly with the provided Lua format example script. Review and adapt the script as needed to ensure compatibility.); default: <b>Json</b></td>

       <td>When turned on, sends JSON segment as object and not as an array element.

        </td>

       <td>All {{!}} <span style="color:grey">Server ID</span> {{!}} <span style="color:grey">Alarm ID</span> {{!}} <span style="color:grey">Register number</span>; default: <b>All</b></td>

       <td><span style="color:red">Data filtering </span></td>

       <td>If Data type: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server. <b>Note:</b> 20 filtering entries with Modbus data are allowed.</td>

      <td>Filter data by defined impulse counter pin.</td>

     </tr>|}}  

       <td>Day {{!}} Week {{!}} Month; default: <b>Day</b></td>

       <td>Choose for which time period to send info from.</td>

       <td>off {{!}} on; default: <b>off</b></td>

       <td>Current data.</td>

      <td><span style="color:blue">SIM card</span></td>

      <td></td>

       <td><span style="color:hotpink">Invert filter</span></td>

     </tr>|}}

     </tr>|}}

     </tr>|}}

     {{#ifeq:{{{MQTT}}}|1|<tr>

       <td><span style="color:orange">Certificate based: Certificate authority file</span></td>

     <td><span style="color:orange">Certificate based: Client private keyfile</span></td>

       <td>on {{!}} off; default: <b>off</b></td>

     </tr>}}

===Collection configuration===

[[File:Networking rutos manual data to server collection configuration_v2.png|border|class=tlt-border]]

       <td>JSON {{!}} <span style="color:red">custom</span> {{!}} <span style="color:lightgreen">Lua script</span>; default: <b>JSON</b></td>

    <tr>

       <td><span style="color:lightgreen">Lua format example script</span></td>

       <td>-(interactive button)</td>

      <td><span style="color:lightgreen">Lua format script</span></td>

      <td>-(interactive button)</td>

        <td>Upload the Lua script.</td>  

       <td>Encoder</td>

       <td>None {{!}} Base64; default: <b>None</b></td>

        <td>Encoder used for all sent data.</td>  

===Server configuration===

       <td>HTTP {{#ifeq:{{{MQTT}}}|1|{{!}} <span style="color:red">MQTT</span>|}} {{!}} <span style="color:olive">Azure IoT Hub</span> (requires to install package from [[{{{name}}} Package Manager|Package Manager]]) {{!}} <span style="color:brown">Lua</span> {{!}} <span style="color:coral">SMTP</span> {{!}} <span style="color:DarkMagenta">Socket</span> {{!}} <span style="color:DarkSeaGreen">FTP</span> {{#ifeq:{{{mobile}}}|1|{{!}} <span style="color:GoldenRod">SMS</span>|}}; default: <b>HTTP</b></td>

       <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>

     {{#ifeq:{{{MQTT}}}|1|

       <td><span style="color:teal">Pre-Shared-Key</span></td>

      <td>hexadecimal string; default: '''none'''</td>

       <td>The pre-shared-key in hex format with no leading “0x”.</td>

       <td><span style="color:teal">Identity</span></td>

       <td>string; default: '''none'''</td>

       <td>The identity of this client.</td>

       <td><span style="color:red">Allow insecure connection</span></td>

     </tr>|}}

       <td><span style="color:blue">Certificate files from device</span></td>

       <td><span style="color:blue">Certificate authority file</span></td>

     <td><span style="color:blue">Client certificate</span></td>

     <td><span style="color:blue">Client private keyfile</span></td>

       <td><span style="color:DarkMagenta">Server address</span></td>

       <td>Socket's server address.</td>

      <td><span style="color:DarkSeaGreen">The directory of the file</span></td>

      <td>Remote FTP directory to upload file to.</td>

       <td><span style="color:DarkSeaGreen">Host</span></td>

       <td>The domain name or IP address of the server.</td>

      <td>integer [1..65535]; default: <b>21</b></td>

      <td>The TCP/IP port of the server.</td>

       <td><span style="color:DarkSeaGreen">Username</span></td>

      <td>string; default: <b>none</b></td>

       <td>The username of the FTP server.</td>

       <td><span style="color:DarkSeaGreen">Password</span></td>

       <td>The password of the FTP server.</td>

       <td><span style="color:DarkSeaGreen">Extra prefix to file name</span></td>

       <td>Extra information to be added to file name.</td>

      <td>The size of the buffer to be used for uploading to FTP server.</td>

      <td>To whom the message will be sent. The number must be specified in full format, country code included. e.g., +37000000000.</td>

      <td>Recipient's phone number users group. Configure it [[{{{name}}}_Administration#Recipients | here]].</td>