The Waher.IoTGateway.Svc is a Windows service version of the IoT Gateway. It uses XMPP and can be administered using the Waher.Client.WPF application.
The service application requires XMPP credentials to be stored in the xmpp.config file. If installed using
the IoT Gateway installer, the files will be written to the Program Data
folder IoT Gateway, and the xmpp.config file will be generated automatically. Otherwise, you can use the
Waher.IoTGateway.Console project to create an xmpp.config file, or write one manually.
The IoT Gateway contains an integrated web server. It can be used to host any web content under the Root folder.
Markdown content (files with extensions .md or .markdown) will
automatically be converted to HTML if viewed by a browser. To retrieve the markdown file as-is, make sure the HTTP GET method includes
Accept: text/markdown in its header.
If you want to allow the gateway to have access to the HTTP (80) and HTTPS (443) ports, you might need to disable any web server or service running on the machine, or tell them to use different ports. This includes the HTTP Server API, (http.sys), if it is running on the machine, or any other application that has these ports open, like Skype.
If running the application under Linux, you also need administrative privileges when you execute the application, to it to be able to open these ports.
On my Windows 8.1 machine, the following, taken from the article above, entred into a command prompt having administrator privileges, and then restarting the machine, shut down the
http.sysservice.net stop http /y sc config http start= disabledI also had to manually configure Skype to not use HTTP and HTTPS ports for incoming calls.
Note: If using the IoT Gateway installer to install the application, the above is done as part of the installation.
The IoT Gateway supports pluggable modules. All modules found in the binary folder of the gateway are loaded at startup. Each class
implementing the Waher.Script.IModule interface will be informed correspondingly when the server is started and stopped. The
Waher.Script.Types class contains static methods for accessing module parameters. These are used to pass information from the server
to each module. There are different module parameters defined by the IoT Gateway:
| Name | Description |
|---|---|
AppData |
Where the IoT Gateway application data folder is situated. |
CoAP |
CoapEndpoint object managing the local CoAP endpoint of the gateway, as well as acting CoAP client for accessing CoAP devices. |
Control |
ControlServer object, publishing a XMPP IoT Control Server interface on the XMPP network. |
Concentrator |
ConcentratorServer object, publishing a XMPP IoT Concentrator Server interface on the XMPP network. |
HTTP |
HttpServer object hosting the web server. |
HTTPX |
HttpxProxy object providing httpx support to web clients. |
HTTPXS |
HttpxServer object providing httpx support to web servers. |
IBB |
IbbClient object providing In-band Bytestream support to the XMPP connection. |
Root |
Where the IoT Gateway web folder is situated. All content in this folder, including subfolders, is accessible through the web interface. |
Sensor |
SensorServer object, publishing a XMPP IoT Sensor Server interface on the XMPP network. |
| `SOCKS5 | Socks5Proxy object managing SOCKS5 stream negotiations over XMPP. |
XMPP |
XmppClient object managing the XMPP connection of the gateway. |
The IoT Gateway hosts an encrypted object database based on the Waher.Persistence.Files library, via interfaces provided by the
Waher.Persistence library. It can be replaced by MongoDB, by using the Waher.Persistence.MongoDB
library instead. Since all interaction with the object database goes through Waher.Persistence, it is easy to port the gateway to other object
database providers, without having to update code in all pluggable modules.
You can also install the service using the IoT Gateway installer.
You should carefully read the following terms and conditions before using this software. Your use of this software indicates your acceptance of this license agreement and warranty. If you do not agree with the terms of this license, or if the terms of this license contradict with your local laws, you must remove any files from the IoT Gateway from your storage devices and cease to use it. The terms of this license are subjects of changes in future versions of the IoT Gateway.
You may not use, copy, emulate, clone, rent, lease, sell, modify, decompile, disassemble, otherwise reverse engineer, or transfer the licensed program, or any subset of the licensed program, except as provided for in this agreement. Any such unauthorised use shall result in immediate and automatic termination of this license and may result in criminal and/or civil prosecution.
The source code provided in this project is provided open for the following uses:
-
For Personal evaluation. Personal evaluation means evaluating the code, its libraries and underlying technologies, including learning about underlying technologies.
-
For Academic use. If you want to use the following code for academic use, all you need to do is to inform the author of who you are, what academic institution you work for (or study for), and in what projects you intend to use the code. All I ask in return is for an acknowledgement and visible attribution to this project, inluding a link, and that you do not redistribute the source code, or parts thereof in the solutions you develop. Any solutions developed for academic use, that become commercial, require a commercial license.
-
For Security analysis. If you perform any security analysis on the code, to see what security aspects the code might have, all I ask is that you inform me of any findings so that any vulnerabilities might be addressed. I am thankful for any such contributions, and will acknowledge them.
Commercial use of the code, in part or in full, in compiled binary form, or its source code, requires a Commercial License. Contact the author for details.
All rights to the source code are reserved and exclusively owned by Waher Data AB. Any contributions made to the project become the intellectual property of Waher Data AB. If you're interested in using the source code, as a whole, or in part, you need a license agreement with the author. You can contact him through LinkedIn.
This software is provided by the copyright holder and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.
The IoT Gateway is © Waher Data AB 2016-2017. All rights reserved.
