Prerequisites
Before running your first application, you must ensure that you have the minimum set of required tools and components:
- Toolchain for your specific microcontroller.
- Development board.
- µC/TCP-IP stack must be installed properly (a running project). See Installing the µC/TCP-IP Stack for further details on how to install µC/TCP-IP.
- Source code for µC/MQTT-client.
Additional Modules
µC/MQTT-client depends on other modules to run. It requires the presence of an RTOS, the modules for µC/CPU, µC/LIB, µC/Common and µC/TCP-IP.
If you are using one of the two Micriµm OS's, complete documentation can be found for µC/OS-II and µC/OS-III. Refer to those guides for more information on requirements, installation, configuration and running of each RTOS.
The µC/CPU module regroups the processor's hardware-dependent code. It includes ports for the many CPU architectures Micriµm supports. Therefore, you must use the port corresponding to your specific CPU.
The µC/LIB module is Micriµm's run-time library, implementing the most common standard library functions, macros, and constants.
The µC/TCP-IP stack is a compact, reliable, high-performance TCP/IP protocol stack which provides the socket for the MQTT application layer.
µC/Common regroups modules used commonly by all the Micrium products. It must therefore also be included in your project.
Downloading the Source Code
µC/MQTT-client can be downloaded from the Micrium customer portal along with the other required modules. The distribution package includes the full source code and documentation.
Depending on how you purchased our software, as a package or individual components, you can find uC/MQTT-client's source code with the µC/TCP-IP package or download it separately from the customer portal, respectively.
You can log into the Micrium customer portal from the address below to begin your download (you must have a valid license to gain access to the file):
Installing the Files
Once all the distribution packages have been downloaded to your host machine, extract all the files to your computer (for instance, at the root of your C:\ drive). The package may be extracted to any location. After extracting all the files, the directory structure should look as illustrated below in Figure - MQTT-client Folder Tree. In the example, all Micriµm products sub-folders will be located in C:\Micrium\Software\. The Micriµm µC/OS-III RTOS has been chosen for this example.
