Page Comparison

You can create custom applications (apps), drivers, services, and web pages for the SmartServer. The APIs can also be used by a remote server (like a cloud server) to access the SmartServer. Your custom software can provide a custom service on the SmartServer, can provide an interface to other IoT services external to the SmartServer, or can provide an interface to IoT devices external to the SmartServer that do not use one of the protocols supported by the SmartServer.  Your custom software can also be implemented as custom web pages that interact with the SmartServer using the REST protocol.

...

• IAP/MQ – The IAP/MQ API is based on the MQTT messaging protocol.  MQTT is an ISO standard (ISO/IEC PRF 20922) publish-subscribe-based messaging protocol. It works on top of a TCP connection over an IP network. It is a lightweight protocol that is suitable for implementing applications, services, and drivers on a wide range of devices and servers including small code footprint edge devices, edge servers, and cloud hosts. IAP/MQ is used to connect applications, services, and drivers within the SmartServer, and is also used to connect SmartServers to a Remote CMS, to cloud applications and services, and to each other.  Custom software can use IAP/MQ to get datapoint updates from a large number of datapoints or a for an entire site. You can subscribe to a single wildcard topic such as "glp/0/+/ev/data/#" to send all datapoint updates to your MQTT application as they occur. Your MQTT application can then filter the datapoints of interest.
  
  

• IAP/REST – The IAP/REST API is based on the REST (REpresentational State Transfer) web services protocol, sometimes called the RESTful protocol.  REST web services provide an interoperable web-standard interface for web clients such as web-page scripts running in web browsers to communicate with services hosted on web servers.  IAP/REST is typically used to connect client applications running within web-page scripts to an IAP/REST server, and can be used to implement any application supporting REST requests and responses.  The IAP/REST API is optimized for web pages that typically require a small amount of data per page.  For example, a monitoring web page may request 10 datapoint updates every two seconds.  The IAP/REST API is also preferred for scheduling applications due to additional scheduling services provided by IAP/REST that are not available in IAP/MQ.
  

  Info
  title REST URL format is SmartServer-version specific
  With SmartServer release 2.8 or higher, you do not have to specify the port number. https://<apollo_ip>/cms With SmartServer 2.7 and prior, you have to specify the port number (8443). https://<apollo_ip>:8443/cms

  
  

• IAP/WS – The IAP/WS API is based on WebSockets.  A WebSocket makes it possible to open a two-way interactive communication session between a web client such as a web browser and a server. Using a WebSocket API, a client can create a WebSocket from the server back to the client so the server can send event-driven responses to the client without the client having to poll the server for the updates.  You can use IAP/WS to get event-driven updates for device status changes, alarms, CPU usage, and current events per second (EPS).

...

Many of the topics in the Developer's Guide reference example apps, example drivers, example web pages, and the SmartServer Driver Framework.  Small examples are included inline in the following topics.  Longer examples and the SmartServer Driver Framework are available in the SmartServer IoT GitHub repository at SmartServer-IoThttps://github.com/izot/smartserver-iot.  You can download the entire repository as a ZIP archive file or you can clone the repository on your local computer.  To download a ZIP archive, click SmartServer-IoT, then click Clone or Download, and then click Download ZIP.  To clone the repository, you can use the git application or you can use a development tool such as Visual Studio Code that includes an integrated git interface.  To clone with git, open a Windows command prompt, navigate to the directory you plan to use for the repository, and then type: git clone https://github.com/izot/smartserver-iot.git .  This action copies the SmartServer IoT repository on your local drive under a smartserver-iot folder.  See help.github.com/en/articles/cloning-a-repository for more information on cloning a GitHub repository.  See code.visualstudio.com for more information on Visual Studio Code.

The following topics describe how to set up your computer for developing customer apps or drivers, provide a programming tutorial that will take you through some basic steps related to writing programs for the SmartServer IoT, describe how to develop custom apps and drivers, and describe how you can create custom web pages.

Setting Up Your Development Environment

This section describes a development environment for creating custom apps and drivers to run on the SmartServer IoT. 

General Programming Information

This section provides general information about creating applications for the SmartServer IoT.  

Programming Tutorial

This section provides a introductory tutorial for developing a custom app.  It includes:

...

This section describes how to create internal apps for the SmartServer IoT.

...

This section provides some basic information about the SmartServer IoT APIs.

...

This section helps you create custom web pages for the SmartServer IoT. 

...