Software manual

../_images/we300.png

1. General information

1.1. About this document

Present manual describes in details all functionalities of WE300, implemented in the Software version 3.1.1, released on November 2015. Please make sure that the Software Version of your WE300 is updated to the latest release mentioned on this manual, in order to avoid discrepancies between the versions.

In case of questions and issues not covered by present manual, you can contact Nethix Customer Support for further information:

Email: support@nethix.com

Phone: +39 0423 770750

Web Site: nethix.com

1.2. Overview

WE300 is an easy-to-use remote monitoring and control system complete with an integrated web interface, where every single functionality of the system can be managed. The basic elements to start up the system are a variable, an event and an action. The first sections will therefore concentrate on the description of these elements and on the Modbus protocol, the most used communication device protocol.

Further relevant concepts for a more comprehensive use of all available device functions are the data logging and the network configuration.

In the following sections all these concepts and their use through the WE300 will be described.


2. Variables

A variable indicates the value of one parameter of the monitoring/control system. For example, the variable called temperature indicates the value of the temperature measured by an analogical probe. WE300 allows to create variables and connect them to events and actions. Variables are fundamental elements of the system, since they indicate the value of the monitored parameters and allow to send notifications, save logs, create charts and tabs, send data to Portal and so on. The variables and their status are displayed in alphabetical order or in groups on the page Status → Variables Status.

On page Administration → Variables → Variables is possible to create a new variable or to modify an existing one.

If variables are already defined, they will be displayed on a table showing some of the most relevant information. From this page is possible to disable a variable (and consequently any events and actions associated with it), to cancel it, to enable/disable the data sending to a Portal or to create a new one by clicking on New. For a quick selection of the desired variable/s is possible to use the function Find, that allows to search by name.

../_images/variable_status.png

2.1. Generic variables

Many different types of variables are available, and for each of them parameters may differ. Only the section Generic Variable is valid for all types of variables. This section is structured as follows:

  • Name: The name to be assigned to the variable. All alpha-numeric characters, and the character “_” are supported.
  • Type: This allows to select the type of the variable. For each variable type the setting-parameters are different, see chapter 2.2. Type.
  • Variable Status: enable/disable the variable
  • Portal sending: it allows to enable/disable the sending of the variable value to an external portal/server. For further information regarding the data-sending, see relevant section 7. Data sending data sending.
  • Non-volatile value: it allows to save the variable value every X minute and everytime the device is switched off or rebooted.
  • Skip first read: enabling this optional function the system won’t read the first value of the variable. For example, if an event has been defined on the variable, and at the reboot of the system the variable is in alarm status, through this optional function no action will be enabled.
  • Local log (min): it allows to set a different sampling time (in minutes) for each variable. The recorded data can be then exported or displayed in charts or tabs. For further information see section 8. Datalogger.
../_images/variable_setup_generic_settings.png

2.2. Type

Here are the different types of variables:

  • Analog Input: Variables associated to the analogue inputs available on the WE300. AI1 has to be selected to associate the variable with the analogue input 1 (connectors AN1 and GND) while AI2 has to be selected to associate the variable with the analogue input 2 (connectors AN 2 and GND). Further information on paragraph 2.3. Analog input variables (AI).
  • Digital Input: Variables associated to the digital inputs available on the WE300. It’s possible to choose among DI1, DI2, DI3 and DI4. Further information on paragraph 2.4. Digital input vriables (DI).
  • Digital Output: Variables associated to the digital (relay) outputs available on the WE300. Select DOUT1 for the digital output 1 (connectors RL1A and RL1B) or DOUT2 for the digital output 2 (connectors RL2A and RL2B). Further information on paragraph todo 2.5. Digital output variables (DO).
  • Modbus: Variables associated to Modbus registers. Further information on paragraph 3.2. Creation of Modbus variables.

2.3. Analog input variables (AI)

In order to create a AI variable, i.e. associated to one of the analogue inputs available on WE300, enter the page Administration → Variables. Clicking on New, it’s possible to enter the variable configuration page. Select Analogue Input on the field Type. Under the section Generic Variables all standard settings for any type of variable are available. For the description of all the fields of this section, see 2.1. Generic variables.

Let’s skip into the section Analogue Input: Variable Specific Settings.

../_images/variable_setup_analog_input.png

First of all is requested to confirm the choice of the input, where to read the value. The choice is among AI1 or AI2. Then it has to be entered the measurement unit that will be displayed on charts and on Status -> Variable Status. Through the tabs Minimum value and Maximum value is possible to scale the variable. The minimum tension or current value will be associated to the Minimum Value; the same will be for setting the maximum value.

EXAMPLE: considering a temperature probe, controlled in tension, having min. value -20° and max. value 30°C, corresponding to 0V and 5V, it’s possible to configure the variable minimum value at -20, and the maximum at 30, in order to display the temperature directly expressed in degrees. Using the Decimals field, it will be possible to specify the number of decimals to be displayed.

WE300 analogue inputs have 10bit resolution and are hardware-configurable at factory (software configuration is not possible) in current (0-20mA), in tension (0-5V or 0-10V) and in temperature (NTC). The input value is constantly checked by the WE300, thus keeping controlled any configured thresholds.

2.4. Digital input vriables (DI)

In order to create a DI Variable, i.e. associated to one of the digital inputs available on WE300, enter the Administration → Variables page. Clicking on New, it’s possible to enter the variable configuration page.

Select Digital Input on the field Type. Under the section Generic Variables all standard settings for any type of variable are available For the description of all the fields of this section, see 2.1. Generic variables.

Let’s skip into the section Digital Input: Variable Specific Settings.

../_images/variable_setup_digital_input.png

First of all is requested to confirm the digital input to be associated to the variable. It’s possible to choose among DI1, DI2, DI3 and DI4. Irrespective of the selected input, the fields Close label and Open label need to be completed. Close label refers to the value (or status), that will be displayed when the relevant digital input is closed, Open label refers to the open input. For WE300 a closed Digital Input variable has a logic value of 1. In case of an open input, the logic value is 0. This becomes a very important information for the definition and setting of the events. Once filled in above mentioned fields, the operating mode has to be selected:

  • Normal
  • Counter
  • Time counter

Depending on selection, the meaning of the following fields will change.

2.4.1. Normal

A DI → Normal type variable allows to display the status of the digital input. It is then possible to define events/actions connected to the status change (from open to closed and vice-versa).

../_images/variable_setup_digital_input_normal.png

The only additional field to be configured is the Inverted led. This can change the visualization of the variable on the page Status → Variables Status. If this option is disabled, the open status of the input will be associated to a grey spot, while the closed status to a green one. With enabled option, the situation will be the opposite. For further information see relevant section 6.1. Variables status.

2.4.2. Counter

A DI → Counter type variable allows to count impulses on a digital input.

../_images/variable_setup_digital_input_counter.png

The first field to be completed is Count start, i.e. the starting point of the counter. This value will be considered only the first time: if the counter should be reset, it would then restart from 0.

  • Counter end refers the maximum limit to be reached for resetting the counter. If this field is configured at zero, the counter will increase indefinitely without reverting to zero.
  • Count increment is the increment unit value of each impulse of the counter.
  • Measurement unit is the unit of measurement assigned to the counter. This will be displayed on charts and on the page Status → Variable Status.

The last field to be configured is Edge trigger, i.e. the edge to be considered for the impulse. Selecting Falling edge the counter will increase when the input changes form closed to open; selecting Rising edge the counter will increase when the input changes from open to closed; selecting Rising and falling edge the counter will increase at every edge changing.

2.4.3. Time counter

A DI → Time counter type variable allows to count the opening/closing time of a contact (expressed in seconds). This variable can be used for calculating the total operating time of a defined machinery.

../_images/variable_setup_digital_input_time_counter.png

After the configuration of the Edge Trigger (reminding that Falling edge refers to the change from closed to open, Rising edge refers to the opposite and Rising and falling edge to both of them) the type of counter has to be selected among following possibilities:

  • Permanent: After the start of the counter, WE300 will increase the value at every second, until the user will reset it
  • Stop on opposite edge: the counting will start at the occurrence of an edge change according to the choice made on the relevant field; the counting will stop when reaching the opposite edge and restart again at next change.
  • Reset on opposite edge: the counting will be reset when reaching the opposite edge, and restart from 0 when the selected edge will be reached again.

2.5. Digital output variables (DO)

In order to create a DO variable, i.e. associated to one of the digital outputs available on WE300, enter the page Administration → Variables. Clicking on New, it’s possible to enter the variable configuration page.

Select Digital Output on the field Type.

../_images/variable_setup_digital_output.png

Under the section Generic Variables all standard settings for any type of variable are available. For the description of all the fields of this section, see 2.1. Generic variables.

Let’s skip into the section Digital Output: Variable Specific Settings.

After the selection of the Output (between DOUT1 and DOUT2) to be associated to the variable to be created, it’s required to set the operating mode in the Output mode field. The available options are:

  • Normally open: The output is normally open. Open label refers to the open status of the contact. Close label will close the contact.
  • Normally closed: The output is normally closed. Open label refers to the open status of the contact. Close label will close the contact.
  • Pulse open: The output operates in pulse mode. Open label refers to the open status of the contact. Close label will close the contact. Once closed, the outputs keeps this status for the time configured on the field Pulse duration, after that it returns automatically to the open status.
  • Pulse closed: The output operates in pulse mode. Open label refers to the open status of the contact. Close label will close the contact. Once opened, the outputs keeps this status for the time configured on the field Pulse duration, after that it returns automatically to the closed status.

Regardless of the selected option, the field Status change delay(s) must be filled in with the number of seconds of delay required between an impulse and the enabling/disabling of the output.

Please note that the Non-volatile value option can be combined with the Output mode. If this option is not enabled, the start output status after a power-off or reboot will depend on the Output mode, i.e.: in case of Normally open/Pulse open output, the contact will start from open status; in case of Normally closed/Pulse closed output, the start of the contact will be from closed status. On the other hand if the non-volatile value option is enabled, the start output status will be the same as at the power-off or reboot of the system.

The status of the digital outputs can be modified through their association to an event either by an SMS command or directly from the page Status → Variables status.


3. Modbus

Modbus is a communication protocol used for industrial systems. The graphical interface and the sequence of the pages and sections of the WE300 make the Modbus configuration very easy and intuitive under all aspects.

WE300 allows to create one Master Modbus network in order to read/write registers of a slave device

To create a functioning Modbus network is necessary to:

  • Create one or more Modbus variables
  • Create one or more Modbus commands
  • Set the communication parameters of the Modbus network
  • Associate the variables and the commands with the Modbus network

There is no predetermined sequence: it can be started by defining the network parameters and then creating variables and commands or starting with the creation of commands and variables and then associate them later on.

3.1. Master Modbus

WE300 allows to create one master Modbus network on one of the available physical network: TCP/IP, 232, 485.

3.2. Creation of Modbus variables

To create a variable (of any type) enter Administration → Variables → Variables.

../_images/variable_setup_get_all.png

If some variables are already available, they will be displayed in the table with some of their main features.

To edit an existing variable click on its name, to create a new one click on New.

The name of the new variable is entered in the page for creating variables: the field Name accepts alpha-numeric characters and “_”. The space is not allowed.

Then select Modbus in the Type field.

Under the section Generic Variables all standard settings for any type of variable are available For the description of all the fields of this section, see 2.1. Generic variables.

According to the type of variable selected, the following section will have a specific structure:

  • Modbus net: It allows to select the Modbus network to be associated with the new variable to be created. If no Modbus network is available, this field must be left blank.
  • Modbus address: this field must be completed with the slave address of the device to be connected to the WE300.
  • Memory address: this field must be completed with the slave memory register, where to read/write.

It’s now necessary to select the Access mode, i.e. the type of Modbus variable, among the following options:

  • Read only: It’s possible to read the variable value but not to change it
  • Write only: It’s possible to set the variable value but not to read it.
  • Read and write: The variable value can be read and written.

In the field Data type is possible to select the variable number of bit.

3.2.1. 1Bit data type

../_images/variable_setup_modbus_1bit.png

In this field is requested to specify the position of the bit inside the word (1word=16 bit). Inside one single word there can be up to 16 variables of 1 bit each. If the variable, that we want to create, is on the first position of the word, the value “0” must be selected in the field Bit position. Alternatively if the variable, that we want to create, is on the last position of the word, the value “15” in the field Bit position must be entered.

In order to complete the creation of the variable, just set up a string for the open status (corresponding to value 0) and a string for the closed status (corresponding to value 1). These strings will allow to display the variable status (for example Open/closed, on/off, and so on..)

3.2.2. 8 bit data type

../_images/variable_setup_modbus_8bit.png

For the 8 bit variables is requested to specify the Bit position (it’s possible to choose only between 0 and 7, since 8 bit corresponds to half a word) and some other information available also for 16-32-32inv variables. If the variable, that we want to create, is in the first word position, the value “0” must be entered in the field Bit position. Alternatively if the variable, that we want to create, is in the middle of the word, the value “7” must be entered in field Bit position.

3.2.3. 16-32 bit data type

../_images/variable_setup_modbus_16bit.png

Selecting 16, 32 or 32inv on the field Data type, the following fields must be completed and specified:

  • Measurement unit: measurement unit selected to be assigned to the variable
  • Decimals number: quantity of decimal numbers to be displayed
  • Minimum value: set the minimum (normally “0”) according to the type of variable
  • Maximum value: set the maximum (for example 65535 for 16 bit variables) according to the type of variable.
  • Scaled Minimum value/Scaled Maximum value: the two above mentioned fields are necessary for a correct interpretation of the read/written data by the WE300, even though they might not be relevant for the end-user.

Considering for example a 16 bit variable with min./max. values of respectively 0/65535: a user should need to measure a level from 0 to 10 meters. To this purpose it’s enough to set “0” as Scaled Minimum value and “10” as Scaled Maximum value.

3.2.4. 32 bit float data type

../_images/variable_setup_modbus_32bit_float.png

For the 32 Float / 32 Float inv variables it’s enough to set the measurement unit and the number of decimals. This type of variable doesn’t require any scaling.

By clicking Save the variable will be created.

Note

Information as Modbus address, Memory address, Access mode, Data type, Bit position are normally described in the data sheets of the Modbus devices.

It’s important to make sure that all parameters are correct, in case of doubts contact the salve device’s manufacturer or the Support at Nethix.

For further information about the use of the Modbus Protocol, visit the official site Modbus.org.

The following step is to create a Modbus command, suitable to interact by reading or writing with the new created variable. In order to enter the section dedicated to the Modbus commands, select Administration → Modbus → Commands on the menu.

3.3. Creation of Modbus commands

For granting a correct operating, all Modbus variables need to belong to one or more Modbus commands, according to the type of operation required.

Under the section Administration → Modbus → Commands all available commands (if previously created) will be displayed. In order to create a new command click on Add new command.

../_images/modbus_commands.png

According to the type of variable to be written/read and to the requirements of the slave device connected to WE300, one of the following available functions has to be selected:

  • Read coils -0x01
  • Read holding registers -0x03
  • Read input registers -0x04
  • Write single coil -0x05
  • Write single register -0x06
  • Write multiple registers -0x10

All functions available in WE300 respect the Modbus standard.

Once made the selection of the function to be used, the following parameters need to be set:

  • Slave address: it’s the address of the slave device, where to send all requests/writings. This address must be the same as the one entered in the field Modbus address, previously set in the variable configuration.
  • Memory address: it’s the memory address of the slave device to be accessed. This must be the same as the one previously accessed in the field Memory address of the variable.
  • Words number: it’s the number of word where to use the command. Some functions allow to enter more than one word (to be checked on slave device’s documentation). Setting for example “1” as Memory address and “10” as Words number, it should be possible to use one single command to enter 10 consecutive registers.
  • Interval: Interval of time for the reading function. For the write function this option is not available (the writing of a register is enabled at request). Setting for example “5”, the reading of one or more registers/word is made every five seconds.
  • Modbus Networks: If one Modbus network have already been created, it’s possible to select it.
../_images/modbus_command_create.png

Clicking on Save the command will be saved.

Note

Information as Modbus address, Memory address, Access mode, Data type, Bit position are normally described in the data sheets of the Modbus devices.

It’s important to make sure that all parameters are correct, in case of doubts contact the salve device’s manufacturer or the Support at Nethix.

For further information about the use of the Modbus Protocol, visit the official site Modbus.org.

Once created the command, it’s possible to proceed with the definition of the Modbus network. To enter this section, select Administration-> Modbus-> Networks from the menu, click the tab Networks on the top left side or click the link Create new network on the right side of the Save button.

In this last case, when the page for the creation of Modbus networks opens, the new created command is already associated with the network.

3.4. Modbus network creation

All Modbus variables and commands need to belong to a Modbus network to grant a correct functioning. WE300 supports several Modbus networks of different physical types.

Selecting Administration → Modbus → Networks from the menu, it’s possible to create a new network clicking on Add new network.

../_images/modbus-networks.png

Through the fields Peer type and Physical network type is possible to get 2 different combinations:

  • Master-RTU
  • Master-TCP
../_images/modbus_networks_create.png

3.4.1. Master - RTU Modbus network

According to this combination the WE300 will act as Master inside a RTU network, using one of the available serial ports in order to read/write on the registers of any Modbus slave devices.

The settings to be defined are the following:

  • Network Name: it’s the name to be assigned to the network. Alpha-numeric characters and the character “_” are supported.
  • Network enable: Enable/Disable the network. By disabling an enabled network all associated commands will be canceled. Thus all the variables associated to the network will cease to be updated.
  • Peer type: Master
  • Physical Network type: Serial RTU
  • Serial device: it allows to select one of the following serial ports:
    • RS-232 (connectors TX, RX, GND)
    • RS-485 (connectors A, B, GND)
  • Baud rate: Data transmission speed rate. This field is available in case of RTU Serial.
  • Data bit: Number of data bit for each character (normally 8).This field is available in case of RTU Serial.
  • Parity: Bit of Parity. This filed is available in case of RTU Serial.
  • Stop bit: Number of stop bit. This field is available in case of RTU Serial.

3.4.2. Master - TCP Modbus network

According to this combination the WE300 will act as Master inside a TCP network, using one of the available network interfaces in order to read/write on registers of any Modbus slave devices.

The settings to be defined are the following:

  • Network Name: it’s the name to be assigned to the network. Alpha-numeric characters and the character “_” are supported.
  • Network enable: Enable/Disable the network. By disabling an enabled Modbus network all associated commands will be canceled. Thus all the variables associated to the network will cease to be updated.
  • Peer type: Master
  • Physical Network type: Ethernet TCP
  • IP address: IP address of the slave where the WE300 has to connect.
  • Port: Slave access Port.

Regardless of the selections made on the field Physical network type, the previously created commands and variables have to be associated to the relevant network through the tabs commands and variables.

In the table Availables are listed all variables and Modbus commands previously created. Selecting and clicking > (or with a double click on it), the variable or the command is moved to the table Selected.

To remove a variable or a command from the Modbus network, select it and then click on < (or click twice on it)

When Save, without configuration errors, is clicked, the system will activate the new Modbus network.

In order to check the correctness of all settings, it’s possible to check on page Status->Variables status or the system’s logs on page Diagnostics-> General.

Note that, once created a Modbus network, on the left side of the tabs Save and Back some links will be available, these allow to enter directly the relevant pages, without passing through the menu:

  • Create new command: clicking on this link, there will be a redirection to the page of command creation. The command will be associated to the Modbus network. Once saved the command, it’s possible to click on Create new command. Thus all fields will be reset and it will be possible to create a new command. The command will be assigned to the previously available network.
  • Create new variable: through this link there will be a redirection to the page of variable creation. By default the field Type will be set at Modbus and Modbus Net will show the name of the available Modbus network. Clicking on Save the variable will be automatically associated to the Modbus network. At this stage is possible to click on Create new variable. The field Name will be reset, while all other fields will be duplicated. This procedure will speed up the creation of a new Modbus variable especially if several similar variables are available (having the same Access mode, Data type, Open/Close label): in this case it will be enough to change only the name and just a few more specific parameters.

3.5. Istant reading

It’s possible to read or write one or more Modbus registers without creating a variable or a command.

Entering the page Administration → Modbus → Raw, it’s possible to start an instant reading/writing of a given register, just by properly completing the following fields:

  • Networks: Select the available network. This function is possible only if one network is already available.
  • Function: Select the Modbus function to be used in order to read or write the register/s.
  • Words number: indicate the word number “1” in case of 1-8-16 bit variables, and the “2” in case of 32 bit or float variables.
  • Slave address: indicate the slave address to be entered
  • Memory address: indicate the memory address to be entered.
../_images/modbus_raw.png

In the field Value it will be displayed the value read (in case of reading functions) and a notification message of successfully executed reading/writing will be sent by the WE300.

3.6. Modbus expansions

WE300 includes 4 digital inputs, 2 analogue inputs and 2 digital outputs. The I/O module of WE300 can nevertheless be expanded with one or more additional expansion units of the range XP500.

In order to add or edit an expansion unit is necessary to enter the page Administration → Modbus → Expansions and click on New or select one of the previously added expansions.

../_images/modbus_expansions1.png
  • Name: Enter the name to be assigned to the expansion. This name will be used to create a variables group, where the variables referred to the inputs/outputs of the expansion unit will be saved.
  • Type: It’s possible to select the type of expansion unit to be added.
  • Client address: In this field is selected the slave address to be assigned to the expansion.

Once clicked on Save, the WE300 will try to set the client address entered in the connected expansion unit, using the default communication parameters (38400, 8, N,1) and assuming that the expansion is connected to the slave address 1 (according to manufacturing settings). It’s therefore recommended, always to keep the slave address 1 free.

Once added the expansion, the WE300 will automatically create all variables and Modbus commands (beside the network, if not already available) in order to allow the communication with the XP500. The variables name can be then later on modified from todo_link_variables.

3.7 Manage Modbus errors

WE300 allows to manage the modbus errors on the page Administration → Modbus → Errors handling, clicking on new.

../_images/modbus_errors_handling.png

At the occurence of a modbus error it’s possible to set a variable at a specific value:

  • Network: the network where the error occurs
  • Slave ID (address): the slave address to be monitored ( this field appears only in case of master networks)
  • Timeout (seconds): the error is displayed only if available for more than X seconds
  • Variable: the variable to be set. Selecting None, it’s possible to avoid the setting of any variable
  • Value: the value, that the variable should assume at the occurence of the error

Clicking on Save the error handling is configured and starts monitoring the errors that may occur on the selected network.


4. Events/Actions

Beside variables, events and actions are the other fundamental elements of the WE300.

An event allows to create an action when a variable reaches a certain value/status. For example, an event called warm_room can be intercepted when a variable called temperature is higher than 25°C.

An action is the consequence of the identification of an event. For instance when the event called warm_room is detected, an SMS can be sent to a preconfigured user.

WE300 allows to configure events, that can be associated to actions, in the case that a variable reaches a certain value or status.

4.1. Events

The events allow the WE300 to acknowledge when a monitored parameter reaches a relevant threshold for the user.

Different types of events are available and each type of event is composed of several parameters, in order to reach a high flexibility in controlling and monitoring the system.

WE300 allows to create 10 different events.

To create an event, enter the page Administration/Events/Actions and click on New.

../_images/events_actions_get_all.png

The tab Delete allows to cancel one or more selected events. With the tab Update it’s possible to edit the enabling/disabling of one or more events, to configure events as alarms and send them to a web portal. For a quick search by name of one or more events the Tab Find can be used.

All occurred events can be displayed in a chronological chart, entering the page Status → Logger status → Events.

From this page it’s possible to display one or more events, by selecting them, and the time interval to be considered, from the relevant list, and possibly export data on CSV or Excel format.

../_images/logger_status_events.png

During the creation of an event, and after entering the name, must be selected the type of event among Variable, Incoming data or Scheduler (see 5. Scheduler).

Some generic options can be activated according to the selected type of event: it’s possible to decide the enabling of the event from Status, the visualization as an alarm on the field Set as alarm and to send it to a web portal from the field Send to portal.

../_images/events_action_generic.png

With the option Set as alarm enabled, at the occurrence of the event,, a red ”X” will be displayed near the name of the relevant variable on the page Administration → Variables status status, to indicate the presence of a critical condition

The Send to Portal option allows to send an event to a web portal. At the occurrence of the event, the WE300 will execute the associated action/s and send to Portal a string containing the name of the event and other additional information.

4.1.1. Event on variable

Event on variable refers to an event that occurs when a variable reaches a defined value or a defined status.

First of all a variable in the field variable has to be selected.

../_images/events_actions_variable.png

In the drop-down menu is possible to see all previously created variables and select the one to be associated to an event.

The second parameter to be selected is the Condition, among the following possibilities: EQUAL, NOT EQUAL, GREATER THAN, GREATER OR EQUAL THAN, LESS THAN and LESS OR EQUAL THAN.

It’s now necessary to set the threshold value for the event triggering, i.e. a numeric value will be entered in the field Value, according to the type of the selected variable.

It’s possible to set a value in the field Delay. The value is expressed in second, the function of this parameter is to postpone the triggering of the event for a defined time.

Finally it’s also possible to enable the field Skip first event, that allows the WE500 to ignore the first time that an event occurs.

This can be useful, for instance, in case of an analogue variable (with an ever changing value, having a floating mode). Setting a delay it’s possible to avoid the triggering of any event, before the value has come to a stabilized value. If the delay has been for example set at 10 seconds, the value entered in the relevant field will be kept until the expiry of the 10 seconds, allowing the execution of any possible events.

Once set all parameters, the situation may be the following:

Variable: Var1

Condition: EQUAL

Value: 3

Delay:10

According to this configuration the event would be triggered 10 seconds after the variable Var1 has reached the value 3.

4.1.2. Incoming data

The incoming data are the events coming from external factors. Selecting Ring on Data source there will be the possibility of choosing one or more of the registered users.

../_images/events_actions_incoming_ring.png

The event will occur, when the WE300 receives a ring from one of the authorized users. At ring receipt, the WE300 will disconnect the call, avoiding any costs.

It’s recommended to disable all mailbox or call waiting functions of the SIM installed in the device. For each user is possible to define only a single Ring event.

4.2. Actions

Actions allow the WE300 to react to the conditions defined in an event. Through the actions, the WE300 can monitor a system and then send to the users or to other systems the collected data.

Once created an event and clicked on Save, a new section called Actions will open, where the link Add actions is available.

../_images/events_actions_action.png

Clicking on above mentioned link a new page will be entered.

../_images/events_actions_action_add.png

On this page is possible to create an action for the event previously defined. The possible actions are the following: Send Email, Send SMS, Execute a Command, Ring a User, Reboot and Poweroff.

Once created an action, this will be available in the list under the event. It’s possible to create 1 action for each single alarm.

4.2.1. Send Email

Selecting Send Email, it’s allowed to enter the text to be sent at the occurrence of the event.

If previously used messages are available it’s possible to select them from the field Message, using the drop-down menu.

For entering a new text, select Create new message.

Once the message is defined, it’s possible to select the receivers among the several available users and groups.

After definition of the event and action that generate the email to be sent to a defined user, some more conditions are necessary:

  • Availability of a LAN or GPRS/HSPA connection (see section 10.1. Connectivity and 12.3. Ping)
  • The configured user/s should be enabled to receive notifications emails at a valid email address ( see 9. Users)
  • The mail service must be properly configured (see 10.1.6. Email)
../_images/events_actions_action_email.png

All the text used for the existing actions are available on the page Administration/Event/Actions/Messages. From this page is possible to cancel any message, by clicking on the relevant tab and then Delete, or edit one or more messages by clicking upon it.

4.2.2. Send SMS

Selecting Send SMS it’s possible to enter the text to be sent at the occurrence of a defined event.

../_images/events_actions_action_sms.png

If previously used messages are available it’s possible to select them from the field Message, using the drop-down menu.

For entering a new text, select Create new message.

Once the message is defined, it’s possible to select the receivers among the several available users and groups.

After definition of the event and action that generate the SMS to be sent to a defined user, some more conditions are necessary:

Network Availability The configured user/s should be enabled to receive SMS at a valid telephone number ( see section 9.1. How to create a new user) The SMS service must be properly configured (see section 10.1.4. SMS)

All the text used for the existing actions are available on the page Administration/Event/Actions/Messages. From this page is possible to cancel any messages, by clicking on Delete, or edit one or more messages by clicking upon it.

4.2.3. Execute command

Selecting Execute a Command in the field Type is possible to choose a variable among those available in the list below and then specify a value in the filed To.

../_images/events_actions_action_execute_command.png

Thus, at the occurrence of the defined event, the selected variable will be set at the value entered in the field To.

The drop-down menu could miss some of the already created variables. The reason is that the system automatically recognizes the variables, where the value can be modified:

  • DO Varaiables
  • Modbus write variables
  • Modbus write/read variables

For the same reason the following variables will never be included in the menu: * DI variables * AI variables * Modbus read variables

Through an action of Execute a Command, it’s possible to create some automatic operations at the occurrence of a certain event, as for example to close the contact of an output if an analogue input reaches a defined threshold.

4.2.4. Ring a user action

Selecting Ring a user in the field Type it’s possible to choose one or more users/groups of users, that WE300 will send a voice call in case the associated event occurs.

../_images/events_actions_action_ring.png

If no feedback will be received, the WE300 will stop the call automatically after 30seconds, and then pass to the following user/s in the list.

If the user rejects the call, the WE300 will immediately pass to the following user. Likewise, if a user should answer, the WE300 will pass to the following user in the list immediately after the termination of the call.

4.2.5. Reboot action

Selecting Reboot in the field Type, it’s possible to reboot the WE300 at the occurrence of the associated event.

../_images/events-actions_action_reboot.png

4.2.6. Power off action

Selecting Poweroff in the field Type, the WE300 can be turned off at the occurrence of the associated event

../_images/events_actions_action_poweroff.png

A typical situation where the controlled power-off of the device can be useful, is when the WE300 is battery powered ( for example using a UPS500).

When the battery is low, this could send a request of controlled power-off to the WE300 (through a digital/analogue input), in order to avoid unexpected current interruptions while the system is working.


5. Scheduler

WE300 allows to define up to 5 planned actions, to be executed periodically or only once. To access the scheduler functions, enter the section Event/Actions ( see section 4. Events/Actions). The action, that the Scheduler can execute are those available for any other type of event ( 4.2. Actions). Selecting the option Scheduler on the field Type it’s possible to enter the dedicated section.

../_images/events_actions_scheduler.png

Different combinations are available in the three following options: Execute recurrently based on a schedule, Execute every and Execute only once.

5.1. Execute recurrently

This option allows to enter the calender and specify when the action has to be executed.

../_images/events_actions_scheduler_recurrently.png
  • Minute: in this field is possible to set the exact minute in the hour (between 00 and 59), when the action has to be executed. It’s allowed to set more than one minute (even all minutes).
  • Hour: in this field is possible to set the hour of the day ( 0-23), when the action has to be executed. Also in this case is allowed to select more than one options (even all).
  • Day of month: in this field it’s possible to select the day of the month (1-31), when the action has to be executed. It’s allowed to select more than one option (even all).
  • Day of week: in this field it’s possible to schedule the action execution selecting the day of the week. Also in this case it’s possible to select more than one day (even all).
  • Month: The field Month allows to define in which month the action has to be executed, allowing to select more than one month (even all).

If, for instance, we want to schedule the execution of an action every 15 minutes:

In the field Minute select the numbers 00, 15, 30, and 45.

Assuming that we want to limit the execution of the action between 10.00 and 11.00am, in the field Hour has to be selected 10.

If the action has to be executed every Monday and the last day of every month: in the field Day of month select 31, while in the field Day of week select the option Mon (Monday).

If the action has to be executed only on the first and on the last month of the year, select Jan (January) and Dec (December) in the field Month.

The field Preview allows us to see when the action is going to be executed according to the current configuration. In case of above mentioned example it will be displayed:

Execute at 10:00, 10:15, 10:30, 10:45 if the day is 31 or is Monday of January and December

The action will be therefore executed on every Monday and end of month of January and December at 10:00, 10:15, 10:30 and 10:45.

5.2. Execute every

The option Execute every allows to execute an action at regular intervals. In the field Unit it’s possible to select the measurement unit among Seconds, Minutes, Hours and Days.

../_images/events-actions_scheduler_every.png
  • Seconds: Entering a value “N” in the field Value, the action will be executed every “N” seconds.
  • Minutes: Entering a value “N” in the field Value, the action will be executed every “N” minutes.
  • Hours: Entering a value “N” in the field Value, the action will be executed every “N” hours.
  • Days*: Entering a value “N” in the field Value, the action will be executed every “N” days.

For example, if we want an action to be executed every hour:

Select Hours in the field Unit.

Enter 1 in the field Value.

Even in this case, the field Preview will give the possibility to display when the execution of the action is scheduled. According to the above example, the field Preview will display:

Execute every hour

The action will then be executed at the beginning of every hour.

5.3. Execute only once

The option Execute only once allows to enter the calender and define when the action has to be executed.

../_images/events_actions_scheduler_once.png

Clicking on the icon cal located on the right side of the field Date, the calender will open and allow to select the hour, the day, the month and the year, when the action has to be executed. Once the action has been executed, the event will be deleted.

For example, if an action has to be executed on the 31 of January 2020 at 12:30, it’s necessary to scroll down the calender until the desired data, then select the day and fill in the fields referred to the hour. Then click OK for confirmation.


6. Variables monitoring

Beside receiving notification in case of alarms, it’s allowed to interrogate and monitor the variables status at any time.

The available procedures to interrogate the status and the value of a variable are the following:

  • On Page Status → Variables status
  • Set/Get SMS and Email
  • Incoming data

6.1. Variables status

The page Status → Variables Status contains and displays all created variables. Variables are listed in alphabetical order and can be arranged in groups.

It’s possible to create one or more variables groups on page Administration → Variables → Variables Groups:

../_images/variable_group_get_all.png

Clicking on New a new page is entered, where all created variables are available.

../_images/variable_group_add.png

After having selected a name, it’s possible to choose the variables to be included in the group by selecting them from the Available variables list.

Once confirmed through the tab Save, it’s possible to find the new added group on the page Variable status.

After the creation of the first group, all the variables not associated to any group will be included by default in the group Others.

Returning on page Status → Variables Status Status the following situation will be displayed:

../_images/variable_status_group.png

On the top right corner of the name tab, two icons are shown:

../_images/variable_status_group_header.png
  1. cancel group: clicking on this icon the group is deleted from the page, but the group remains saved and all its variables are active.
  2. hide group: clicking on this icon the group is reduced to the only name, and the varibels are hidden. Also in this case the variables functionality is not impaired.
../_images/variable_status_group_view_all.png

It’s possible to recall and display the hidden or reduced groups clicking on View all, positioned in the bottom right corner of the page.

The table with all variables is divided into 6 columns:

  • Name: name of variable
  • Value: numeric or mnemonic value of variable. This column will remain void in case of Modbus write-only variables (being a write-only variable it’s not possible to know the status).
  • Unit: displays the measurement unit assigned to the variable. For the variables with no measurement unit the column will remain void.
  • Set: Allows to set a value (or status) to the editable variables (Modbus write, Modbus read write, DO). In case of Modbus variables write 1bit, read/write 1bit and DO, the defined status (open/closed) will be displayed as a choice for changing the variable status. For write and read/write Modbus variables it’s possible to enter a numeric value and confirm the choice clicking on Set.
  • Status: In case of Modbus variables 1bit, DI and DO variables, an icon showing the status of the variable will be displayed: green status_on or gray status_off , according to the status and configuration of the variable.
  • Alarm: There’s a column that shows the alarm status of a variable. The icon ok indicates that no active alarms are available. The icon not_ok indicates on the other hand the presence of an event configured as an alarm.

The page Status → Variables Status is automatically refreshed every 5 seconds. It’s therefore possible to display possible status variations without refreshing the page manually.

6.2. Set/Get via SMS/Email commands

It’s possible to interrogate or modify the variable status using a suitable syntax via SMS or Email.

According to the type of variable it will be possible to read or write a value.

6.2.1. Set

The variables that can be modified in their value through the SET command are the following: counters on digital inputs, digital outputs, Modbus write variables and read/write.

The SET command can be used both through SMS and Email. In both cases it’s necessary to define the parameters of the users, authorized to send commands to a WE300 (telephone number for the SMS, email address for the email). For authorizing the users to send command, it’s necessary to enable the relevant functions on the user configuration page. Also the SMS and/or the Email service (in this last case the incoming email service will be enough) must be enabled.

Once appropriately configured the WE300, it’s possible to use the following syntax:

Set Variable Name=Value

Assuming for example,that the variable “Var1” has to be set with value “5”, the SMS to be sent will be the following:

Set Var1=5

If the command will be sent by Email, the same syntax, as in the above example, has to be reported on the Email’s object. If more than one variables value have to be set, it’s enough to separate each command with a space:

Set Var1=5 Var2=10 Var3=15

When writing the commands it’s important to respect the correct spelling of the variables name.

6.2.2. Get

All variables can be read, with the only exception of the Modbus write-only variables.

The GET command can be used both through SMS and Email. In both cases it’s necessary to define the parameters of the users, authorized to send commands to a WE300 (telephone number for the SMS, email address for the email). For authorizing the users to send commands, it’s necessary to enable the relevant functions on the user configuration page. Also the SMS and/or the Email service (both incoming and outgoing) must be enabled.

Once appropriately configured the WE300, it’s possible to use the following syntax:

Get Variable Name Value

Assuming for example, that the value of the variable “Var1” has to be interrogated, the SMS to be sent will be the following:

Get Var1

If the command will be executed by Email, the same syntax, as in the above example, has to be reported on the Email’s object. If more than one variables value have to be interrogated, it’s enough to separate each command with a space:

Get Var1 Var2 Var3

When writing the commands it’s important to respect the correct spelling of the variables name.


7. Data sending

All variables with known status can be sent to an Portal or Web Server, if appropriately configured. The automatic sending of the variable values can be very useful, where several WE300/devices should be centrally managed to monitor the relevant variables, avoiding a direct connection and interrogation of the web interface of each single device. It will then be possible to elaborate charts and tables with the collected data, according to the configuration of the Portal.

Two steps are necessary to let the WE300 sending the variables values:

  • The enabling of the variables
  • Configuration of method and destination of the sending

7.1. Enabling of the variable for the data sending

In order to allow the data sending to a Portal, it’s first of all necessary to enable this function on the relevant variable/s. This can be made on the variable creation page, by enabling the option Portal sending.

It’s possible to enable/disable the option of data sending to portal also from the page Administration → Variables, selecting (or deselecting) the column Portal and clicking then on Update.

../_images/variable_setup_send_portal.png

7.2. Configuration data sending

After the selection of the variables to be enabled for data sending, it’s necessary to appropriately configure all the parameters, that allow the correct functioning of the system, on the Administration → Cloud page.

Some of the information requested on this page, require a minimum knowledge of the data transmission techniques or the support of the Provider of the Portal.

On the first section, called General, are defined some of the basic settings as the enabling of the service and the sending frequency.

../_images/cloud_general.png

The parameters listed in this page must be defined, before proceeding with the further configuration.

  • Variable sampling: enables/disables the sending of variable values
  • Sampling frequency: allows to select the interval of time for the sending
  • IP address sampling: enables /disables the sending of the IP address of the device
  • Sampling frequency: allows to select the interval of time for the sending of the IP address
  • Events sampling: allows to enable the sending of events to a portal

Once enabled the service and decided the frequency of the sending, it’s possible to enable one or more methods or destination among Server and Email report.

7.2.1. Server

From the Tab Server is possible to activate the data sending to the Nethix Portal or to any other remote server.

Selecting Nethix API from the Protocol field and flagging Enable, the data sending to the portal nethix.co will be activated.

The portal service offered by Nethix allows:

  • To send data and to display an overview of all installed devices
  • To display the detailed data of every single device and all the records of the sent data in a chart or tab
  • To create a synoptic that displays in a simpler and more intuitive way the status of the device.
  • To allow a remote access from the device to the portal, in order to read/write the variables value, even if a public IP is not available.
  • To establish a VPN connection between a PC and a portal. Activating the remote access, it will be possible to create a private VPN with all the owned devices, avoiding all possible difficulties referred to the non accessible IP addresses.

For further information, contact Nethix Support.

../_images/cloud_api.png

Default Settings are:

The updated parameters will be indicated by Nethix when the service will be activated.

In alternative it’s possible to enable the data sending to an external server. For this it’s enough to choose the option HTTP on the field Protocol.

../_images/cloud_http.png

In the General Setup the following parameters must be defined:

  • Enable: enable/disable the sending
  • User agent: it’s the user agent that WE300 will use for authenticating in the server
  • Device ID: ID of the device (this can be used for managing more than one device inside the same server)
  • Server address: server address (complete with http://) where to send the data
  • Server port: Port of the server
  • Send mode: mode of the sending. It’s possible to choose among POST and GET. Before activating the option, please ask Nethix Support to have an example string sent by WE300.

In Data Delivery is possible to define the path inside the server, where the processing script of the received data is available

  • Script address: name and complete path of the script inside the remote server

In IP Delivery it’s possible to specify the path, where to find the script , that will manage the sending of the IP address by the WE300. It’s enough to fill in the field Script Address.

Hint

Please note: In case of data sending type Server, the WE300 will use the same frequency as set for the sampling (Administration → Cloud → General).

7.2.2. Email report

From the tab Email report it’s possible to configure the sending, of the data collected by WE300, to one or more email address.

  • Enable: Enable/disable the sending
  • Delivery time: Defines the frequency of the data sending. Delivery and sampling time (field Sampling frequency on tab General) can be different. For example it is possible to sample a variable every minute and to send data once in a day.

For a correct sending of the report, the E-mail account associated to the WE300, 10.1.6. Email), should be properly configured and the option Receive report by email should be enabled in a proper configuration of the users (9. Users).

../_images/cloud_email_report.png

8. Datalogger

Thanks to its 1GB internal memory, the WE300 can log a big volume of data to be read or exported through charts ad tabs. It’s possible to log all variables having a measurable value or status, and the sampling intervals can be different according to the variable type.

8.1. Enable log on variable

The enabling of the logs on a variable has to be made during the creation of the variable (2.1. Generic variables). On the section Generic Settings is in fact available the field Local log (min).

../_images/variable_setup_generic_settings_local_log.png

Entering a correct numeric value and saving the variable, the logs will be recorded at the defined time interval. It’s furthermore possible to enable the logs on one or more previously created variables, entering the page Administration → Variables → Variables:

../_images/variable_setup_get_all.png

Enter a valid numeric value in the field Log and then click Update.

The data collected by the WE300 can be displayed in 2 different modes:

  • On tabs
  • Exporting .csv or .xls files

8.2. Data visualization on tab

The data collected by the WE300 can also be displayed in tables from the page Status → Logger status → Variables.

Also in this case it’ necessary to select from the box Available the variables to be displayed on the tab (choosing among those having active log). Once selected the variables, click on > to send them inside the box Selected, or < to remove them from the list. There is no limit in the number of variables to be displayed.

For generating the table, the time interval of the data visualization has to be defined through the fields From and To, that select the starting and the end point on a calender. It’s then necessary to select Generate Table from the field Action.

At this point it’s possible to click Submit and generate the table.

../_images/logger_status_variables.png

The generated table will display the date and time on the first column on the left (structured according to the device settings) and all collected data on one or more additional columns ( according to the number of selected variables).

8.3. Data export

The collected data can be exported on .csv or .xls files, from the page Status → Logger status → Variables.

Once selected the variables to be exported (among those with active log), click on > to send them inside the box Selected, or < to remove them from the list. There is no limit in the number of variables to be displayed.

Before starting the export of the data, it has to be defined the time interval of the data visualization through the fields From and To, that select the starting and the end point on a calender. It’s then necessary to select Export from the field Action and choose an option between CSV and Excel from the field Type.

At this point it’s possible to click Submit and generate the file.

../_images/logger_status_variables_export.png

In the first position of the file is the Timestamp, i.e. the date and time of the logs, and then many additional columns as the number of the selected variables. The separation symbol between the columns is “”,”“.


9. Users

In order to enter the device web interface and to receive/send SMS, Mail and Ring, it’s necessary to define the users.

WE300 allows to create up to 10 different users.

Three different types of users are available: SYSTEM, ADMIN and USER. The main features of each user’s level are the following:

  • SYSTEM
    • Can read, edit, create and delete all other users
    • Is the only user that can generate other ADMIN users.
    • Is the only user that cannot be deleted. Only logging with SYSTEM credential is possible to change all parameters of this user (username and password included) but not delete its account
    • Can access all system’s functionalities.
  • ADMIN
    • Can read, edit, create and delete users of USER type
    • Cannot delete itself, but can change its own parameters
    • The SYSTEM user can set an expiry date for stopping the device’s access to the ADMIN user.
    • Can access all system’s functionalities, as the SYSTEM user.
  • USER
    • Cannot read, edit, create nor delete any type of users.
    • Can change only its own parameters (but not delete itself)
    • Can access the submenu Status, but cannot configure the system nor create/edit/delete variables and events.
    • The SYSTEM user and the ADMIN users can set an expiry date for stopping the device’s access to the USER user
    • Cannot reboot nor switch off the device.

Originally the default user is a System Administrator type SYSTEM, whose credentials for access are the following (it’s recommended to change these credentials as soon as possible):

Username: admin

Password: admin

9.1. How to create a new user

It’s possible to create a new user from page Administration → Users → Users.

../_images/users_get_all.png

On this page some information regarding the previously created users are displayed:

  • Username: the username to login
  • Full name: the complete name assigned to the user
  • Privileges: the authorization level of the user (SYSTEM, ADMIN o USER)
  • Expire date: the expiry date for user’s deactivation (not deletion)
  • Delete: selection of the users to be deleted through the tab Delete selected users

To edit an existing user just click on its username, to generate a new one click on Add new user.

../_images/users_create.png

The parameters to be set in order to create a user are the following:

  • Username: the username to login
  • Password: the password to be used for login (to be entered twice). The password can be composed of alphanumeric characters and special characters. Being case sensitive, it’s necessary to pay attention to upper and lower cases.
  • Full name: the complete name assigned to the user. After the login, the Full name will be displayed on the top left corner, near the name assigned to the WE300. Clicking on it, the user configuration page is entered.
  • Privileges: the authorization level to be assigned to the customer, among SYSTEM, ADMIN e USER (9. Users)
  • Expire date: Allows to set a deadline after which the user cannot access the interface nor send/receive commands or notifications from/to the WE300. If no expiry date is required this field must be left blank.
  • Phone number: Telephone number associated to the user. It’s necessary if the user wants to send/receive SMS or Rings from/to the device, on the contrary it can be left blank.
  • Email address: Email address associated to the user. It’s necessary if the user wants to send/receive email to/from the device, on the contrary it can be left blank.
  • Actions: in this section it’s possible to enable/disable all options connected to the user:
    • Receive alarms by SMS: if enabled, it allows the user to receive SMS alarms from the WE300, if previously configured.
    • Receive alarms by email: if enabled, it allows the user to receive email alarms from the WE300, if previously configured.
    • Receive alarms by ring: if enabled, it allows the user to receive ring alarms from the WE300, if previously configured.
    • Receive report by email: if enabled the WE300 sends a report via email to the email address of the user, according to the defined settings
    • Send commands by SMS: if enabled, it allows the user to send commands to a WE300 via SMS
    • Send commands by email: if enabled, it allows the user to send commands to a WE300 via mail.
    • Send commands by ring: if enabled, it allows the user to send commands to a WE300 via ring
    • Receive remote command: if enabled, any emails sent by the WE300 to the selected user won’t bear the name of the WE300 on the object. This allows to send Set/Get commands (6.2. Set/Get via SMS/Email commands) between devices.

9.2. Users group

If the system has a high number of users, the management of events and actions might become complex. In order to help managing this situation, it’s possible to create 1 group of users.

A typical application of this function is the sending of alarms to a group of users. If, for instance, a single user should be added to those who receive one or more SMS notifications, it should be necessary to edit all events/actions previously defined. But if the events and actions are associated to a group of users it will be enough to add (or delete) the new user in the relevant group.

For creating, deleting and editing the group of users, it’s necessary to go to page Administration → Users → Groups.

../_images/groups_get_all.png

On this page it’s possible to read the information regarding the previously created group, as for example:

  • Group name: the name assigned to the group
  • Description: the description of the group in object
  • Users: The number of users available in the group
  • Delete: selection of the groups to be deleted through the tab Delete selected groups.

To edit an existing group just click on its name, to generate a new one click on Add new group.

../_images/groups_create.png

For the proper creation of a new group only few information are necessary:

  • Group name: the name assigned to the group
  • Description: the description of the group in object
  • Users: this field allows to select the users to be included in the group. After the selection with the mouse from the box Available users, just click > to include them in the box Selected users or < to exclude them from the group.

Clicking Save, the group will be created. Here are some remarks referred to the groups of users:

  • A user can be assigned to any group
  • Deleting a group of users, the single users previously assigned to the group won’t be deleted.

10. Settings

Beside the main functions described on the preceding chapters, the WE300 allows to configure other parameters in order to meet all customers requirements.

10.1. Connectivity

Connectivity, i.e. i all communication channels to the device, is a very important part of the system’s setting.

From the page Administration → Networking it’s possible to access the screenshots, that allow to configure and start-up the different network interfaces and the different services.

  • LAN
  • SIM
  • GPRS
  • SMS
  • Ring
  • Email

10.1.1. LAN connection

On the page Administration → Networking → LAN it’s possible to modify all parameters of the RJ45 Interface.

First of all the MAC address of the device will be displayed, with the option of using the LAN network on static IP address or on DHCP.

If the Static address will be selected, the following parameters must be set for the correct operation of the service:

  • IP address static IP address assigned to the WE300. Make sure that the address is available and not used on other devices.
  • Netmask Subnet mask. A valid netmask must be entered, according to the specifications of the own local LAN.
  • Gateway Network gateway
  • DNS DNS that can be assigned to the WE300 ( max. 3)
../_images/networking_lan.png

After settings modification the WE300 requires a reboot in order to activate them. If the entered parameters are correct, it’s possible to enter the web interface of the WE300 (even remotely if the network allows it), to send emails and send data to a Portal/Server.

For further information regarding the status of the LAN connection, see page Diagnostics → Networking on section LAN Interface ( see 12. Diagnostic)

10.1.2. SIM parameters

Beside the parameters related to the connectivity, for the correct operating of the SMS and RING services, it could be necessary to define some SIM’s parameters according to the selected provider.

Those parameters are available on page Administration → Networking → SIM.

../_images/networking_sim.png
  • APN: It’s the name of the access point of the GPRS/HSPA network. It changes according to the provider and to the contract with it (in some cases this may be not necessary). It’s an important parameter for a proper functioning of the connection. In case this should not be known, please contact the provider or Nethix Support.
  • Username: it’s the username for the GPRS/HSPA connection. This field is normally blank, if it’s not differently required by the provider.
  • Password: Password to be used for the GPRS/HSPA connection. This field is normally blank, if it’s not differently required by the provider.
  • SIM number: It’s the Telephone number of the SIM inserted in the WE300. This is not relevant for the functioning (this number is never used by the WE300), but can be used for identifying the device later on.
  • SMS center: It’s the SMS Service Centre of the Provider. With some types of SIM this could not be required. If this number is not known, please contact the Provider or Nethix Support.

10.1.3. GPRS connection

WE300 allows to establish a GPRS connection in order to enter the web interface of the device and send data or emails, even if no Ethernet connection is available.

In order to activate the connection enter the page Administration → Networking → GPRS.

../_images/networking_hspa.png

Once enabled the service with a flag on the field Enable, it’s required to specify whether the connection must be always on or on demand.

  • On demand: the connection is activated on request by an authorized user through a wake-up message (11. Commands) and after 15 minutes is automatically disabled. If the activated services require a connection for data sending or email sending.., the connection of the WE300 will automatically be closed at the end of the configured operations.

If the parameters have been properly configured, after a few minutes the GPRS connection will be activated. On the status panel, positioned on the right side of the web interface, the GPRS indicator will become green and beneath it the connection uptime and the relevant IP address will be displayed.

The WE300 offers also the possibility of associating the connection with a dynamic DNS service, choosing from the List of Providers available on section Dynamic DNS. This service allows to access the WE300 even if no static IP is available, since the device will be identified by the selected provider at every single connection, allowing the users to reach the web interface, just entering the hostname as configured on the browser. For further information see the Provider’s site or contact Nethix Support.

Make sure that the GPRS connection has been successfully established, by checking if all necessary operations have been executed:

  • Provide the WE300 with an enabled data SIM card (rechargeable or with flat tariff contract)
  • Enter the APN (10.1.2. SIM parameters) for the Providers, that require it.
  • Connect the antenna and check the strength of the available GSM signal.
  • Enable the GPRS service.

It’s possible to check the quality of the connection by using the diagnostic tool Ping (12.3. Ping). Further information regarding the status of the connection can be found on page Administration → Diagnostics → Networking (12.2. Information of connectivity)

10.1.4. SMS

To enable/disable the SMS service go to page Administration → Networking → SMS. Beside the flag for enabling the service, it’s possible to enable or disable the sending of pre-set SMS notifications (4. Events/Actions).

../_images/networking_sms.png

Enabling the service, it should be necessary to enter the SMS Service Centre number (10.1.2. SIM parameters).

Once enabled the SMS service, it’s possible to test the functioning through the section SMS test: entering a valid telephone number, complete with country code (for example +39NNNNNNNNNN for Italy), the WE300 will try to send an SMS with the following text ” Test message from WE300 “.

For granting the proper functioning of the SMS service, allowing the users to communicate with the WE300 and the WE300 to send alarm notifications, the procedure below must be carefully carried out:

  • Enter the SMS Service Centre (10.1.2. SIM parameters).
  • Enable the SMS service as described before
  • Enable the SMS sending on event (field Send events on Administration → Networking → SMS)
  • Define at least one user with activated SMS sending/receiving functions (9. Users)
  • Create one or more events as Send SMS action (se 4. Events/Actions).
  • Make sure that the SIM is properly inserted and with enough credit.
  • Make sure that the antenna is properly connected and that the available signal is strong enough.

All sent and received SMS can be displayed on page Status → Services → SMS: the first page to be entered will show the SMS received by the device.

../_images/status_services_sms_inbox.png

In the table the following information will be available:

  • Number: shows the Phone number of the SMS sender
  • Reception date: displays the date and time when the WE300 has received the message
  • Text: contains the text of the received message

The button Refresh can be clicked at any time in order to update all information; Empty box for deleting all messages stored on Inbox.

Clicking on the drop-down menu on the top of the table, it’s possible to pass from Inbox to Outbox.

../_images/status_services_sms_outbox.png

On this table is possible to display all the messages not yet delivered by the WE300. The available information are the following:

  • Number: refers to the phone number of the message receiver
  • Creation date: shows the date and time when the message has been created
  • Text: displays the text of the message

The button Refresh can be clicked at any time in order to update all information; Empty box for deleting all messages available on Outbox (such messages won’t be delivered).

Clicking on the drop-down menu on the top of the table, it’s possible to pass from Outbox to Sent.

On this table are displayed some information regarding the SMS already delivered by the WE300:

../_images/status_services_sms_sent.png
  • Number: shows the receiver of the delivered messages
  • Send date: displays the date and time when the WE300 has delivered the message
  • Text: contains the text of the sent messages

The button Refresh can be clicked at any time in order to update all information; Empty box for deleting all messages stored on Sent.

10.1.5. Ring

One of the actions that can be associated to an event (incoming or outgoing) is the RING, that can be sent or received to/by one or more registered users (4. Events/Actions).

To enable the Ring Function go to page Administration → Networking → Ring and enable the field Enable rings.

../_images/networking_ring.png

Once enabled the function and clicked on Save, it’s possible to use this option.

To make sure that this function is properly operating, it’s recommended to check the following points:

  • Enable the Ring function, as described above.
  • Define at least one user with valid telephone number, enabled to receive/send rings (see 9. Users)
  • Make sure that the SIM card is properly inserted and voice call enabled.
  • Make sure that the SIM card has enough credit to send rings.
  • Make sure that the GSM antenna is properly assembled and that the signal is strong enough

10.1.6. Email

Before proceeding with the configuration of the WE300, it’s necessary to make the following:

  • After the selection of the provider (Gmail, Yahoo, Hotmail etc..) enter the provider’s site and create a new valid mail account
  • In the site of the provider, collect all information regarding the parameters to be entered in order to configure the mail service

Once a new account has been created, it’s possible to proceed with the configuration of the WE300, enabling the outgoing emails, the incoming emails or both of them from the page Administration → Networking → Email.

../_images/networking_email.png

On the section Outgoing mail setup the parameters required for the email sending from the WE300 must be set:

  • Enable outgoing mail service it enables/disables the email sending service.
  • Server type it allows to choose the type of mail server (at the moment only SMTP available)
  • Server address it’s the address of the mail server ( for example smtp.gmail.com)
  • Port it’s the number of the access port (for example 587)
  • Email address the email address associated to the WE300. This will be the address visualized by the receivers of the emails.
  • Username It’s the username of the mail account associated to the WE300.
  • Password It’s the password of the mail account associated to the WE300.
  • SSL-TLS Encryption

Once clicked on the button Save, a new section, called Outgoing mail test, will appear on the bottom of the page: from this section it’s possible to send a test email to any address.

A properly configured mail service allows the WE300 to send notification mails to the configured users (see 4.2.1. Send Email)or to send scheduled reports (see 7.2.2. Email report).

On the section Incoming mail setup the parameters required for the email sending from the WE300 must be set:

  • Enable incoming mail service: Enables/disables the email receiving service.
  • Server Type: Type of mail server (at the moment only POP available)
  • Server address: the address of the mail server (for example pop.gmail.com)
  • Port: Number of the access port (for example 995)
  • Email address: the email address associated to the WE300. The commands sent by the authorized users should be sent to this address.
  • Username: It’s the username of the mail account associated to the WE300.
  • Password: It’s he password of the mail account associated to the WE300.
  • SSL-TLS: Encryption

A properly configured mail service allows the authorized users to send commands to the WE300 (see 6.2. Set/Get via SMS/Email commands and 11. Commands)

All sent and received emails can be visualized on the page Status → Services → Email.

The first page shows the emails received by the device:

../_images/status_services_email_inbox.png

On the displayed table the following information are available:

  • Mail address: the mail address of the sender
  • Reception date: Date and time when the WE300 received the email.
  • Text: text of the received email.

At any time it’s possible to click on the button Refresh in order to update the information, or Empty box, in order to delete all messages available inside Inbox.

Clicking on the drop-down menu on top of the table, it’s possible to pass from Inbox to Outbox.

../_images/status_services_email_outbox.png

On this table it’s possible to visualize all the emails not yet delivered by the WE300. The following information will be shown:

  • Mail address: in this filed is shown the address of the receiver of the mail.
  • Creation date: It’s the date and time of the mail creation
  • Attempts: it shows the sending attempts made by WE300
  • Text: it displays the text of the mail

At any time it’s possible to click on the button Refresh in order to update the information, or Empty box, in order to delete all messages available inside Outbox ( deleted mails won’t be sent out)

Clicking on the drop-down menu on top of the table, it’s possible to pass from Outbox to Sent. On this table are displayed some information referred to the email already sent by the WE300:

../_images/status_services_email_sent.png
  • Mail address: in this filed is shown the address of the receiver of the mail.
  • Creation date: It’s the date and time of the mail delivery
  • Attempts: it shows the sending attempts made by WE300 before the successful delivery
  • Text: it displays the text of the sent mail

At any time it’s possible to click on the button Refresh in order to update the information, or Empty box, in order to delete all messages available inside Sent.

10.2. System settings

On section Administration → General Setup it’s possible to define some general settings of the device and enable some additional services.

10.2.1. Information about the system

On the page Administration → General Setup → System, under the section System, it’s possible to configure the contents to be displayed on the page Status → Site immediately after the login. These parameters are not compulsory and are used just to identify the device.

../_images/general_setup_system_system.png
  • Site name: the name assigned to the device
  • Site id: numeric ID assigned to the device
  • Country: Country where the device is installed
  • Region: Region/Area where the device is installed
  • Picture: when this option is enabled, it’s possible to select an image, by clicking on Select file, and then display the selected image after the login (for example the picture of the installation, of the company..and so on..). The picture will be displayed on the page Status -> Site.

10.2.2. Date and time

On the page Administration → General Setup → System**under the section **Time/Date, it’s possible to set the date and time of the device:

../_images/general_setup_system_time_date.png
  • Installation time/date: It states the date and time, when the device has been installed. This information has no influence on the functioning and has the only reason of identifying the installation.
  • Set time/date: It allows to set the date and time of the device.
  • Enable NTP: it enables the automatic synchronization of time. Once per day and at every reboot, the WE300 will connect to the server in order to update date and time precisely, according to the relevant timezone.
  • Select time-zone: it allows to set the timezone of the device.

It is also possible to specify a custom NTP server, by clicking the Advanced link.

10.2.3. Web interface personalization

Some graphical personalizations of the web interface of the device are possible from page Administration → General Setup → Web Interface, and will be valid for all the users.

../_images/general_setup_web_interface.png
  • Logo: this allows to choose an image to replace the Nethix logo on the left top of the page.
  • Prevalent color: Primary color of the page. (RGB hexadecimal color, for example: #007BC5)
  • Secondary color: Secondary color of the page. (RGB Hexadecimal color, for example #009FE9)
  • Font color: Color of the text. (RGB Hexadecimal color, for example #007BC5)
  • White icons: Disabling this option, all the icons of the header (power-off, reboot, logout) will be displayed in black.
  • Background color: Color of page’s background .(RGB Hexadecimal color for example #007BC5 )
  • Footer: it allows to configure the footer at convenience (HTML code is allowed)

Clicking on all coloured fields, a “color picker” will allow to select the desired color and automatically insert the relevant hexadecimal value.


11. Commands

The WE300 has a list of preconfigured commands, that allow to set or to read some system parameters. Commands can be sent by any authorized user, both via SMS and via mail. On the table below are listed all system commands with relevant description:

Command Description
STAT

Request of the system status. The device answers sending an SMS or Mail, containing following information:

  • IP address (GPRS if available, or LAN)
  • Uptime of the device
  • CPU load

Example:

IP:192.168.1.146 (15:54:49 UP 9 DAYS, 7:07, load average: 0.32, 0.23, 0.18)

WAKEUP

Request of a GPRS On-Demand connection.

When the WE300 receives this command (SMS or Mail) from an authorized user, if the GPRS/HSPA connection is on-Demand, it will establish a new connection, which remains on for 15 minutes. If no dynamic DNS service is enabled, it’s possible to use the above mentioned STAT command to receive the IP address of the WE300.

SETTIME MMDDhhmmYYYY

When the WE300 receives this command (via SMS or Email) from a registered user, a new date and time, as indicated in the text message, will be set.

The syntax means: MM=month, DD=day, hh=hour, mm=minutes, and YYYY=year

EXAMPLE: For setting the date 6th December 2015 and the time 11:07 send the following message: SETTIME 020611072015

SIGNAL

Request for the GSM Signal strength

When the WE300 receives this command (either via SMS or Email) from a registered user, the device will check the strength of the available GSM signal and will inform the requesting party according to the following format: GSM Signal:XX Where instead of “XX” a number between “01”(no signal) and “31” ( max. signal) will be reported.

ReBooT

Request for a system reboot. When the WE300 receives this command (either via SMS or Email) from a registered user, it will start a system reboot.

Pay attention to upper and lower case letters.

PowerOff

Request for a system power off.

When the WE300 receives this command (either via SMS or Email) from a registered user, it will turn off the system. It will be necessary to disconnect and then reconnect the power in order to let the device start again.


12. Diagnostic

The WE300 offers the possibility to make some diagnostic operations and display some data referred to the system functioning.

Entering the section Diagnostics it’s possible to get some additional information regarding the active connections, in order to check the proper functioning of the same.

12.1. System Log

From the page Diagnostics → System → System it’s possible to read the last 20 logs of the system.

../_images/diagnostics_general_system.png

On the table are displayed some useful information for having a feedback on the system status and for finding possible malfunctions. For updating the list of the displayed logs, click on the button Refresh.

In case of error notifications, check the device configuration and refer to Nethix support for further instructions.

From the page Diagnostics → System → Boot it’s possible to display the logs referred to the system boot, that is the operations executed by the WE300 at every restart/reboot.

../_images/diagnostics_general_boot.png

Those information can be relevant for Nethix Support in case of technical assistance.

12.2. Information of connectivity

From the page Diagnostics → Networking it’s possible to get additional information regarding the status of the active connections.

../_images/diagnostics_networking.png

The page is divided into two sections: LAN interface and GPRS Interface.

Every section reports a number of technical information regarding the relevant connection.

LAN Interface:

  • Status: up if the connection is established, down if the service is not available or if the WE300 has not come to establish a connection.
  • MAC address: it displays the MAC address of the WE300 network interface
  • IP address: previously configured (Static) or acquired (DHCP) IP address
  • Subnet mask: previously configured (static) or acquired (DHCP) subnet mask
  • Gateway: previously configured (static) or acquired (DHCP) gateway.
  • DNS servers: available DNS servers.
  • In/Out bytes: quantity of traffic carried out during current connection.
  • In/Out errors: quantity of outgoing/incoming errors during current connection
  • Collisions: quantity of collisions occurred during current connection.

GPRS Interface:

  • Status: up if the connection is established, down if the service is not available or if the WE300 has not come to establish a connection.
  • Signal: it gives the signal level in CSQ. The scale ranges from 1 to 31, where 31 is the max. coverage while 1 is the minimum. In order to have a stabilized connection, it’s recommended to have at least a Signal of 15-16.
  • Network operator: it’s the name of the Provider used by the WE300.
  • IP address: IP address of the connection.
  • Gateway: gateway provided by the operator
  • In/out bytes: quantity of traffic carried out during current connection.
  • In/Out errors: quantity of outgoing/incoming errors during current connection
  • Collisions: quantity of collisions occurred during current connection.

12.3. Ping

In case of communication problems, for example when sending the data to a portal, sending a mail or similar, the WE300 gives the possibility to run a ping towards any host, allowing the selection of the network interface to be used.

For this operation enter the page Diagnostics → Ping.

../_images/diagnostics_ping.png
  • Host: enter in this field a valid hostname, to be reached through ping (for example www.google.com)
  • Interface: the network interface to be used for reaching the defined host. According to the configuration of the device and enabled services, it’s possible to choose among LAN and GRPS.
  • Count: it allows to select the ping number to be run.

Once completed above mentioned fields, click on Ping in order to start the operation. The results will be reported on the lower part, allowing the user to find any possible problems arising.


13. System operation

13.1. System information

On page Administration → System → Info it’s possible to find some additional information regarding the WE300. On section System Information are displayed some general information:

../_images/system_info1.png
  • Version: it’s the version currently installed on the device.
  • Software serial number: it’s the serial number available on the backside label of the device.
  • Hardware serial number: it’s the hardware serial number, that is important for registrating on the portal and for using services as the VPN by Nethix.
  • Modem IMEI: it’s the IMEI code of the Modem inside the WE300.
  • Uptime: it’s the operating time of the WE300 from the last start.
  • Local time: date and time of the device
  • Memory usage: it’s the status of the RAM memory.

On the section System Status, the status of some other services and functions of the device is shown. Beside every single service is available a graphic indicator, that allows to have a quick overview of the WE300 status.

Generally speaking, a green indicator means that the service is enabled and properly functioning, while a grey indicator means that the service is disabled and the red indicator, that the service is not properly configured and not in use. Clicking on any indicator, it’s possible to access the configuration section of the relevant service.

13.2. Backup/Restore function

WE300 offers the possibility to make a backup of the device configuration as an encrypted file on page Administration → System → Backup/Restore.

../_images/system_backup_restore.png

The backup includes:

  • Created variables
  • Associated events and actions
  • Networking settings
  • Created users
  • Enabling and configuration of the services

Not included in the backup:

  • System log
  • Service log
  • SMS/Email/Cloud archives
  • Variables log

To make the backup, click on Download configuration.

Once received the encrypted backup file, it’s possible to load it on any other device in line with the first one.

From the section Restore configuration, select the encrypted backup file and click on Restore. After this operation, it’s recommended to reboot the device, in order to make the modification effective.

The Backup/Restore function can be useful to keep a copy of the configuration made, in order to reload it on the device itself or on some more additional devices having the same configuration.

In this last case (Restore on additional WE300) consider the following:

To restore the same configuration on two or more WE300, the devices must have the same Firmware version. If not, please contact Nethix support. The devices must also present the same hardware/software options (see 13.6. Features).

13.3. Delete log

The internal memory of the WE300 allows to store a huge number of logs. But to avoid an overloading of the device, it’s possible to delete any logs from the page Administration → System → Reset Logs.

../_images/system_reset_logs.png

The Logs that can be deleted are the following:

  • SMS: it deletes all available SMS (sent, received and outgoing)
  • Email: it deletes all available emails (sent, received and outgoing)
  • Portal: it deletes all data sent to an external portal
  • Commands: it deletes all the logs referred to the execute a command.
  • Events: it deletes all the logs referred to occurred events/actions.
  • Variables: it deletes all the logs from the datalogger

Once selected one or more of above listed positions, click on Erase logs for deleting permanently the logs from the device memory.

13.4. Factory reset

From the page Administration → System → Factory Reset it’s possible to delete all stored logs and data and reset the configuration, bringing the device back to the factory settings.

../_images/system_factory_reset1.png

Click the big red button on the page, and confirm the choice. After the confirmation the WE300 will reboot and after the initialization phase the device will be again accessible via LAN.

13.5. Device upgrade

The WE300 can be upgraded any time upon customer’s request or on suggestion of Nethix.

The upgrading can be made uploading on the device an encrypted file, containing the upgrade (to be requested at Nethix Support), on page Administration → System → Upgrade.

../_images/system_upgrade.png

From the section Upgrade from file, it’s possible to send to the WE300 an encrypted package, containing the upgrade, after having downloaded it on the PC.

The package changes according to the starting version to be upgraded, it therefore must be required directly at Nethix’s support.

To start the upgrading it’s required to select the file to be sent and click the relevant button Upgrade. Once the file has been sent to the device, the WE300 will restart in order to proceed with the installation of the new version.

The download time depends directly from the speed of the active connection available with the WE300. Once downloaded the version, the WE300 will restart in order to proceed with the installation. This operation could require about 5 minutes.

Once the WE300 has returned to be available, it’s recommended to enter the interface in order to check the result of the upgrading operation (on the status panel).

13.6. Features

The device features are a set of hardware and software options, that compose the system. The list of enabled features depends from the device type and from the additional hardware options, that have been required.

To check the enabled features in a device, go to page Administration → System → Features.

../_images/system_features.png

Clicking on the eye-shaped icon, available beside the section Supported Features, it’s possible to visualize the complete list of the enabled features.

From the section Update from file it’s possible to select an upgrading pack, that, together with a security code, will allow to enable or disable at any time the desired features.

Both the pack and the code can be requested at Nethix support and are referred to one single WE300. It’s not possible to use the same features pack on more than one device: the system will stop the procedure automatically.

In case the function backup/restore has to be applied, it’s necessary to check in advance that all devices concerned have the same list of enabled features.


14. Safety guidelines

  • Nethix products support SIM cards from providers of all around the world, particularly from Europe Africa and Asia. However, there could be some incompatible SIM cards.
  • The device cannot receive/send SMS nor RING if the SIM card is not enabled to GSM services and network or credit is not available (if prepaid card is used).
  • Verify that the device is operated in an area covered by GSM network with sufficient signal strength for granting proper functioning.
  • In case of questions or doubts regarding the cost of the SMS service consult your Network Provider.
  • This device is only suitable for being installed by a qualified operator
  • Nethix is not responsible for improper use and/or its side effects
  • Nethix products are designed for typical use in industrial automation and/or home applications.

If you plan to use Nethix products in special applications where anomalies and discontinuity of service can have serious effect on human life or can cause physical or material damages, or where extremely high levels of reliability are required (for example in aerospace systems, in atomic energy control systems or n electro-medical devices), please contact Nethix for support to your particular application. Nethix is not responsible of damages caused from its products if such applications are not previously authorized.

not_recyclable The product shall not be treated as household waste. It shall be instead handed over to an appropriate collection point for the recycling of electrical and electronic products. For further information about recycling of this product, contact the local city office and/or the local waste disposal service.


15. Warranty and support

Nethix warrants to the buyer that the product will be defect-free within two years (24 months) from the date of purchase.

During warranty time, and against presentation of purchase invoice, the product will be repaired or replaced, at Nethix’s discretion, without any additional costs as regards spare parts and repair, if the damages are proven to be manufacturing defects.

Warranty will be voided if the product has not been used properly.

In case of technical problems the user can ask for support:


16. Return and repair

Product return to NETHIX must be previously authorized, requesting a RMA number.

Please send an Email at Nethix containing all following information:

  • Complete customer’s name and address
  • Distributor’s or Reseller’s name and address
  • Date of purchase
  • Product P/N and S/N as displayed on the product or the package
  • Detailed description of fault and/or reason for return

Nethix will communicate the RMA number, in order to start the return procedure of the product. The delivery of the goods shall be arranged DDP at Nethix premises. Products returned without factory seals will be automatically treated as out-of-warranty repair services.