
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
========
This example demonstrates how the board can discover Greengrass core and communicate with AWS IoT cloud through it.
You will need device (A Mac, Windows PC, or UNIX-like system) for running AWS Greengrass. Example will connect to Wi-Fi network, try to discover your AWS Greengrass device and send Hello World message to AWS IoT cloud through it.
This demo needs Wi-Fi network with internet access and opened 8883 and 8443 ports.

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


Prepare the AWS Greengrass and AWS IoT
Before running the demo it is needed to configure AWS IoT Console, AWS Greengrass:

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

2.  Create AWS Greengrass group, set up it's core and set up Hello World Lambda function (Module 1 to Module 3 Part 1): https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-gs.html

    Note: If you are using Amazon EC2 service for running Greengrass Core, make sure that its public IP address (you can see when selecting your instance in AWS EC2 service administration) is set in Greengrass Core/Connectivity.

3.  Set up your device as part of your Greengrass group: https://docs.aws.amazon.com/greengrass/latest/developerguide/device-group.html

    In 2. step create one device named for example "HelloWorldDevice" (this will be your "Thing name") and save device certificates, you will need them later.

    Make note of "REST API endpoint" in Greengrass/Devices/<your device>/Interact

4.  Make sure that Greengrass core is running (e.g. on Linux you can check it with "ps aux | grep -e "greengrass"" command). If it is not running, start it with "sudo ./greengrassd start" in folder "/greengrass/ggc/packages/x.x.x/".

5.  Go to AWS IoT, find your Greengrass group and deploy it again. You should do new deployment after every configuration change.



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
================
1.  Open file "aws_clientcredential.h" and fill in your "Thing name" and "REST API endpoint" which can be found in AWS IoT under "Greengrass/Devices/<your device>/Interact":

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

    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".

    keyCLIENT_CERTIFICATE_PEM is stored in <device id>.cert.pem file and keyCLIENT_PRIVATE_KEY_PEM is stored in <device id>.private.key file.

    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.

2.  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."

3.  Open example's project and build it.

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

5.  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

6.  Download the program to the target board.

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


Running the demo
================
Demo is by default set to send message "Hello #0 from Amazon FreeRTOS to Greengrass Core." 3 times (can be changed with ggdDEMO_MAX_MQTT_MESSAGES).

You can check connection log in Greengrass device on path: /greengrass/ggc/var/log/system/connection_manager.log


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

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


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

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

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

4 37015 [wlcmgr] Connected to with IP = [192.168.199.188]

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

6 37060 [iot_thread] [INFO ][MQTT][37060] MQTT library successfully initialized.

7 37060 [iot_thread] [INFO ][DEMO][37060] Attempting automated selection of Greengrass device


8 40491 [iot_thread] JSON file retrieval completed

9 40491 [iot_thread] About to close socket.

10 40494 [iot_thread] Socket closed.

11 40494 [iot_thread] Stack high watermark for discovery helper task: 1530.

12 41456 [iot_thread] About to close socket.

13 41457 [iot_thread] Socket closed.

14 41460 [iot_thread] Stack high watermark for discovery helper task: 882.

15 41460 [iot_thread] [INFO ][DEMO][41460] Greengrass device discovered.

16 41460 [iot_thread] [INFO ][DEMO][41460] Attempting to establish MQTT connection to Greengrass.

17 42487 [iot_thread] [INFO ][MQTT][42487] Establishing new MQTT connection.

18 42491 [iot_thread] [INFO ][MQTT][42491] (MQTT connection 202144f0, CONNECT operation 202145b0) Waiting for operation completion.

19 42736 [NetRecv] [INFO] CONNACK session present bit not set.
20 42736 [NetRecv] [INFO] Connection accepted.
21 42737 [iot_thread] [INFO ][MQTT][42737] (MQTT connection 202144f0, CONNECT operation 202145b0) Wait complete with result SUCCESS.

22 42738 [iot_thread] [INFO ][MQTT][42738] New MQTT connection 2020bf20 established.

23 42740 [iot_thread] [INFO ][MQTT][42740] (MQTT connection 202144f0) MQTT PUBLISH operation queued.

24 44241 [iot_thread] [INFO ][MQTT][44241] (MQTT connection 202144f0) MQTT PUBLISH operation queued.

25 45742 [iot_thread] [INFO ][MQTT][45741] (MQTT connection 202144f0) MQTT PUBLISH operation queued.

26 47242 [iot_thread] [INFO ][DEMO][47242] Disconnecting from broker.

27 47242 [iot_thread] [INFO ][MQTT][47242] (MQTT connection 202144f0) Disconnecting connection.

28 47242 [iot_thread] [INFO] Disconnected from the broker.
29 47244 [iot_thread] [INFO ][MQTT][47244] (MQTT connection 202144f0) Network connection closed.

30 47477 [iot_thread] [INFO ][MQTT][47477] (MQTT connection 202144f0) Network connection destroyed.

31 47477 [iot_thread] [INFO ][DEMO][47477] Disconnected from the broker.

32 47477 [iot_thread] Heap low watermark: 14984. Stack high watermark: 882.

33 47477 [iot_thread] [INFO ][MQTT][47477] MQTT library cleanup done.

34 47477 [iot_thread] [INFO ][DEMO][47477] Cleaned up MQTT library.

35 47479 [iot_thread] [INFO ][DEMO][47479] memory_metrics::freertos_heap::before::bytes::87384

36 47479 [iot_thread] [INFO ][DEMO][47479] memory_metrics::freertos_heap::after::bytes::14984

37 47479 [iot_thread] [INFO ][DEMO][47479] memory_metrics::demo_task_stack::before::bytes::7856

38 47479 [iot_thread] [INFO ][DEMO][47479] memory_metrics::demo_task_stack::after::bytes::3528

39 48479 [iot_thread] [INFO ][DEMO][48479] Demo completed successfully.

40 48484 [wlcmgr] Dis-connected

41 48529 [iot_thread] [INFO ][INIT][48529] SDK cleanup done.

42 48529 [iot_thread] [INFO ][DEMO][48529] -------DEMO FINISHED-------

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