This project contains C client library source that can be built and installed on devices installed with NXP i.MX operating system, and interact with the IBM Watson™ Internet of Things Platform. The library is customized to support NXP A71CH Secure Element.
The client code code can be built only on NXP i.MX Platform. You need a working combination of MCIMX6UL-EVKB and A71CH boards.
You must prepare and provision the board for building client code and connecting client to IBM Watson IoT Platform. Refer to the following documentation for Provisioning A71CH process. Note that the tools needed to build the client library and samples, come pre-installed on the SD card image for MCIMX6UL-EVKB board.
To test device connectivity to your IBM Watson™ IoT organization, you need an IBM Cloud account and an instance of IBM Watson IoT service in your IBM Cloud organization.
If you do not have an IBM Cloud account, sign up for an IBM Cloud account.
If you do not have an instance of IBM Watson IoT Platform service, create an instance in your IBM Cloud organization.
The client code code can be built only on NXP i.MX Platform. The code is dependent on Paho MQTT C Client version 1.2.0. The build script will automatically download dependent packages, so internet access is a must during build process.
Use the following command to download the C Client Library source:
git clone https://github.com/ibm-watson-iot/iot-nxpimxa71ch-c
If git is not available on the system, use curl command to download project zip file:
curl -LJO https://github.com/ibm-watson-iot/iot-nxpimxa71ch-c/archive/master.zip
unzip iot-nxpimxa71ch-c.master.zip
mv iot-nxpimxa71ch-c.master iot-nxpimxa71ch-c
Use the following commands to setup build tree and build C Client library and samples:
cd iot-nxpimxa71ch-c
make build
make install
Install step will install client library, header files, sample client binaries, configuration, and certificates in the following directory locations:
| Directory Location | Content |
|---|---|
| /usr/local/lib | Client libraries |
| /usr/local/include | Header files for device client build |
| /opt/iotnxpimxclient/bin | Device client sample binaries |
| /opt/iotnxpimxclient/config | Configuration files for Device client samples |
| /opt/iotnxpimxclient/certs | Certificate used by Device client samples |
Quickstart is an open sandbox that you can use to quickly connect your device to the IBM Watson™ IoT Platform.
- Connect to quickstart organization of IBM Watson™ Internet of Things Platform.
-
Select "I accept IBM's Terms of Use"
-
Specify a device id to 70028004006194989053 to test connectivity. Note that this device ID need not be the actual device ID stored in IC A71CH Secure Element. Note that the device configuration file /opt/iotnxpimxclient/config/device_quickstart.cfg is set with device id as 70028004006194989053. If you use a different value for device id for this test, then you will have to update the value of id in /opt/iotnxpimxclient/config/device_quickstart.cfg file.
-
Click Go button.
- On Device system, run the following commands:
cd /opt/iotnxpimxclient/bin
./helloWorld --config /opt/iotnxpimxclient/config/device_quickstart.cfg
The test device will get connected to Quickstart and the Quickstart page will start showing incoming simulated sensor data from the test device.
Use the following steps to register CA certificate, set connection security policy, and register device type and device id with Watson IoT Platform. This section also describes the steps needed to configure the device and connect to Watson IoT Platform.
Register CA certificate created in Step 2 of A71CH provisioning process described in Provisioning A71CH document, with Watson IoT Platform. Follow the instructions in the following section of Configuring certificates documentation:
Registering Certificate Authority (CA) certificates for device authentication
Set Default Connection Security to TLS with Client Certificate Authentication. For details on how to configure connection security policy, refer to the section Configuring connection security policies for advanced security" in the following link:
Devices installed with A71CH Secure Element can be configured as Watson IoT Platform device or Gateway. Use the following link to register your device or gateway:
Registering your device with Watson IoT Platform
If you want to configure and connect a device, register NXP-A71CH-D as a generic device type. If you want to configure and connect a gateway, register NXP-A71CH-G as a generic gateway type. For device or gateway ID, use ID returned by the provisioning script "provisionA71CH_WatsonIoT.sh" (described in Step 2 of A71CH provisioning process document with Watson IoT Platform).
The project contains samples client code for a device and a gateway.
Edit sample device configuration file device_a71ch.cfg file in /opt/iotnxpimxclient/config directory:
org=<orgid>
type=NXP-A71CH-D
useClientCertificates=1
rootCACertPath=/opt/iotnxpimxclient/certs/IoTFoundation.pem
useNXPEngine=1
useCertsFromSE=1
Use the following commands to connect your sample device client to Watson IoT Platform:
cd /opt/iotnxpimxclient/bin
./deviceSample --config /opt/iotnxpimxclient/config/device_a71ch.cfg
Edit sample gateway configuration file gateway_a71ch.cfg file in /opt/iotnxpimxclient/config directory:
org=<orgid>
type=NXP-A71CH-G
useClientCertificates=1
rootCACertPath=/opt/iotnxpimxclient/certs/IoTFoundation.pem
useNXPEngine=1
useCertsFromSE=1
Use the following commands to connect your sample gateway client to Watson IoT Platform:
cd /opt/iotnxpimxclient/bin
./gatewaySample --config /opt/iotnxpimxclient/config/gateway_a71ch.cfg