WebHMI Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{ :vb:virtualbox_logo.png?nolink&150|}}

====== Run Virtual Box WebHMI image ======

It is possible to run WebHMI as virtual machine (VM). 

<WRAP center round download 50%>
**Prerequisites** - You must have [[https://www.virtualbox.org/wiki/Downloads|VirtualBox]] installed on your computer to be able run this VM. VirtualBox Extension Pack is **required** as well if you want to use USB serial adapters (RS-232 or RS-485) inside VM. 
</WRAP>

The steps required are as follows:

  - [[#downloading_the_image|Download the image]]
  - [[#add_the_image_to_your_virtual_machines|Add it to your virtual machines]]
  - [[#network_setup|Setup network]]
  - [[#running_vm|Run the VM]]
  - [[#adding_serial_ports_to_vm|Setup serial ports (if necessary)]]


You can also export your machine to other virtualization systems like VMware, Proxmox, etc. 

===== Downloading the image =====

You can download VirtualBox image at [[https://level2.webhmi.com.ua/apps/downloads/list| Level2 system]].

{{vb:vbox_download_new.png?direct&688|}}

===== Add the image to your virtual machines =====

Once image was downloaded, extract archive to desired destination and double click the image configuration file for auto-install. 

{{:vb:install:vbox-machine-definition.png?direct|}}

After this WebHMI VM will be in your system. 

{{:vb:install:webhmi-vm-in-your-vbox.png?direct&688|}}

===== Network setup =====

Upon installation, there will be one network adapter in the virtual machine with static IP address of 192.168.1.1 bound to one of your PC's network adapters (bridge mode). 
<WRAP center round important 60%>
If your PC network differs from 192.168.1.0 network, you won't be able to connect to your virtual machine yet, becuase adapter's IP is set inside the VM.
</WRAP>

Enter setting and make neccessary network changes accordingly.
{{ network:vm-3.jpg?nolink&800 |}}

Select the PC's network adapter on **Network->Adapter 1** tab you want to share with VM's network #1 adapter.  

{{ network:vm-5.jpg?nolink&912 |}}

Also we reccomend add another **Adapter #2** to your VM in the //virtual host adapter mode// to be able to connect to VM for sure. Please refer to this [[#create_virtual_network|section]]

{{:vb:install:vbox-host-adapter.png?direct&600|}}

===== Running VM =====

Close settings window and click **Start** button. 

{{ network:vm-6.jpg?nolink&912 |}}

Virtual machine will be started now.

{{ network:vm-7.jpg?nolink&912 |}}

In about 10-20 seconds it will complete boot process. You should see "WebHMI server started" message in console.

{{ network:vm-8.jpg?nolink&912 |}}

By default virtual machine is connected to your network via bridged network adapter. It uses static ip address 192.168.1.1. So web interface of WebHMI will be available at address 192.168.1.1 too. You can change this address later via **[[http://docs.webhmi.com.ua/network_connections_setup|Network Settings]]** interface.

Open [[http://192.168.1.1|http://192.168.1.1]] in your browser. You should now see WebHMI's user interface.

{{ network:vm-9.jpg?nolink&912 |}}

Default credentials are:
|Login| admin|
|Password| admin|

Congratulations! You was able to run WebHMI on your computer. Have fun with it.



====== Adding serial ports to VM ======

===== Windows 10 host system =====
For Windows 10 host system, a USB filter should be set up in the image properties. 
Please refer to the following picture: 

{{ :vb:v_box_serial_filter_eng.png?direct&600 |}}

Be sure you enabled the USB converter for the virtual machine:

{{ :vb:v_box_usb_serial_mapping.png?direct&600 |}}

Inside WebHMI project, select your serial device in the connection properties, as shown below:

{{ :vb:install:vm-select-usb-uart.png?direct&600 |}}

====== Troubleshooting ======

===== I can't get access to web interface =====
Please make sure that you physical network adapter is connected to some network. If you are using Ethernet adapter, please make sure that it is connected to switch or router or other device so your operation system will detect link on it. If you can't connect it to any device please see below **Creating Virtual Network** section.


===== 192.168.1.1 is already in use in my network =====

There are 2 possible workarounds for this situation:
  - Use DHCP in your network to configure second network interface in virtual machine
  - Create virtual network in VirtualBox

==== Use your DHCP ====
WebHMI's virtual machine has second network interface setup as DHCP client. By default it is disabled.

Go to virtual machine settings, select **Network**->**Adapter 2**. Check **Enable Network Adapter**. Choose "**Bridged Adapter**" and select your network card. 

{{ network:eth1-enable.jpg?nolink |}}

Save settings and start virtual machine. Wait for boot to complete. For second interface it takes a few seconds longer to initialize and get IP address from DHCP server. Wait until you will see message "New network interface connected". There will be a list of all available IP addresses (192.168.1.1 plus IP from DHCP).

{{ network:eth1-ip.jpg?nolink |}}

In this example you can get access to WebHMI's UI via http://192.168.1.131/ URL. So now you should be able login into WebHMI and adjust **[[http://docs.webhmi.com.ua/network_connections_setup|Network Settings]]** to match your existent network,

==== Create Virtual Network ====
In some cases you might want to create absolutely independent network for your virtual machine. These might be security or any other reasons. Here is [[https://www.virtualbox.org/manual/ch07.html|VirtualBox's manual about virtual networking]].

For example, if you have only only one Ethernet adapter which is not connected anywhere. In this case your operation system will to send any traffic to such interface and you will be unable to use WebHMI' UI with bridged adapter. In opposite, virtual network's cable is always connected. So there will be no such problem.

To create new virtual network go to **File**->**Host Network Manager**. 

{{ network:virtual-eth-menu.jpg?nolink |}}

Click "**Create**" button. This will create new network. Here you can adjust network setting if needed.

{{ network:virtual-eth-settings.jpg?nolink |}}

Now go to WebHM's virtual machine settings, select **Network**->**Adapter 2**. Check **Enable Network Adapter**. Choose "**Host-only Adapter**" and select your newly created virtual network (vboxnet0).

{{ network:virtual-eth-connect.jpg?nolink |}}

Save settings and start virtual machine. Wait for boot to complete. For second interface it takes a few seconds longer to initialize and get IP address from DHCP server. Wait until you will see message "New network interface connected". There will be a list of all available IP addresses (192.168.1.1 plus IP from DHCP).

{{ network:virtual-eth-ip.jpg?nolink |}}

In this example you can get access to WebHMI's UI via http://192.168.56.105/ URL. So now you should be able login into WebHMI and adjust **[[http://docs.webhmi.com.ua/network_connections_setup|Network Settings]]** to match your existent network, Or you can continue to use this virtual network.