ESP8266 based Aptinex IOT modules are the first IOT related device manufactured by Aptinex along with many other oncoming IOT devices. The main objective of Team Aptinex in designing this was to ease the controlling applications related to smart home, lighting etc. This unit is based on famous wifi module ESP8266 and is having a pre-flashed firmware which enables users to controll Relays/Triacs/SSRs and changing settings

This document only contains the software capabilities of the modules please visit each product pages for detailed hardware specifications.

• 1 – Firmware Features
  • 1.1 Web UI
  • 1.2 HTTP Server (REST API)
  • 1.3 WebSocket Server
  • 1.4 Authentication
  • 1.5 MQTT Client
  • 1.6 Alexa Support
  • 1.7 Button Functions
  • 1.8 Default Values
• 2 – GPIO MAP
• 3 – Change Log

1.2 HTTP Server (REST API)

This section of the document describes the REST API and resources provided by the module. The REST APIs are for developers who want to integrate the module into their applications.

These REST API enpoints provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE.

Because the REST API is based on open standards, you can use any web development language to access the API.

$.ajax({url: "/session",dataType: "json",type: "GET",success: function(r) {console.log(r);}});

$.ajax({url: "/set?gpio=15&value=1",dataType: "json",type: "GET",success: function(r) {console.log(r);}});

$.ajax({url: "http://192.168.1.22/get",dataType: "json",type: "GET",success: function(r) {console.log(r);}});

$.ajax({url: "http://192.168.1.222/login?user=admin&pass=admin",dataType: "json",type: "GET",success: function(r) {console.log(r);}});

$.ajax({url: "http://192.168.1.222/login?admin=admin",dataType: "json",type : "GET",success : function(r) {console.log(r);}});

$.ajax({url: "http://192.168.1.22/logout",dataType: "json",type: "GET",success: function(r) {console.log(r);}});

$.ajax({url: "http://192.168.1.22/token",dataType: "json",type : "GET",success : function(r) {console.log(r);}});

$.ajax({url: "http://192.168.1.22/token",dataType: "json",type : "DELETE",success : function(r) {console.log(r);}});

$.ajax({
 url: "http://192.168.1.22/config.json",
 dataType: "json",
 type : "DELETE",
 success : function(r) {
console.log(r);
}
});

Aptinex IOT modules provide a token based authentification schema in both HTTP & WebSocket services. Authentification feature is enabled by default and can be enabled via HTTPServer/WebUI. There are two types of tokens available in the device.

• Volatile token – token is generated/reset at each successful user login event (HTTPServer) and the token is discarded after the power cycle.
• Non-volatile token – non-volatile token is useful when the device to be controlled via custom applications. The non-volatile token can be generated/reset via HTTPServer/WebUI

• Factory Reset: Hold down the BUTTON_S2 for more than 20 seconds to factory reset the device. 
• Restart:  Hold down the BUTTON_S2
  between 50 milliseconds and 1 second to factory restart the device.

Following table contains the default values of the device parameters.