Interfaces

Introduction

The interfaces are piece of code that offers additional APIs to interact with nodes with the scope of collecting data or provide run-time configuration, are intended to run over Gateway or Peer nodes. An interface that runs over a Gateway node with Persistance or LastIn mode is able to provide data for the overall network, rather a Peer or a Gateway without Persistance or LastIn can serve only the data that owns.

Setup

In order to activate an interface is enough to include the relevant configuration files before the definition of the Gateway.

File Name	Architecture	Transceiver	Description
conf/XMLinterface.h	ATmega AVR	W5x00	Control and read data in HTTP/XML format
conf/ModbusTCP.h	ATmega AVR	W5x00 / ENC28J60	Control and read data in Modbus TCP
conf/ModbusRTU.h	ATmega AVR	USART	Control and read data in Modbus RTU
conf/HTTPinterface.h	ATmega AVR	W5x00 / ENC28J60	Control only via HTTP
conf/WEBCONFinterface.h	ESP8266	ESP8266	Runtime webconfiguration

Once activated, you need to use the relevant methods into the sketch. See details in the wiki pages dedicated to each interface. Ensure that you are using a microcontroller based on the supported architecture otherwise your code will not compile.

Gateway Modes

In order to serve data from the whole network the Gateway Persistance or LastIn mode shall be enabled. Refer to the wiki page dedicated to the Interface of interest to identify the supported Gateway modes.