
This SDK has been patched by Embedded Artists for the iMXRT1176 Developer's Kit.
The SDK was released on 2022-03-02 and is based on NXP's 2.11.0 SDK (SDK_2_11_0_MIMXRT1176xxxxx.zip).

This is what has been patched:
* LWIP projects - added reading of the MAC address from I2C EEPROM either on the 100Mbit adapter
  or on the uCOM board
* Added an I2C driver for the gpio expander (PCA6416) and code to use it
* Added an I2C driver for the PWM gpio expander (PCA9530) and code to use it
* SDRAM size has been corrected to 32Mb (including linker files, MPU and DCD)
* 1G Ethernet PHY has been changed from RTL8211F to AR8031DS
* SEMC projects - changed to correct settings for the SDRAM
* SEMC projects - changed algorithm for memory test and now test entire 32MB instead of only 4KB
* Examples using eLCDIF/LCDIFv2 have been updated to use PCA6416/PCA9530 for
  RST/PWR/BL signals
* BOARD_USER_BUTTON has been redirected to SW5/WAKEUP button on the uCOM Carrier Board
* USER_LED has been changed to the blue RGB LED using PCA6416
* Touch: I2C bus and GPIOs have been changed for RST/INT
* Camera pins
* Adjusted the USB interface number (it is different for host and device examples)
* Changed the Wi-Fi examples to use the Embedded Artists 1XK M.2 Module (EAR00385) as default
* Corrected the ethernet PHY addresses
* Changed CORE clock depending on speed grading of MCU (798MHz for Industrial, 996MHz for Commercial)
* Changed SEMC clock to be within maximum speed for SDRAM (now 148.5MHz, was 198MHz)
* Many of the projects have been updated to use a more complete pin_mux.c file where all
  necessary pins have been initialized. The SDK examples used to only configure the pins
  that they use (and often not every pin) and most of the time the configuration was only
  for MUX:ing and not the PAD settings (pull up/down/none, drive strength and slew).
* Converted the AzureRTOS examples to use the BOARD_NETWORK_USE_100M_ENET_PORT (same as all
  other networking examples) instead of using the old EXAMPLE_USE_1G_ENET_PORT

This has been added:
* HDMI support to most GUI examples. HDMI at 1024x768@60 is the default resolution but
  that can be changed per project in display_support.h/elcdif_support.h/lcdifv2_support.h.
* Added ADT example for TensorFlow Lite
* I2C probe example
* EDID reader example
* Wi-Fi (serial) examples for the CMWC1ZZABR-107-EVB (a.k.a ABR Module)

This has been removed:
* All projects for the expansion board AGM01

Important things to note:
* Read section "8 - Known Issues" in docs/MCUXpresso SDK Release Notes for MIMXRT1170-EVK.pdf
  to see known issues with the current version of the SDK.
* For Iperf examples, set compiler optimization to -O3 or similar to improve performance.
* If the hardware seems unresponsive and the debugger cannot connect/flash/erase the current program
  then the most likely cause is the running program preventing the access. To stop the currently
  running program and regain control:
  1) Press and hold down the ISP_ENABLE button (SW1)
  2) Press and hold down the RESET button (SW3)
  3) Let go of the RESET button
  4) Wait an extra second or two
  5) Release the ISP_ENABLE button
  6) The hardware is now in a mode where programming/erasing it should work


Connectors:
* J29 (micro USB) is the default UART for the CM7 core and unless specified otherwise it is setup for 115200 8/N/1
* J30 (micro USB) is the default UART for the CM4 core and unless specified otherwise it is setup for 115200 8/N/1
* For 1Gbit Ethernet examples, use connector J25 on uCOM Carrier Board
* For 100Mbit Ethernet examples, use ethernet adapter connected between J12 on uCOM Carrier Board
  and J37 on the adapter. These four connections are also needed:
    1) uCOM Carrier Board, JP38:1 -> adapter JP37:1
    2) uCOM Carrier Board, JP38:2 -> adapter JP37:2
    3) uCOM Carrier Board, JP27:1 -> adapter JP39:2
    4) uCOM Carrier Board, JP27:2 -> adapter JP39:1
* The two CSI examples can use either an OV5640 camera in connector J23 or a camera in connector J24
* The EIQ examples that use a camera expects the camera in connector J24 (J23 might work for some
  of the examples but runs much slower)
* Some GUI examples are configured for the RK055AHD091 display which should be in connector "C" on
  the uCOM Carrier Board. Ignore the readme text about connecting extra 5V power.
* The default for GUI examples is to use an HDMI adapter in connector "C" on
  the uCOM Carrier Board. Ignore the readme text about connecting extra 5V power.


This example has been configured to use the 1XK M.2 module. To change which
module to use, replace WIFI_IW416_BOARD_MURATA_1XK_M2 in the app_config.h file
with one of the following and then rebuild the project:

    WIFI_IW416_BOARD_MURATA_1XK_ONBOARD - To use the 1XK chip on the uCOM board (special mounting option)
    WIFI_IW416_BOARD_MURATA_1XK_M2      - To use the 1XK M.2 module in connector J33
    WIFI_88W8801_BOARD_MURATA_2DS_M2    - To use the 2DS M.2 module in connector J33
    WIFI_88W8987_BOARD_MURATA_1ZM_M2    - To use the 1ZM M.2 module in connector J33

This example has been tested with the M.2 modules above.
More information about the M.2 Modules can be found here: https://www.embeddedartists.com/m2/

It could be possible to use the other modules as shown in the original
readme text below, however that is untested and unsupported.


Everything below this line is the original content of the readme file.
=======================================================================



Overview
========
The simple Shadow lightbulb example to illustrate how client application and things communicate with the Shadow service.

Before building the example application select Wi-Fi module macro in the app_config.h. (see #define WIFI_<SoC Name>_BOARD_<Module Name>).
For more information about Wi-Fi module connection see:
    readme_modules.txt
    Getting started guide on supported modules configuration:
    https://www.nxp.com/document/guide/getting-started-with-nxp-wi-fi-modules-using-i-mx-rt-platform:GS-WIFI-MODULES-IMXRT-PLATFORM



Toolchain supported
===================
- IAR embedded Workbench  9.10.2
- Keil MDK  5.34
- GCC ARM Embedded  10.2.1
- MCUXpresso  11.5.0

Hardware requirements
=====================
- Micro USB cable
- MIMXRT1170-EVK board
- Personal Computer


Board settings
==============

Prepare the Demo
================
Before running the demo it is need to configure AWS IoT Console and update some of project files:

1.  Create AWS Account: https://console.aws.amazon.com/console/home

2.  Configure device in the AWS IoT Console base on this guide: https://docs.aws.amazon.com/iot/latest/developerguide/iot-sdk-setup.html

    Make note of example's "Thing name" and "REST API endpoint". These strings need to be set in the "aws_clientcredential.h".

    Example:
        static const char clientcredentialMQTT_BROKER_ENDPOINT[] = "abcdefgh123456.iot.us-west-2.amazonaws.com";
        #define clientcredentialIOT_THING_NAME "MyExample"

    In the next step you will get the "device certificate" and the "primary key". The device certificate and private key needs to be opened in text editor and its content copied into the "aws_clientcredential_keys.h".
    Or you can use the CertificateConfigurator.html (mcu-sdk-2.0\rtos\freertos\tools\certificate_configuration) to generate the "aws_clientcredential_keys.h".

    Example:
        #define keyCLIENT_CERTIFICATE_PEM "Paste client certificate here."

        Needs to be changed to:

        #define keyCLIENT_CERTIFICATE_PEM "-----BEGIN CERTIFICATE-----\n"\
        "MIIDWTCCAkGgAwIBAgIUfmv3zA+JULlMOxmz+upkAzhEkQ0wDQYJKoZIhvcNAQEL\n"\
        .
        .
        .
        "mepuT3lKmD0jZupsQ9vLQOA09rMjVMd0YPmI9ozvvWqLpjVvNTKVhsf/3slM\n"\
        "-----END CERTIFICATE-----\n"

    In the same way update the private key array.

3.  This demo needs Wi-Fi network with internet access.
    Update these macros in "aws_clientcredential.h" based on your Wi-Fi network configuration:
        #define clientcredentialWIFI_SSID       "Paste Wi-Fi SSID here."
        #define clientcredentialWIFI_PASSWORD   "Paste Wi-Fi password here."

4.  Open example's project and build it.

5.  Connect a USB cable between the PC host and the OpenSDA port on the target board.

6.  Download the program to the target board with the CMSIS-DAP or J-Link debugger.

7.  Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

8.  Open a serial terminal on PC for serial device with these settings:
    - 115200 baud rate
    - 8 data bits
    - No parity
    - One stop bit
    - No flow control

Running the demo
================
The log below shows the output of the demo in the terminal window. The log can be different based on your Wi-Fi network configuration.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0 147 [Tmr Svc] Write certificate...

1 165 [iot_thread] [INFO ][DEMO][165] ---------STARTING DEMO---------


2 167 [iot_thread] [INFO ][INIT][167] SDK successfully initialized.

MAC Address:  0:13:43:7F:9D:F7 
[net] Initialized TCP/IP networking stack

3 3479 [iot_thread] Connecting to nxp .....

4 11382 [wlcmgr] Connected to with IP = [192.168.199.175]

5 11429 [iot_thread] [INFO ][DEMO][11429] Successfully initialized the demo. Network type for the demo: 1

6 11429 [iot_thread] [INFO] Create a TCP connection to a2zcot8a2tqh6c-ats.iot.us-east-2.amazonaws.com:8883.
7 14129 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
8 14129 [iot_thread] [INFO] CONNACK session present bit not set.
9 14129 [iot_thread] [INFO] Connection accepted.
10 14129 [iot_thread] [INFO] Received MQTT CONNACK successfully from broker.
11 14129 [iot_thread] [INFO] MQTT connection established with the broker.
12 14129 [iot_thread] [INFO] MQTT connection successfully established with broker.


13 14129 [iot_thread] [INFO] A clean MQTT connection is established. Cleaning up all the stored outgoing publishes.


14 14131 [iot_thread] [INFO] SUBSCRIBE topic $aws/things/aws_demo/shadow/delete/accepted to broker.


15 14417 [iot_thread] [INFO] Packet received. ReceivedBytes=3.
16 14419 [iot_thread] [INFO] MQTT_PACKET_TYPE_SUBACK.


17 16228 [iot_thread] [INFO] SUBSCRIBE topic $aws/things/aws_demo/shadow/delete/rejected to broker.


18 16483 [iot_thread] [INFO] Packet received. ReceivedBytes=3.
19 16483 [iot_thread] [INFO] MQTT_PACKET_TYPE_SUBACK.


20 18292 [iot_thread] [INFO] the published payload: 
 
21 18292 [iot_thread] [INFO] PUBLISH sent for topic $aws/things/aws_demo/shadow/delete to broker with packet ID 3.


22 18529 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
23 18529 [iot_thread] [INFO] Ack packet deserialized with result: MQTTSuccess.
24 18529 [iot_thread] [INFO] State record updated. New state=MQTTPublishDone.
25 18529 [iot_thread] [INFO] PUBACK received for packet id 3.


26 18529 [iot_thread] [INFO] Cleaned up outgoing publish packet with packet id 3.


27 18769 [iot_thread] [INFO] Packet received. ReceivedBytes=90.
28 18769 [iot_thread] [INFO] De-serialized incoming PUBLISH packet: DeserializerResult=MQTTSuccess.
29 18769 [iot_thread] [INFO] State record updated. New state=MQTTPubAckSend.
30 18769 [iot_thread] [INFO] pPublishInfo->pTopicName:$aws/things/aws_demo/shadow/delete/accepted.
31 18769 [iot_thread] [INFO] Received an MQTT incoming publish on /delete/accepted topic.
32 20379 [iot_thread] [INFO] UNSUBSCRIBE sent topic $aws/things/aws_demo/shadow/delete/accepted to broker.


33 20612 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
34 20612 [iot_thread] [INFO] MQTT_PACKET_TYPE_UNSUBACK.


35 22421 [iot_thread] [INFO] UNSUBSCRIBE sent topic $aws/things/aws_demo/shadow/delete/rejected to broker.


36 22810 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
37 22810 [iot_thread] [INFO] MQTT_PACKET_TYPE_UNSUBACK.


38 24619 [iot_thread] [INFO] SUBSCRIBE topic $aws/things/aws_demo/shadow/update/delta to broker.


39 24897 [iot_thread] [INFO] Packet received. ReceivedBytes=3.
40 24897 [iot_thread] [INFO] MQTT_PACKET_TYPE_SUBACK.


41 26706 [iot_thread] [INFO] SUBSCRIBE topic $aws/things/aws_demo/shadow/update/accepted to broker.


42 26962 [iot_thread] [INFO] Packet received. ReceivedBytes=3.
43 26962 [iot_thread] [INFO] MQTT_PACKET_TYPE_SUBACK.


44 28771 [iot_thread] [INFO] SUBSCRIBE topic $aws/things/aws_demo/shadow/update/rejected to broker.


45 29050 [iot_thread] [INFO] Packet received. ReceivedBytes=3.
46 29050 [iot_thread] [INFO] MQTT_PACKET_TYPE_SUBACK.


47 30859 [iot_thread] [INFO] Send desired power state with 1.
48 30859 [iot_thread] [INFO] the published payload:{"state":{"desired":{"powerOn":1}},"clientToken":"030859"} 
 
49 30859 [iot_thread] [INFO] PUBLISH sent for topic $aws/things/aws_demo/shadow/update to broker with packet ID 9.


50 31096 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
51 31097 [iot_thread] [INFO] Ack packet deserialized with result: MQTTSuccess.
52 31097 [iot_thread] [INFO] State record updated. New state=MQTTPublishDone.
53 31097 [iot_thread] [INFO] PUBACK received for packet id 9.


54 31097 [iot_thread] [INFO] Cleaned up outgoing publish packet with packet id 9.


55 31305 [iot_thread] [INFO] Packet received. ReceivedBytes=180.
56 31305 [iot_thread] [INFO] De-serialized incoming PUBLISH packet: DeserializerResult=MQTTSuccess.
57 31305 [iot_thread] [INFO] State record updated. New state=MQTTPubAckSend.
58 31305 [iot_thread] [INFO] pPublishInfo->pTopicName:$aws/things/aws_demo/shadow/update/delta.
59 31305 [iot_thread] [INFO] /update/delta json payload:{"version":264,"timestamp":1623070061,"state":{"powerOn":1},"metadata":{"powerOn":{"timestamp":1623070061}},"clientToken":"030859"}.
60 31305 [iot_thread] [INFO] version: 264
61 31305 [iot_thread] [INFO] version:264, ulCurrentVersion:0 

62 31305 [iot_thread] [INFO] The new power on state newState:1, ulCurrentPowerOnState:0 

63 31307 [iot_thread] [INFO] Packet received. ReceivedBytes=207.
64 31307 [iot_thread] [INFO] De-serialized incoming PUBLISH packet: DeserializerResult=MQTTSuccess.
65 31307 [iot_thread] [INFO] State record updated. New state=MQTTPubAckSend.
66 31307 [iot_thread] [INFO] pPublishInfo->pTopicName:$aws/things/aws_demo/shadow/update/accepted.
67 31307 [iot_thread] [INFO] /update/accepted json payload:{"state":{"desired":{"powerOn":1}},"metadata":{"desired":{"powerOn":{"timestamp":1623070061}}},"version":264,"timestamp":1623070061,"clientToken":"030859"}.
68 31307 [iot_thread] [INFO] clientToken: 030859
69 31307 [iot_thread] [INFO] receivedToken:30859, clientToken:0 

70 31307 [iot_thread] [WARN] The received clientToken=30859 is not identical with the one=0 we sent 
71 32915 [iot_thread] [INFO] Report to the state change: 1
72 32915 [iot_thread] [INFO] the published payload:{"state":{"reported":{"powerOn":1}},"clientToken":"032915"} 
 
73 32915 [iot_thread] [INFO] PUBLISH sent for topic $aws/things/aws_demo/shadow/update to broker with packet ID 10.


74 33163 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
75 33163 [iot_thread] [INFO] Ack packet deserialized with result: MQTTSuccess.
76 33163 [iot_thread] [INFO] State record updated. New state=MQTTPublishDone.
77 33163 [iot_thread] [INFO] PUBACK received for packet id 10.


78 33163 [iot_thread] [INFO] Cleaned up outgoing publish packet with packet id 10.


79 33405 [iot_thread] [INFO] Packet received. ReceivedBytes=209.
80 33405 [iot_thread] [INFO] De-serialized incoming PUBLISH packet: DeserializerResult=MQTTSuccess.
81 33405 [iot_thread] [INFO] State record updated. New state=MQTTPubAckSend.
82 33405 [iot_thread] [INFO] pPublishInfo->pTopicName:$aws/things/aws_demo/shadow/update/accepted.
83 33405 [iot_thread] [INFO] /update/accepted json payload:{"state":{"reported":{"powerOn":1}},"metadata":{"reported":{"powerOn":{"timestamp":1623070063}}},"version":265,"timestamp":1623070063,"clientToken":"032915"}.
84 33405 [iot_thread] [INFO] clientToken: 032915
85 33405 [iot_thread] [INFO] receivedToken:32915, clientToken:32915 

86 33405 [iot_thread] [INFO] Received response from the device shadow. Previously published update with clientToken=32915 has been accepted. 
87 35015 [iot_thread] [INFO] Start to unsubscribe shadow topics and disconnect from MQTT. 

88 35015 [iot_thread] [INFO] UNSUBSCRIBE sent topic $aws/things/aws_demo/shadow/update/delta to broker.


89 35256 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
90 35256 [iot_thread] [INFO] MQTT_PACKET_TYPE_UNSUBACK.


91 37065 [iot_thread] [INFO] UNSUBSCRIBE sent topic $aws/things/aws_demo/shadow/update/accepted to broker.


92 37327 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
93 37327 [iot_thread] [INFO] MQTT_PACKET_TYPE_UNSUBACK.


94 39136 [iot_thread] [INFO] UNSUBSCRIBE sent topic $aws/things/aws_demo/shadow/update/rejected to broker.


95 39412 [iot_thread] [INFO] Packet received. ReceivedBytes=2.
96 39412 [iot_thread] [INFO] MQTT_PACKET_TYPE_UNSUBACK.


97 41221 [iot_thread] [INFO] Disconnected from the broker.
98 41223 [iot_thread] [INFO] Demo iteration 1 is successful.
99 41223 [iot_thread] [INFO ][DEMO][41223] memory_metrics::freertos_heap::before::bytes::89440

100 41223 [iot_thread] [INFO ][DEMO][41223] memory_metrics::freertos_heap::after::bytes::16536

101 41223 [iot_thread] [INFO ][DEMO][41223] memory_metrics::demo_task_stack::before::bytes::5336

102 41223 [iot_thread] [INFO ][DEMO][41223] memory_metrics::demo_task_stack::after::bytes::3272

103 42223 [iot_thread] [INFO ][DEMO][42223] Demo completed successfully.

104 42225 [wlcmgr] Dis-connected

105 42273 [iot_thread] [INFO ][INIT][42273] SDK cleanup done.

106 42273 [iot_thread] [INFO ][DEMO][42273] -------DEMO FINISHED-------

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
