/
Using this Documentation

Using this Documentation

For SmartServer 4.1 and prior, see Using this Documentation (Release 4.1 and Prior).

This section describes how to access the SmartServer documentation and consists of the following:

Accessing Documentation from a Web Browser

To access the SmartServer documentation from your web browser, enter the URL https://edgedocs.enocean.com.

Accessing Documentation from the Configuration Page

To access the SmartServer documentation from the SmartServer Configuration page, click the Help tab. 

Accessing Documentation from the CMS

To access the SmartServer documentation from the CMS, click the Help button ( ) located on the SmartServer app bar.

Navigating the EnOcean Documentation Portal

When you access the SmartServer documentation from a web browser, the SmartServer Configuration page, or the CMS, the EnOcean Documentation Portal appears as shown below.

The main parts of the SmartServer documentation are described in the following table:

Topic

Description

Topic

Description

SmartServer IoT Getting Started

Provides information on how to install the SmartServer hardware, connect to your SmartServer, and how to set up your SmartServer. Optional getting started routines that are also described include migrating from i.LON servers to the SmartServer IoT and developing and adding custom applications.

SmartSupervisor Getting Started

Provides information on how to install, set up, and start using EnOcean SmartSupervisor.

SmartConnect Getting Started

Provides information on how to install, set up, and start using EnOcean SmartConnect.

SmartServer Getting Started

Provides information on how to configure the SmartServer once the initial installation and setup has been completed for SmartServer IoT, SmartSupervisor, or SmartConnect.

SmartServer User's Guide 

Provides information on site planning, site provisioning, site integration, site operation, site maintenance, and site diagnostics.

SmartServer IoT Hardware Guide

Describes the SmartServer IoT hardware and network interface modules.

SmartServer Troubleshooting

Provides information on how to troubleshoot SmartServer issues, as well as how to reboot the system and use common console commands.

SmartServer IoT Node-RED Tutorial

Comprises four classes that will help you get started using the Sequencing widget. The Sequencing widget allows SmartServer IoT CMS users to create 'sequence of operations' (also known as flows) to automate everyday processes and create instrument panels and dashboards for visualization. The Sequencing widget leverages Node-RED, an open-source, flow-based, programming tool. Node-RED provides the ability to create flows using function blocks called 'nodes' and a web-based user interface for connecting the nodes, eliminating the need to write code. A ready-to-use library of nodes allows you to quickly start creating sequences or flows that contain custom logic and/or display information on a web pages with UI elements for creating dashboards and visualization. 

SmartServer IoT Starter Kit User's Guide 

SmartServer IoT Starter Kit is used to demonstrate a multi-protocol network for SmartServer IoT learning and training purposes. This section provides an overview of the Starter Kit, its components, and how to setup the kit and integrate the components with the SmartServer IoT. 

SmartServer Developer's Guide

Provides information to help you get started with custom applications (apps), drivers, and web pages for the SmartServer with reference example apps, example drivers, example web pages, and the SmartServer Driver Framework. 

IoT Access Protocol (IAP) API Reference

The IoT Access Protocol (IAP) is an open and extensible protocol designed for the loT to provision and manage IoT devices, to access and update data from the devices, and to leverage the power of big data and AI with IoT-friendly interfaces to cloud services. This section is a reference for software developers and web-page authors. It documents two APIs:  IAP/MQ, which uses MQTT (Message Queuing Telemetry Transport) as the transport protocol, and IAP/REST, which uses REST over HTTP or HTTPS. 

 

Related content

Using this Documentation (Release 4.1 and Prior)
Using this Documentation (Release 4.1 and Prior)
More like this
Accessing the SmartServer Configuration Page (Release 3.4 to 4.1)
Accessing the SmartServer Configuration Page (Release 3.4 to 4.1)
More like this
Open the SmartServer CMS (Release 4.1 and Prior)
Open the SmartServer CMS (Release 4.1 and Prior)
More like this
Open the SmartServer IoT CMS
Open the SmartServer IoT CMS
More like this
SmartConnect Configuration Page Index
SmartConnect Configuration Page Index
More like this