|
|
| Line 1: |
Line 1: |
| − | == Purpose ==
| + | Welcome to the Datonis Edge Gateway documentation. |
| − | This document describes the procedure to employ the revised Datonis Edge Gateway in your environment.
| |
| | | | |
| − | == System Requirements ==
| + | Please refer links below: |
| − | | + | * [[Datonis:Edge Gateway Builds|Latest Builds]] |
| − | === Operating System ===
| + | * [[Datonis:Edge Gateway Installation and Basic Configuration|Installation and Basic Configuration]] |
| − | The Datonis Gateway is certified to run on:
| |
| − | * Windows 7 or above
| |
| − | * Linux 3.x kernel or above
| |
| − | | |
| − | === Supported Protocols ===
| |
| − | * http (80)
| |
| − | * https (443)
| |
| − | * mqtt (1883)
| |
| − | * mqtts (8883)
| |
| − | | |
| − | === Internet Connectivity ===
| |
| − | Internet connectivity is required so that the gateway can do outbound connections to either of the ports (80 - http, 443 - https, 1883 - mqtt, 8883 - mqtts).
| |
| − | | |
| − | For http/https, you can also configure a http proxy if there is no direct internet connectivity available.
| |
| − | | |
| − | === Java ===
| |
| − | Gateway needs Java 1.8 or higher to work. Please download from Oracle site.
| |
| − | | |
| − | == Supported Environments ==
| |
| − | The Datonis Gateway supports following environments (via configurable adapters) to collect data and push it to the Altizon’s Datonis Platform.
| |
| − | | |
| − | === OPC UA ===
| |
| − | This adapter can be used to point to a OPC UA server either running alongside the gateway on the same machine or on a different machine on the LAN.
| |
| − | | |
| − | Detailed instructions are provided in the OPC UA configuration page. Certified OPC UA servers include: Kepware OPC UA server, Beckhoff Twincat
| |
| − | | |
| − | === OPC DA Utgard (DCOM connectivity) ===
| |
| − | This adapter can be used to point to a OPC DA server either running alongside the gateway on the same machine or on a different machine on the LAN.
| |
| − | | |
| − | Detailed instructions are provided in the OPC DA Utgard configuration page. Certified OPC DA servers include: Matrikon, Kepware, Proface, Acromag
| |
| − | | |
| − | === OPC DA NGP (NGP connectivity) ===
| |
| − | This adapter can be used to point to a OPC DA server either running alongside the gateway on the same machine or on a different machine on the LAN.
| |
| − | | |
| − | Detailed instructions are provided in the OPC DA NGP configuration page.
| |
| − | | |
| − | === MTConnect Agent ===
| |
| − | Data can be queried from MTConnect agents that expose a XML based interface. Detailed instructions are provided in MTConnect Agent configuration page.
| |
| − | | |
| − | === Modbus TCP ===
| |
| − | This adapter can be used to read data from a number of Modbus devices using TCP. Detailed instructions are provided in the Modbus TCP configuration page.
| |
| − | | |
| − | === HttpListener Mode ===
| |
| − | This adapter can be used to post data to the Gateway Server via Http or Https. Detailed instructions are provided in the HttpListener configuration page.
| |
| − | | |
| − | == Package Structure ==
| |
| − | | |
| − | === Before Install ===
| |
| − | kura
| |
| − | |--- bin
| |
| − | |--- commons-daemon-1.0.15
| |
| − | |--- scripts
| |
| − | |--- config
| |
| − | |--- plugins
| |
| − | |--- altizon
| |
| − | |--- common
| |
| − | |--- equinox_3.8.1
| |
| − | |--- kura
| |
| − | * '''bin''' directory contains all the scripts required to install/run the datonis gateway. '''install_aliot_service.bat''' will install gateway as a windows service. '''uninstall_aliot_service.bat''' will uninstall windows service, note that it does not delete copied files.
| |
| − | * config directory contains initial configuration of IoT gateway, these config files will be copied and modified in various directories during installation. Gateway will refer to the copied files further. You may not need to update any configuration as configuration changes can be done via browser UI. '''log4j.properties''' where logging of the gateway can be controlled.
| |
| − | * plugins directory contain all the plugin jars required for gateway to run
| |
| − | | |
| − | === After Install ===
| |
| − | kura
| |
| − | |--- bin
| |
| − | |--- config
| |
| − | |--- plugins
| |
| − | |--- data
| |
| − | |--- db
| |
| − | |--- keystore
| |
| − | |--- paho-persistence
| |
| − | |--- snapshots
| |
| − | |--- tmp
| |
| − | |--- log
| |
| − | |--- packages
| |
| − | * '''data''' directory contains the application database (db), saved configurations (snapshots), ssl configurations (keystore) and transport data (paho-persistence)
| |
| − | * '''log''' directory contains gateway logs and service logs
| |
| − | * '''tmp''' directory contains the modfied config files that are specific to the current installation, this directory will be used by running gateway to refer to initial configuration
| |
| − | * '''packages''' directory holds the runtime plugin packages installed via console ui
| |
| − | | |
| − | == Installation ==
| |
| − | | |
| − | === Windows ===
| |
| − | On windows, below scripts are present in the bin directory
| |
| − | | |
| − | ==== install_aliot_service.bat ====
| |
| − | Runnning this batch file will install gateway as Windows service that will have automatic start-up and will run in the context of localsystem account. The name of the installed service is AliotGateway (display name: Aliot IoT Gateway)
| |
| − | | |
| − | ==== uninstall_aliot_service.bat ====
| |
| − | Running this batch file will stop and uninstall AliotGateway service.
| |
| − | | |
| − | ==== start_aliot_debug.bat ====
| |
| − | This batch file will start gateway as a console OSGi application where debug commands can be sent to OSGi console to check which plugins are loaded.
| |
| − | | |
| − | ==== stop_aliot_debug.bat ====
| |
| − | This batch file will kill gateway service and should be used in rare circumstances. Windows service can be stopped from Service Manager application (services.msc). Console application can be stopped by typing Ctrl+C in the application window or typing Close command.
| |
| − | | |
| − | === Linux ===
| |
| − | On linux, below bash scripts are present in bin directory
| |
| − | | |
| − | ==== install_aliot_service.sh ====
| |
| − | This sh script will start gateway as a linux service. The service will run in context of root user. Java must be installed on that system in root context. The name of the installed service is kura-gateway.
| |
| − | | |
| − | ==== uninstall_aliot_service.sh ====
| |
| − | Running this script will stop and uninstall kura-gateway service
| |
| − | | |
| − | ==== start_gateway_service.sh ====
| |
| − | This will start installed kura-gateway service.
| |
| − | | |
| − | ==== stop_gateway_service.sh ====
| |
| − | This will stop kura-gateway background service
| |
| − | | |
| − | ==== start_aliot_debug.sh ====
| |
| − | This script will start gateway as a console OSGI application, where user can interact with OSGI console for advanced activities.
| |
| − | | |
| − | ==== stop_aliot_debug.sh ====
| |
| − | This script will send kill signal to running gateway application. User can stop OSGI console application by using CTRL+C in terminal. This script provide same mechanism for background tasks.
| |
| − | | |
| − | == Gateway Configuration ==
| |
| − | After installation Gateway Configuration can be accessed via '''https://127.0.0.1:8443/kura''' or '''[http://127.0.0.1:8080/ http://127.0.0.1:8080][http://127.0.0.1:8080/kura /kura]'''
| |
| − | | |
| − | === Changing Web Console Credentials ===
| |
| − | The default console username and password are '''admin/admin'''. This can be changed via '''Services → Web Console''' settings.
| |
| − | [[File:web-console.png]] | |
| − | | |
| − | === Changing Access Key and Secret Key ===
| |
| − | The gateway requires access key and secret key in order to connect to Datonis platform. These keys can be changed via '''Cloud Services → AliotGatewayService''' Service settings.
| |
| − | [[File:aliot-gateway-service.png]]
| |
| − | | |
| − | === Changing Transport Mechanism and Data Service Settings ===
| |
| − | By default gateway will send data using secure Mqtt transport which is recommended. The transport can be changed to Http via turning on setting '''connect.use-http-transport''' found at '''Cloud Services → AliotDataService'''.
| |
| − | Other AliotDataService related settings are self documented and need to be changed in rare cases.
| |
| − | [[File:aliot-data-service.png]] | |
| − | | |
| − | === Using Http Proxy to connect to Datonis ===
| |
| − | If Http Transport is selected to communicate with Datonis then its possible to use Http Proxy for Datonis Platform connectivity. Setting '''use-proxy''' has to be enabled and other '''proxy.'''* settings need to have appropriate values.
| |
| − | These settings can be accessed via '''Cloud Services → HttpDataTransport'''.
| |
| − | | |
| − | [[File:http-data-transport.png]]
| |
| − | | |
| − | === Device Tab ===
| |
| − | This tab shows information about Gateway Runtime and underlying device info.
| |
| − | ** '''Profile''' - lists Device information, Hardware information, Software information and Java details.
| |
| − | ** '''Bundles''' - lists OSGi bundles loaded by the gateway at that time
| |
| − | ** '''Threads''' - lists threads consumed by gateway
| |
| − | ** '''System Properties''' - lists configuration parameters of gateway jvm
| |
| − | ** '''Command''' - for future use
| |
| − | | |
| − | [[File:device.png]]
| |
| − | | |
| − | === Settings Tab ===
| |
| − | This tab allows to set system wide settings
| |
| − | * '''Snapshots''' - this page allows to download currently applied configuration to the system in a single xml file. This also provides the facility to rollback, upload and apply kind of functionality. The '''Upload and Apply''' is particularly useful in case of upgrade or moving installation to some other directory.
| |
| − | * '''SSL Configuration''' - this page allows details out the certificate store path used by the gateway. The default keystore password is '''changeit'''. This can be changed if needed. This certificate store (keystore) will store Server SSL certificate and Device SSL certificate.
| |
| − | * '''Server SSL Certificate''' - this is a public certificate that will be stored as the trusted certificate. This certificate details needs to be in rfc text format i.e. '''pem file format'''.
| |
| − | * '''Device SSL Certificate''' - the device SSL certificate is private public key pair of the gateway certificate. In adapter communication where mutual authentication is needed the required certificate with private key can be installed from this page. The Private Key and Certificate text has to be in pem file format.
| |
| − | | |
| − | [[File:settings.png]]
| |
| − | | |
| − | === Other Settings ===
| |
| − | * The '''Status''' denotes whether Datonis Platform is accessible via selected transport i.e. Mqtt or Http. Note that at present, this does not check whether valid access and secret key has been entered or not.
| |
| − | * The '''Packages''' tab allows to deploy custom bundles/plugins in the gateway e.g. any third party adapter.
| |
| − | | |
| − | == Adapter Configuration ==
| |
| − | Refer to Adapter Common Configuration Page for more details
| |
Welcome to the Datonis Edge Gateway documentation.
