• It is a gateway between XBee® ZigBee and TCP network for BUTLER smart house framework.
• Gateway extracts data from XBee® ZigBee frames and sends to the TCP Server.
• Gateway maintains separate TCP connection for each XBee® ZigBee device.

In default configuration/example:

• Gateway assumes that sensor uses MQTT protocol over XBee® ZigBee.
• MQTT traffic is routed to TCP socket of the configured MQTT Broker.
• Arduino board is used as sensor (See https://github.com/monstrenyatko/butler-arduino-sensor)

Usually microcontrollers like Arduino doesn't have network stack. If you use a MQTT library to communicate with broker you still need network stack. The only way to communicate with world is a Serial. Serial is simple and really popular. A lot of RF modules do work via Serial interface. Unfortunately on other side you get Serial as well in case of XBee® ZigBee. MQTT broker doesn't support Serial connection directly and we need to pack data from Serial to TCP:
      Arduino --> Serial --> RF <---z---> RF --> Serial --> xbee-gateway --> TCP --> MQTT Broker

• Connect XBee® ZigBee Coordinator to PC where the application is installed.
• Launch the application.
• Do not forget to power ON all nodes with XBee® ZigBee wireless interfaces.

• Install XCTU.
• Use XCTU for installing the firmware to the XBee® devices.
• XBee® ZigBee network must have only one Coordinator.
• XBee® ZigBee Coordinator must be connected to the PC were you plan to run the application.
• All other devices in the network must be XBee® ZigBee End Device or XBee® ZigBee Router.

• Coordinator must have the firmware with ZigBee Coordinator API functional set.
• Use XCTU to set AP (API mode) option to 0x2 (escapes).
• Use XCTU to set BD (Baud Rate) to 57600.

• Devices must have the firmware with ZigBee End Device or ZigBee Router functional set.
• Use XCTU to set PAN ID. It must be equal with Coordinator.
• Use XCTU to set DH and DL to 0x0 (send data to Coordinator).

Install Cmake with version 2.8 or later.

Install the compiler with C++11 support.

Install Boost libraries with version 1.45 or later.

• Create a build directory for out of source compilation:

mkdir <build directory>

• Go to the build directory:

cd <build directory>

• Use Cmake to prepare the build:

cmake <path to sources>

• Use make to start the build process:

make

• The resulting binary file is located in <build directory>/bin/

• Create a build directory for out of source compilation:

mkdir <build directory>

• Go to the build directory:

cd <build directory>

• Use cmake to prepare the build:

cmake -G"Eclipse CDT4 - Unix Makefiles" -D CMAKE_BUILD_TYPE=Debug <path to sources>

• Import the project from the build directory (File -> Import -> General -> Existing Projects into Workspace)
• Use Project -> Build Project to start the build process

• Pull pre built Docker image of the cross compiler :

docker pull monstrenyatko/docker-rpi-cross-compiler

• Create a build directory for out of source compilation:

mkdir <build directory>

• Go to the build directory:

cd <build directory>

• Use script to build deb package:

<path to sources>/build/docker_raspberrypi/build.sh <path to sources>

• The resulting deb file is located in <build directory>

Configuration file is done in JSON format.

{
	"logger":{
		"level":"INFO"
	},
	"serial":{
		"name":"/dev/usbserial",
		"baud": 57600
	},
	"tcp":{
		"address":"test.mosquitto.org",
		"port": 1883
	}
}

Application logger settings.

logger

Set verbose level.

Path to logfile like "/var/log/my.log".

Serial port settings.

serial

Path to serial port device like "/dev/usbserial".

Serial port baud rate like 57600.

TCP connection settings.

tcp

Server address like "test.mosquitto.org"

Server port like 1883