Skip to content

Latest commit

 

History

History
143 lines (113 loc) · 6.24 KB

README.md

File metadata and controls

143 lines (113 loc) · 6.24 KB
Raw

AWS IoT Device SDK for C++ v2

This document provides information about the AWS IoT device SDK for C++ V2. This SDK is built on the AWS Common Runtime

Jump To:

Supported Architectures

Linux

  • manylinux2014-x64
  • manylinux2014-x86
  • al2-x64
  • alpine-3.16-x64
  • alpine-3.16-x86
  • alpine-3.16-armv6
  • alpine-3.16-armv7
  • alpine-3.16-arm64
  • raspberry pi bullseye
  • ARM64 /aarch64
  • ArmV7
  • x86_64
  • x86

Windows

  • Win32
  • x64
  • ARM64

Mac

  • Apple Silicone (M1 and higher)
  • Apple Intel Chips (x86_64)

Installation

Minimum Requirements

  • C++ 11 or higher
    • Clang 3.9+ or GCC 4.8+ or MSVC 2015+
  • CMake 3.9+

Step-by-step instructions

Build from source

# Create a workspace directory to hold all the SDK files
mkdir sdk-workspace
cd sdk-workspace
# Clone the repository
git clone --recursive https://github.com/aws/aws-iot-device-sdk-cpp-v2.git
# Make a build directory for the SDK. Can use any name.
mkdir aws-iot-device-sdk-cpp-v2-build
cd aws-iot-device-sdk-cpp-v2-build
# continue with the build steps below based on OS

MacOS and Linux

# Generate the SDK build files.
# -DCMAKE_INSTALL_PREFIX needs to be the absolute/full path to the directory.
#     (Example: "/Users/example/sdk-workspace/).
# -DCMAKE_BUILD_TYPE can be "Release", "RelWithDebInfo", or "Debug"
cmake -DCMAKE_INSTALL_PREFIX="<absolute path to sdk-workspace>" -DCMAKE_BUILD_TYPE="Debug" ../aws-iot-device-sdk-cpp-v2
# Build and install the library. Once installed, you can develop with the SDK and run the samples
cmake --build . --target install

Windows

# Generate the SDK build files.
# -DCMAKE_INSTALL_PREFIX needs to be the absolute/full path to the directory.
#     (Example: "C:/users/example/sdk-workspace/).
cmake -DCMAKE_INSTALL_PREFIX="<absolute path sdk-workspace dir>" ../aws-iot-device-sdk-cpp-v2
# Build and install the library. Once installed, you can develop with the SDK and run the samples
# -config can be "Release", "RelWithDebInfo", or "Debug"
cmake --build . --target install --config "Debug"

Windows specific notes:

  • Due to maximum path length limitations in the Windows API, we recommend cloning to a short path like: C:\dev\iotsdk
  • --config is only REQUIRED for multi-configuration build tools (VisualStudio/MsBuild being the most common).

Linux specific notes:

If your application uses OpenSSL, configure with -DUSE_OPENSSL=ON.

The IoT SDK does not use OpenSSL for TLS. On Apple and Windows, the OS's default TLS library is used. On Linux, s2n-tls is used. But s2n-tls uses libcrypto, the cryptography math library bundled with OpenSSL. To simplify the build process, the source code for s2n-tls and libcrypto are included as git submodules and built along with the IoT SDK. But if your application is also loading the system installation of OpenSSL (i.e. your application uses libcurl which uses libssl which uses libcrypto) there may be crashes as the application tries to use two different versions of libcrypto at once.

Setting -DUSE_OPENSSL=ON will cause the IoT SDK to link against your system's existing libcrypto, instead of building its own copy.

Samples

Samples README

Mac-Only TLS Behavior

Please note that on Mac, once a private key is used with a certificate, that certificate-key pair is imported into the Mac Keychain. All subsequent uses of that certificate will use the stored private key and ignore anything passed in programmatically. Beginning in v1.7.3, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:

static: certificate has an existing certificate-key pair that was previously imported into the Keychain.  Using key from Keychain instead of the one provided.

Getting Help

The best way to interact with our team is through GitHub. You can open a discussion for guidance questions or an issue for bug reports, or feature requests. You may also find help on community resources such as StackOverFlow with the tag #aws-iot or if you have a support plan with AWS Support, you can also create a new support case.

Please make sure to check out our resources too before opening an issue:

License

This library is licensed under the Apache 2.0 License.

Latest released version: v1.34.0