User Tools

Site Tools


start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
start [2020/06/12 10:52] – ↷ Links adapted because of a move operation atolstovstart [2022/11/04 10:53] (current) – [Tips & Tricks] emozolyak
Line 1: Line 1:
 ====== WebHMI Documentation ====== ====== WebHMI Documentation ======
 +
 +{{ network:webhmi_wo_bgnd_smaller.png?direct&150|}}
  
 ===== Introduction ===== ===== Introduction =====
 +  * [[what_is_webhmi|What is WebHMI?]]
   * [[Purpose and application]]   * [[Purpose and application]]
-  * [[WebHMI functionality]]+  * [[webhmi_functionality|Functionality overview]]
  
-===== Download and run demo version  ===== +===== Virtual WebHMI images ===== 
-  * [[Run WebHMI as virtual machine]]+  * [[vb:run_webhmi_as_virtual_machine | Running Virtual Box image]] 
 +  * [[l2_vm|Running cloud image]] 
 +  * [[licensing_vm#licensing_virtual_images|Licensing virtual images]]
  
-===== Steps to take before turning on your WebHMI =====+===== Hardware WebHMI setup =====
   * [[Connectors|Connect cables]]   * [[Connectors|Connect cables]]
   * [[Connecting External Devices|Connect external devices]]   * [[Connecting External Devices|Connect external devices]]
Line 19: Line 24:
   * [[Time synchronization]]   * [[Time synchronization]]
   * [[Prohibition of the SSH connections]]   * [[Prohibition of the SSH connections]]
-  * [[FTP server]] 
  
-===== System setup =====+ 
 +===== System setup & Maintenance =====
   * [[setup_menu | Project Setup Menu]]   * [[setup_menu | Project Setup Menu]]
   * [[System settings]]   * [[System settings]]
-  * [[Configuration reset]] +  * [[webhmi_branding|Branding]]
-  * [[Performance optimization]]+
   * [[Managing users]]   * [[Managing users]]
   * [[Project backup and restore]]   * [[Project backup and restore]]
 +  * [[Configuration reset]]
 +  * [[Firmware upgrade]]
 +  * [[Reboot and shutdown]]
 +  * [[Disk usage]]
 +  * [[data_cleansing_tool|Data cleansing tool]]
 +  * [[About page]]
  
  
Line 33: Line 43:
 ===== Interfacing external devices and data acquisition ===== ===== Interfacing external devices and data acquisition =====
   * [[Connections]]   * [[Connections]]
 +    * [[Supported protocols]]
 +    * [[WebHMI internal registers]]
 +    * [[Custom protocols]]
 +    * [[Connection of additional RS-232/422/485 ports]] 
 +    * [[Examples of WebHMI connections to various devices]]
   * [[Registers]]   * [[Registers]]
-  * [[WebHMI internal registers]] +  * [[On-demand registers]]
-  * [[Supported protocols]] +
-  * [[Custom protocols]] +
-  * [[Examples of WebHMI connections to various devices]] +
-  * [[Connection of additional RS-232/422/485 ports]] +
   * [[Events]]   * [[Events]]
   * [[Alerts]]   * [[Alerts]]
-  * [[Performance of data exchange]] 
-  * [[On-demand registers]] 
  
-===== Programming WebHMI ===== + 
-  * [[Introduction to Lua programming]] +
-  * [[Scripts editor]] +
-  * [[Get access to registers]] +
-  * [[Write to logs]] +
-  * [[Key-value storage]] +
-  * [[Send notifications]] +
-  * [[Get weather conditions and forecast]] +
-  * [[Control connections]] +
-  * [[Check network status]] +
-  * [[Working with recipes]] +
-  * [[Functions to manage energy/resources consumption]] +
-  * [[Current alerts]] +
-  * [[/lua_cjson|JSON support]] +
-  * [[Custom libraries]] +
-  * [[integration_with_other_systems | HTTP requests]]+
  
 ===== Data visualisation ===== ===== Data visualisation =====
   * [[Screens]]   * [[Screens]]
 +  * [[screencast|Screencasts]]
   * [[Dashboards]]   * [[Dashboards]]
 +    * [[Dashboard templates]]
 +    * [[Dashboard Import and Export]]
 +    * [[Image library]]
 +    * [[Video streams]]
   * [[context_menus|Context menus]]   * [[context_menus|Context menus]]
-  * [[Dashboard templates]] 
-  * [[Dashboard Import and Export]] 
   * [[Trends]]   * [[Trends]]
   * [[Historical graphs]]   * [[Historical graphs]]
-  * [[Custom graphs/trends |Custom graphs/trends/diagrams]] 
   * [[Registers log]]   * [[Registers log]]
 +
 +===== Analytics tools =====
 +
 +  * [[Custom graphs/trends |Custom graphs/trends/diagrams]]
 +  * [[resource_local_tool | Resource meters anaylytics tool]]
 +  * [[Raw values]]
 +  * [[User actions]]
 +
 +
 +
  
 ===== Control ===== ===== Control =====
 +  * [[programming_webhmi | Programming WebHMI in Lua]]
   * [[Calendar]]   * [[Calendar]]
   * [[Recipes]]   * [[Recipes]]
-  +  * [[Curves]]
-===== Export data to Level2 cloud system ===== +
-Level2 is a system that allows you to combine many WebHMIs into a single supervisory system. Also, on the basis of this system, additional services are provided to WebHMI users: sending SMS, emails, Telegram messages, VPN, HTTP Proxy and others. +
- +
-  * [[Introduction to Level2]] +
-  * [[How to connect WebHMI to Level2]] +
-  * [[Remote access to WebHMI UI]] +
-  * [[Send collected data to Level2]] +
-  * [[Show multiple objects on map]] +
-  * [[Building graphs in Level2]] +
-  * [[Creating advanced reports in Level2]] +
-  * [[Setup resource meters and resources consumption analysis]] +
-  * [[Analysis of the costs of resource usage]] +
-  * [[Temperature-dependent resource consumption analysis]] +
-  * [[Compare resource consumptions of two objects]] +
-  * [[Control system behaviour based on holidays, weekends, working days]] +
-  * [[Control consumption limits]] +
-  * [[Check resource meter readings]] +
-  * [[Send SMS via Level2]] +
-  * [[Send E-mails via Level2]] +
-  * [[Send Telegram messages via Level2]] +
-  * [[Send Viber messages via Level2]] +
-  * [[Remote service access to equipment]] +
-  * [[Communication between 2 WebHMIs via internet]] +
-  * [[Billing, rates, transfer money between account, vouchers]]+
  
 ===== Advanced functions ===== ===== Advanced functions =====
   * [[Remote service access]]   * [[Remote service access]]
-  * [[Sending SMS via GSM modem]] 
   * [[Virtual UART]]   * [[Virtual UART]]
   * [[Integration with other systems]]   * [[Integration with other systems]]
  
-===== Internet of Things (IoT) =====+===== Getting access to the collected data ===== 
 + 
 +  * [[Modbus TCP Server]]  
 +  * [[ftp_server |Accessing data via FTP server]] 
 +  * [[Access via API | API reference guide]] 
 + 
 + 
 + 
 +===== Tips & Tricks ===== 
 + 
 +  * [[app_notes | Application notes]] 
 +  * [[Useful programs]] 
 +  * [[performance_optimization | Optimizing performance & fine tuning your system]] 
 +  * [[backing_up_your_data|Backing up your data]] 
 +  * [[Debugging complex programs]] 
 + 
 +===== Troubleshooting & FAQ ===== 
 + 
 +  * [[support_page|Quick support right from the WebHMI]] 
 +  * [[Error indication]] 
 +  * [[Troubleshooting FAQ |Troubleshooting]] 
 +  * [[faq| FAQ]] 
 +{{ :level2:level2_logo_.png?direct&150|}} 
 +====== Level2 cloud system ====== 
 + 
 +---- 
 +===== Introduction  ===== 
 + 
 +Level2 is a system that allows you to combine many WebHMIs and other compatible devices into a single supervisory & management system. Also, on the basis of this system, additional services are provided: remote access, data collection, notification options, reports etc. 
 + 
 +  * [[level2:introduction_to_level2 | Introduction to Level2]] 
 +  * [[l2_functions_overview|Level2 quick overview]] 
 +  * [[level2:how_to_connect_webhmi_to_level2 | How to connect WebHMI to Level2]] 
 +  * [[connect_iot_device_to_L2|How to connect IoT devices with MQTT to the Level2]] 
 + 
 + 
 + 
 +===== Nodes setups for using services ===== 
 + 
 + 
 +  * [[webhmi_l2_setup|WebHMI node setup]] 
 +  * [[setting up an IoT node|Setting up an IoT node]] 
 + 
 +===== Remote access functions ===== 
 + 
 +  * [[level2:remote_access_to_webhmi_ui | Remote access to WebHMI UI]] 
 +  * [[remote_service_access| Remote service access to equipment]] 
 +  * [[level2:communication_between_2_webhmis_via_internet | Communication between 2 WebHMIs via internet]] 
 + 
 +===== Collecting data on Level2 ===== 
 + 
 +  * [[level2:send_collected_data_to_level2 | Send collected data to Level2]] 
 +  * [[level2:building_graphs_in_level2 | Building graphs in Level2]] 
 +===== Visualization ===== 
 + 
 +  * [[l2_screens|Creating screens in the Level2 system]] 
 + 
 +===== Maps ===== 
 + 
 +  * [[level2:show_multiple_objects_on_map | Show multiple objects on a map]] 
 + 
 + 
 + 
 +===== Reports ===== 
 + 
 +  * [[level2:creating_advanced_reports_in_level2 | Creating advanced reports in Level2]] 
 +  * [[level2:setup_resource_meters_and_resources_consumption_analysis | Setup resource meters and resources consumption analysis]] 
 +  * [[level2:analysis_of_the_costs_of_resource_usage | Analysis of the costs of resource usage]] 
 +  * [[level2:temperature-dependent_resource_consumption_analysis |Temperature-dependent resource consumption analysis]] 
 +  * [[level2:compare_resource_consumptions_of_two_objects | Compare resource consumptions of two objects]] 
 +  * [[level2:check_resource_meter_readings|Check resource meter readings]] 
 + 
 +===== Delivering higher level logic for the nodes ===== 
 + 
 +  * [[level2:control_system_behaviour_based_on_holidays_weekends_working_days | Control system behaviour based on holidays weekends working days]] 
 +  * [[level2:control_consumption_limits|Control consumption limits]] 
 +  * [[get_weather_conditions_and_forecast|Weather - dependent logic]] 
 + 
 + 
 +===== Notification services ===== 
 + 
 + 
 +  * [[level2:send_telegram_messages_via_level2| Sending Telegram messages from WebHMI with Lua functions]] 
 +  * [[iot_register_telegram_option|Sending Telegram messages using IoT Device register settings]] 
 +  * [[level2:send_e-mails_via_level2 | Send_e-mails via Level2]] 
 +  * [[level2:send_sms_via_level2| Send sms via Level2]] 
 + 
 +===== User management ===== 
 + 
 +  *[[Level2 users management|Level2 user management]] 
 + 
 +===== Accounting ===== 
 + 
 +  * [[Billing, rates, transfer money between account, vouchers | Billing, rates, transfer money between account, vouchers]] 
 + 
 + 
 + 
 +====== Internet of Things (IoT) =====
 + 
 +---- 
 ==== Tutorials ==== ==== Tutorials ====
   * [[iot|Industrial Internet of Things (IIoT)]]   * [[iot|Industrial Internet of Things (IIoT)]]
-  * [[iot:aws-integration|Amazon Web Services (AWS) Intergration]] +  * [[iot:tutorial:mqtt|MQTT]] 
-==== IoT ==== +    * [[:level2:lvl2_broker#mqtt_broker| Level2 IoT Core]] 
-  * [[:iot:mqtt|MQTT]] +    * [[:iot:tutorial:mqtt#mqtt_using_webhmi|MQTT using WebHMI]] 
-==== AWS ==== +      * [[:iot:tutorial:mqtt#webhmi_as_mqtt_broker|WebHMI as MQTT Broker]]  
-  * **[[:iot:aws:integration-scope|Amazon Web Services WebHMI useful applications overview]]**\\  +      * [[:iot:tutorial:mqtt#webhmi_as_mqtt_publisher_client|WebHMI as MQTT Publisher (Client)]]  
 +        * [[:iot:tutorial:mqtt#connect_to_webhmi_mqtt_broker_with_external_client|Connect to WebHMI MQTT Broker with external client]]  
 +          * [[:iot:tutorial:mqtt#publish_to_webhmi_from_the_same_or_another_webhmi|Publish to WebHMI from (the same or another) WebHMI]] 
 +          * [[:iot:tutorial:mqtt#from_android_client_to_webhmi|From Android client to WebHMI]] 
 +  * [[:iot:tutorial:aws-integration|Amazon Web Services (AWS) Integration]] 
 + 
 + 
 +==== Amazon Web Services ==== 
 +  * **[[iot:aws:integration-review|AWS WebHMI useful applications overview]]**\\   
 +  * [[:iot:tutorial:aws-integration|AWS WebHMI Integration tutorial]]
  
-  * [[:iot:aws:json|Amazon Web Services JSON format]] 
-  * [[:iot:aws:integration|Amazon Web Services WebHMI Integration]] 
  
 ==== WebHMI Amazon Web Services Integration ==== ==== WebHMI Amazon Web Services Integration ====
   * [[:iot:aws:config:iot-core|AWS IoT Core configuration]]   * [[:iot:aws:config:iot-core|AWS IoT Core configuration]]
   * [[:iot:aws:config:webhmi|WebHMI configuration for AWS IoT Core]]   * [[:iot:aws:config:webhmi|WebHMI configuration for AWS IoT Core]]
 +  * [[:iot:aws:json|AWS JSON format]]
  
  
-===== Get access to collected data ===== 
  
-  * [[Modbus TCP Server]]  
-  * [[Accessing data via FTP]] 
-  * [[Access via API]] 
-    *[[access_via_api#connection_list|Connection list]]  
-    *[[access_via_api#register_list|Register list]] 
-    *[[access_via_api#getting_register_log|Getting register log]] 
-    *[[access_via_api#getting_current_registers_values|Getting current registers values]] 
-    *[[access_via_api#writing_a_new_value_into_a_register|Writing a new value into a register]] 
-    *[[access_via_api#list_of_dictionaries|List of dictionaries]] 
-    *[[access_via_api#trend_list|Trend list]] 
-    *[[access_via_api#graph_list|Graph list]] 
-    *[[access_via_api#image_list|Image list]] 
-    *[[access_via_api#getting_graph_data|Getting graph data]] 
-    *[[access_via_api#event_list|Event list]] 
-    *[[access_via_api#getting_data_for_events|Getting data for events]] 
-    *[[access_via_api#getting_local_time_data|Getting local time data]] 
-    *[[access_via_api#dashboard_list|Dashboard list]] 
-    *[[access_via_api#list_of_dashboard_s_blocks|List of dashboard's blocks]] 
-    *[[access_via_api#managing_recipes_list|Managing recipe list]] 
-  * [[Example of data access from Excel]] 
-  * [[Example of data access from C/C++]] 
-  * [[Android demo application]] 
  
-===== Maintenance ===== 
-  * [[About page]] 
-  * [[Reboot and shutdown]] 
-  * [[Disk usage]] 
-  * [[Firmware upgrade]] 
-===== Tips & Tricks ===== 
  
-  * [[Useful programs]] 
-  * [[Debugging complex programs]] 
  
  
-===== Troubleshooting ===== 
- 
-  * [[Error indication]] 
-  * [[Troubleshooting FAQ |Troubleshooting FAQ ]] 
  
  
  
start.1591959175.txt.gz · Last modified: 2020/06/12 10:52 by atolstov

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki