The Cascoda SDK is organised to be built with CMake, which allows for natively building for Windows, Linux or macOS, as well as cross compiling for the Chili platforms.
It is expected that building the Cascoda SDK is done ‘out of source’ - that is, a separate directory to the source code is used for creating build artifacts and temporary files. This allows several different configurations to be active and buildable from the same source code, and prevents accidentally polluting the source directories and version control.
For instance, you can clone the Cascoda SDK once, and build the Windows, Chili2-USB and Chili2-UART versions in different build directories, without affecting the source, which is very convenient.
This reference details the available CMake configuration options for the Cascoda SDK. It expects that you already have build directories set up as detailed in the build guide, and are aware of how to change cmake configurations.
This list has some of the more important variables, but more are available, and their documentation can be viewed in the CMake tool (ccmake or cmake-gui) itself.
The version of the Cascoda hardware to build firmware for. Set to 8211
for the CA-8211, or 8210
for the CA-8210.
The logging level to print messages for. From most verbose to least verbose:
Which serial interface should the device use to communicate to the host system?
Value | Meaning |
---|---|
USB | Use the Cascoda serial-over-USB-HID protocol, which allows driverless communication to programs running on the host. |
UART | Use the Cascoda acknowledged UART protocol to programs running on the host. |
NONE | Disable host communication and don’t build in the drivers for it. For space saving for headless devices. |
Build the OCF libraries and binaries, and internally modify the build of the other systems to support it. More information
Incompatible with CASCODA_BUILD_SECURE_LWM2M.
This option also disables the Test15-4 low-level debug interface globally, which breaks targets such as mac-dongle
. It also prevents running commands with Wing Commander.
Build the LWIP libraries and binaries, and internally modify the build of other systems to support it.
Build the LWM2M libraries and binaries, and internally modify the build of other systems to support it. More information.
Incompatible with CASCODA_BUILD_OCF.
Set the target configuration for the firmware.
Value | Meaning |
---|---|
ONE_SIDED | Configured for the Chili2S |
TWO_SIDED | Configured for the Chili2D |
DEV_BOARD | Configured for the Development Board |