MQTT Client Library

This repository contains an ISO C90 compliant MQTT client library designed for embedded platforms.

Building Unit Tests.

Prerequisites

• For building the library, CMake 3.13.0 or later and a C90 compiler.
• For running unit tests, Ruby 2.0.0 or later is additionally required for the CMock test framework (that we use).
• For running the coverage target, gcov is additionally required.

Steps to build Unit Tests

1. Go to the root directory of this repository.

2. Create build directory: mkdir build && cd build

3. Run cmake while inside build directory: cmake -S ../test/unit-test

4. Run this command to build the library and unit tests: make all

5. The generated test executables will be present in build/bin/tests folder.

6. Run ctest to execute all tests and view the test run summary.

Reference examples

The AWS IoT Embedded C-SDK repository contains demos of using the MQTT client library here on a POSIX platform. These can be used as reference examples for the library API.

Generating documentation

The Doxygen references were created using Doxygen version 1.8.20. To generate the Doxygen pages, please run the following command from the root of this repository:

doxygen docs/doxygen/config.doxyfile