X-CUBE-AZRTOS-H7RS

https://github.com/stmicroelectronics/x-cube-azrtos-h7rs
Admin
Azure RTOS Software Expansion for STM32Cube, providing full integration of Microsoft Azure RTOS...
Tokens:4,521,039
Snippets:11,492
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### JavaScript Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DAP/html/dap_install.html

JavaScript code used for initializing the page, managing window resizing, and setting up the search functionality for the documentation site.

```javascript
$(document).ready(initResizable); $(window).load(resizeHeight);  $(document).ready(function() { searchBox.OnSelectItem(0); });

var searchBox = new SearchBox("searchBox", "search",false,'Search');

$(document).ready(function(){initNavTree('dap_install.html','');});
```

--------------------------------

### Flash Driver Initialization and Usage Example

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Driver/html/group__flash__interface__gr.html

Demonstrates a typical setup sequence for the Flash driver using CMSIS-RTOS2. It covers driver initialization, power control, reading data, and handling completion events.

```c
#include "Driver_Flash.h"
#include "cmsis_os2.h" // ARM::CMSIS:RTOS2:Keil RTX5

/* Flash driver instance */
extern ARM_DRIVER_FLASH Driver_Flash0;

static ARM_DRIVER_FLASH *flashDev = &Driver_Flash0;

/* CMSIS-RTOS2 Thread Id */
osThreadId_t Flash_Thread_Id;

/* Flash signal event */
void Flash_Callback(uint32_t event)
{
    if (event & ARM_FLASH_EVENT_READY) {
        /* The read/program/erase operation is completed */
        osThreadFlagsSet(Flash_Thread_Id, 1U);
    }
    if (event & ARM_FLASH_EVENT_ERROR) {
        /* The read/program/erase operation is completed with errors */
        /* Call debugger or replace with custom error handling */
        __breakpoint(0);
    }
}

/* CMSIS-RTOS2 Thread */
void Flash_Thread (void *argument)
{
    /* Query drivers capabilities */
    const ARM_FLASH_CAPABILITIES capabilities = flashDev->GetCapabilities();

    /* Initialize Flash device */
    if (capabilities.event_ready) {
        flashDev->Initialize(&Flash_Callback);
    } else {
        flashDev->Initialize(NULL);
    }

    /* Power-on Flash device */
    flashDev->PowerControl(ARM_POWER_FULL);

    /* Read data taking data_width into account */
    uint8_t buf[256U];
    flashDev->ReadData(0x1000U, buf, sizeof(buf) >> capabilities.data_width);

    /* Wait operation to be completed */
    if (capabilities.event_ready) {
        osThreadFlagsWait (1U, osFlagsWaitAny, 100U);
    } else {
        osDelay(100U);
    }

    /* Switch off gracefully */
    flashDev->PowerControl(ARM_POWER_OFF);
    flashDev->Uninitialize();
}
```

--------------------------------

### CMSIS-DAP v2 Windows Driver (.inf) Configuration

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DAP/html/group__DAP__ConfigUSB__gr.html

A sample Windows driver installation file (.inf) for CMSIS-DAP v2 devices, specifying version information, manufacturer details, device installation sections, and GUIDs for automatic driver setup on Windows 7 and later.

```APIDOC
[Version]
Signature = "$Windows NT$"
Class     = USBDevice
ClassGUID = {88BAE032-5A81-49f0-BC3D-A4FF138216D6}
Provider  = %ManufacturerName%
DriverVer = 04/13/2016, 1.0.0.0
CatalogFile.nt      = CMSIS_DAP_v2_x86.cat
CatalogFile.ntx86   = CMSIS_DAP_v2_x86.cat
CatalogFile.ntamd64 = CMSIS_DAP_v2_amd64.cat

; ========== Manufacturer/Models sections ===========

[Manufacturer]
%ManufacturerName% = Devices, NTx86, NTamd64

[Devices.NTx86]
%DeviceName% = USB_Install, USB\VID_c251&PID_f000

[Devices.NTamd64]
%DeviceName% = USB_Install, USB\VID_c251&PID_f000

; ========== Class definition ===========

[ClassInstall32]
AddReg = ClassInstall_AddReg

[ClassInstall_AddReg]
HKR,,,,%ClassName%
HKR,,NoInstallClass,,1
HKR,,IconPath,0x10000,"%%SystemRoot%%\System32\setupapi.dll,-20"
HKR,,LowerLogoVersion,,5.2

; =================== Installation ===================

[USB_Install]
Include = winusb.inf
Needs   = WINUSB.NT

[USB_Install.Services]
Include = winusb.inf
Needs   = WINUSB.NT.Services

[USB_Install.HW]
AddReg  = Dev_AddReg

[Dev_AddReg]
HKR,,DeviceInterfaceGUIDs,0x10000,"{CDB3B5AD-293B-4663-AA36-1AAE46463776}"

; =================== Strings ===================

[Strings]
ClassName        = "Universal Serial Bus devices"
ManufacturerName = "KEIL - Tools By ARM"
DeviceName       = "CMSIS-DAP v2"
```

--------------------------------

### Application Execution Steps

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Projects/STM32H7S78-DK/Applications/NetXDuo/Nx_WebServer_wifi/readme.html

General instructions for building, loading, and running the application on the target hardware.

```Application Execution
To make the program work:
1. Open your preferred toolchain.
2. Rebuild all files and load your image into target memory.
3. Run the application.
```

--------------------------------

### JavaScript Initialization and Search Box Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/NN/html/globals_n.html

This snippet demonstrates common JavaScript patterns used in web documentation for initialization and search functionality. It includes document ready handlers for UI setup and search box configuration.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() { searchBox.OnSelectItem(0); });

var searchBox = new SearchBox("searchBox", "search",false,'Search');

$(document).ready(function(){initNavTree('globals_n.html','');});
```

--------------------------------

### CMake Project Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/Examples_2ARM_2arm__signal__converge__example_2CMakeLists_8txt.html

Defines the minimum required CMake version and sets the project name and version. This is a standard starting point for CMake projects.

```cmake
cmake_minimum_required(VERSION 3.14)
project(arm_signal_convergence_example VERSION 0.1)
```

--------------------------------

### Page Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Core_A/html/globals_g.html

JavaScript code for initializing the document ready state, handling window resizing, and setting up the search box functionality for the documentation page.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);

$(document).ready(function() {
  searchBox.OnSelectItem(0);
});

var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

--------------------------------

### RTOS Kernel Initialization and Thread Creation Example

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/RTOS2/html/group__CMSIS__RTOS__KernelCtrl.html

Demonstrates the initialization of the CMSIS-RTOS kernel, creation of the main application thread, and starting the RTOS scheduler. This is a typical setup for an embedded RTOS application.

```c
#include "RTE_Components.h"

#include CMSIS_device_header

#include "cmsis_os2.h"

/*----------------------------------------------------------------------------*
 * Application main thread
*----------------------------------------------------------------------------*/
void app_main (void *argument) {
  // ...
  for (;;)
  {
  }
}

int main (void) {
  // System Initialization
  SystemCoreClockUpdate();

  // ...
  osKernelInitialize(); // Initialize CMSIS-RTOS
  osThreadNew(app_main, NULL, NULL); // Create application main thread
  osKernelStart(); // Start thread execution

  for (;;)
  {
  }
}
```

--------------------------------

### Install Prerequisites on Debian/Ubuntu

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/docs/how_to_iot_hub_samples_linux.md

Installs essential build tools, Git, and OpenSSL required for the Azure SDK setup on Debian/Ubuntu-based Linux systems. This command updates the package list and installs necessary development packages.

```bash
sudo apt-get update
sudo apt-get install build-essential curl unzip tar pkg-config git openssl libssl-dev
```

--------------------------------

### Page Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Core/html/globals_defs_a.html

Initializes page elements, resizes layout, and sets up the search functionality for the documentation. This script handles common web page interactions for navigation and search.

```javascript
$(document).ready(initResizable); $(window).load(resizeHeight);  $(document).ready(function() { searchBox.OnSelectItem(0); });

var searchBox = new SearchBox("searchBox", "search",false,'Search');

$(document).ready(function(){initNavTree('globals_defs_a.html','');});
```

--------------------------------

### C Example: Create, Start, and Stop CMSIS-RTOS Timer

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/RTOS/html/group__CMSIS__RTOS__TimerMgmt.html

Demonstrates the typical workflow for using CMSIS-RTOS timers. It shows how to create a timer, start it with a specified delay, and then stop it. This example highlights the use of osTimerCreate, osTimerStart, and osTimerStop functions.

```c
#include "cmsis_os.h"

void Timer_Callback (void const *arg); // prototype for timer callback function

void TimerStop_example (void) {
  osTimerId id; // timer id
  osStatus status; // function return status

  // Create periodic timer
  exec = 1;
  id = osTimerCreate(osTimer(Timer2), osTimerPeriodic, NULL); // define timer

  osTimerStart(id, 1000); // start timer

  status = osTimerStop(id); // stop timer

  if (status != osOK) {
    // Timer could not be stopped
  }

  // Example of starting again
  osTimerStart(id, 1000); // start timer again
}
```

--------------------------------

### Page Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/NN/html/globals_func.html

JavaScript code for initializing page elements, handling window resizing, and setting up the search functionality within the documentation interface.

```JavaScript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() { searchBox.OnSelectItem(0); });
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

--------------------------------

### Start CLI for Examples Matching Keywords (PowerShell)

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/threadx/test/ports/README.md

Starts CLI environments for Azure RTOS examples matching specific keywords, such as 'TX ' (for ThreadX) and 'Cortex M7'. From the CLI, commands like 'realclean', 'clean', 'build', and 'test' can be executed.

```PowerShell
pwsh -Command .\azrtos_cicd.ps1 -MatchKeywords 'TX ','Cortex M7' -StartCLI
```

--------------------------------

### JavaScript Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/SVD/html/index.html

This snippet includes common JavaScript code used for initializing UI elements like resizable windows and setting up a search box functionality within a web-based documentation environment.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() {
  searchBox.OnSelectItem(0);
});
```

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

--------------------------------

### Signal Convergence Example Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/arm_signal_converge_example_f32_8c-example.html

Defines the state variables, input/output buffers, and instance structures required for the LMS normalization signal convergence example. Includes external declarations for test data and coefficients.

```c
/* Global variables for LMS normalization example */

/* State buffer for LMS filter */
extern float32_t lmsStateF32[NUMTAPS + BLOCKSIZE];

/* Error output buffer */
extern float32_t errOutput[TEST_LENGTH_SAMPLES];

/* Instance structure for LMS normalization */
extern arm_lms_norm_instance_f32 lmsNorm_instance;

/* External declarations for test data and coefficients */
extern float32_t testInput_f32[TEST_LENGTH_SAMPLES];
extern float32_t lmsNormCoeff_f32[32];
extern const float32_t FIRCoeff_f32[32];

/* Declare I/O buffers */
float32_t wire1[BLOCKSIZE];
float32_t wire2[BLOCKSIZE];
float32_t wire3[BLOCKSIZE];
float32_t err_signal[BLOCKSIZE];
```

--------------------------------

### Application Build and Run Steps

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Projects/NUCLEO-H7S3L8/Applications/USBX/Ux_Device_HID_CDC_ACM/readme.html

Outlines the general procedure for building and running the application after the debug configuration is set up. This includes rebuilding all files, loading the image into target memory, and starting the application execution.

```text
Open your preferred toolchain
Rebuild all files and load your image into target memory
Run the application
```

--------------------------------

### JavaScript Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Driver/html/globals_defs_n.html

Contains JavaScript code for document ready events, search box initialization, and navigation tree setup. These snippets are part of the documentation's interactive features.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() { searchBox.OnSelectItem(0); });
```

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

```javascript
$(document).ready(function(){initNavTree('globals_defs_n.html','');});
```

--------------------------------

### CMSIS-DSP Global Variables (d)

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/globals_vars_d.html

Lists global variables starting with 'd' in the CMSIS-DSP library. Includes 'doBitReverse' from FFT example and 'dualCoefficients' from SVM example.

```c
doBitReverse : [arm_fft_bin_example_f32.c](arm__fft__bin__example__f32_8c.html#a4d2e31c38e8172505e0a369a6898657d)
dualCoefficients : [arm_svm_example_f32.c](arm__svm__example__f32_8c.html#a6bee216b9b7e7b8d18687cd692e26a8a)
```

--------------------------------

### Install OpenSSL on Linux

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/README.md

Installs OpenSSL and its development headers on Linux systems using apt-get. OpenSSL is required for secure communication protocols.

```bash
sudo apt-get install openssl libssl-dev
```

--------------------------------

### Document Ready and Initialization Scripts

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Core/html/globals_vars.html

JavaScript code snippets for document ready events, search box initialization, and navigation tree setup, commonly found in web-based documentation.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() { searchBox.OnSelectItem(0); });
```

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

```javascript
$(document).ready(function(){initNavTree('globals_vars.html','');});
```

--------------------------------

### Application Execution Steps

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Projects/NUCLEO-H7S3L8/Applications/ThreadX/Tx_LowPower/readme.html

General steps to build, load, and run the application after configuring the development environment.

```shell
1. Open your preferred toolchain
2. Rebuild all files and load your image into target memory
3. Run the application
```

--------------------------------

### RTOS Timer Creation and Start Example

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/RTOS/html/group__CMSIS__RTOS__TimerMgmt.html

Demonstrates defining, creating, and starting RTOS timers for both one-shot and periodic execution. It shows how to associate callback functions and pass arguments to them.

```c
#include "cmsis_os.h"

void start_machine(void const *argument);
void toggle_power(void const *argument);

// Define timers
[osTimerDef](group__CMSIS__RTOS__TimerMgmt.html#ga1c720627e08d1cc1afcad44e799ed492)(one_shot, start_machine);
[osTimerDef](group__CMSIS__RTOS__TimerMgmt.html#ga1c720627e08d1cc1afcad44e799ed492)(periodic, toggle_power);

[osTimerId](cmsis__os_8h.html#ab8530dd4273f1f5382187732e14fcaa7) one_shot_id, periodic_id;

void TimerCreate_example (void) {
    // Create one-shot timer
    one_shot_id = [osTimerCreate](group__CMSIS__RTOS__TimerMgmt.html#gaedd312bfdca04e0b8162b666e09a1ae6)([osTimer](group__CMSIS__RTOS__TimerMgmt.html#ga1b8d670eaf964b2910fa06885e650678)(one_shot), [osTimerOnce](group__CMSIS__RTOS__TimerMgmt.html#gadac860eb9e1b4b0619271e6595ed83d9ad21712f8df5f97069c82dc9eec37b951), (void *)0); // creates a one-shot timer

    // Create periodic timer
    periodic_id = [osTimerCreate](group__CMSIS__RTOS__TimerMgmt.html#gaedd312bfdca04e0b8162b666e09a1ae6)([osTimer](group__CMSIS__RTOS__TimerMgmt.html#ga1b8d670eaf964b2910fa06885e650678)(periodic), [osTimerPeriodic](group__CMSIS__RTOS__TimerMgmt.html#gadac860eb9e1b4b0619271e6595ed83d9ab9c91f9699162edb09bb7c90c11c8788), (void *)5); // creates a periodic timer

    // Start timers
    [osTimerStart](group__CMSIS__RTOS__TimerMgmt.html#ga27a797a401b068e2644d1125f22a07ca)(one_shot_id, 500);
    [osTimerStart](group__CMSIS__RTOS__TimerMgmt.html#ga27a797a401b068e2644d1125f22a07ca)(periodic_id, 1500);
}
```

--------------------------------

### JavaScript Page Initialization and Search

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Driver/html/globals_defs_s.html

Contains JavaScript code snippets for initializing the document ready state, handling window load events, setting up search functionality, and navigating search results. These are common patterns in web-based documentation generated by tools like Doxygen.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
```

```javascript
$(document).ready(function() { searchBox.OnSelectItem(0); });
```

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

```javascript
$(document).ready(function(){initNavTree('globals_defs_s.html','');});
```

--------------------------------

### Install Git on Linux

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/README.md

Installs the Git version control system on Linux using apt-get. Git is crucial for cloning repositories and managing source code.

```bash
sudo apt-get install git
```

--------------------------------

### Windows WinUSB GUID for CMSIS-DAP v2

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DAP/html/group__DAP__ConfigUSB__gr.html

Provides the WinUSB GUID necessary for automatic driver installation of CMSIS-DAP v2 enabled debug adapters on Microsoft Windows (version 8 and above).

```APIDOC
{CDB3B5AD-293B-4663-AA36-1AAE46463776}
```

--------------------------------

### Page Initialization and Search Box Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Driver/html/functions_vars_l.html

JavaScript code for initializing page elements, handling window resizing, and setting up the search box functionality.

```JavaScript
$(document).ready(initResizable); $(window).load(resizeHeight);  $(document).ready(function() { searchBox.OnSelectItem(0); });
```

```JavaScript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

--------------------------------

### Start CLI for Examples Matching Names (PowerShell)

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/threadx/test/ports/README.md

Opens an interactive command-line interface (CLI) with the environment set for examples matching specific names, like 'Cortex M4' and 'ARM compiler v6'. This facilitates direct interaction with specific example builds.

```PowerShell
pwsh -Command .\azrtos_cicd.ps1 -MatchName 'Cortex M4','ARM compiler v6' -StartCli
```

--------------------------------

### Page Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Core/html/globals_defs.html

JavaScript code for initializing page elements, handling window resizing, and setting up the search functionality. This code is typically found in generated web documentation.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() {
  searchBox.OnSelectItem(0);
});

var searchBox = new SearchBox("searchBox", "search",false,'Search');

$(document).ready(function(){
  initNavTree('globals_defs.html','');
});
```

--------------------------------

### CMake Initial Project Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/test/cmake/mqtt_interoperability/regression/CMakeLists.txt

Configures the minimum required CMake version, sets a specific policy, and defines the project name and language. This is the foundational setup for the build system.

```cmake
cmake_minimum_required(VERSION 3.0.0 FATAL_ERROR)
cmake_policy(SET CMP0057 NEW)

project(regression_test LANGUAGES C)
```

--------------------------------

### Install CMake on Linux (Ubuntu 18.04/20.04)

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/README.md

Installs CMake version 3.10 or higher on Ubuntu 18.04 or 20.04 using apt-get. CMake is a cross-platform build system generator.

```bash
sudo apt-get install cmake
```

--------------------------------

### Page Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/globals_b.html

JavaScript code for document ready events, window resizing, and search box initialization.

```javascript
$(document).ready(initResizable); $(window).load(resizeHeight);  $(document).ready(function() { searchBox.OnSelectItem(0); });
```

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

```javascript
$(document).ready(function(){initNavTree('globals\_b.html','');});
```

--------------------------------

### Install Linux Build Tools

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/README.md

Installs essential build tools on Debian/Ubuntu-based Linux systems using apt-get. This includes compilers, archiving utilities, and network tools required for software development.

```bash
sudo apt-get update
sudo apt-get install build-essential curl zip unzip tar pkg-config
```

--------------------------------

### Install GCC Multilib on Ubuntu

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/threadx/ports_smp/linux/gnu/readme_threadx.txt

This command installs the necessary GCC multilib packages on Ubuntu systems, which is a prerequisite for building ThreadX SMP with GNU GCC tools.

```bash
sudo apt-get install gcc-multilib
```

--------------------------------

### JavaScript UI and Search Initialization

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Core/html/globals_d.html

Handles document ready events, search box initialization, and navigation tree setup for the documentation interface. These snippets manage the dynamic behavior of the generated documentation pages.

```JavaScript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() { searchBox.OnSelectItem(0); });
var searchBox = new SearchBox("searchBox", "search",false,'Search');
$(document).ready(function(){initNavTree('globals_d.html','');});
```

--------------------------------

### JavaScript Search Initialization

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/dir_abd1d8a41d439a254a6d729f0d888b04.html

Initializes the search functionality for the documentation website, including setting up the search box and handling item selection.

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

```javascript
$(document).ready(function() { searchBox.OnSelectItem(0); });
```

--------------------------------

### Install CMake on Linux (Ubuntu 16.04)

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/README.md

Installs a specific version of CMake (e.g., 3.18.3) on Ubuntu 16.04 by downloading and executing a shell script. This method is used when apt-get provides an older version.

```bash
wget https://cmake.org/files/v3.18/cmake-3.18.3-Linux-x86_64.sh # Use latest version.
sudo ./cmake-3.18.3-Linux-x86_64.sh --prefix=/usr
# When prompted to include the default subdirectory, enter `n` so to install in `/usr/local`.
```

--------------------------------

### Install vcpkg and Paho MQTT on Linux

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/README.md

Clones the vcpkg repository, checks out a specific commit, bootstraps it, and then installs the curl, cmocka, and paho-mqtt libraries for Linux. These are dependencies for Azure IoT C SDK.

```bash
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
git checkout <vcpkg commit> # Checkout the vcpkg commit per vcpkg-commit.txt above.
./bootstrap-vcpkg.sh
./vcpkg install --triplet x64-linux curl cmocka paho-mqtt
```

--------------------------------

### Page Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/globals_m.html

JavaScript code used for initializing the document ready state, handling window resizing, and setting up the search box functionality for the documentation interface.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() {
  searchBox.OnSelectItem(0);
});

var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

--------------------------------

### JavaScript Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/arm__variance__example_2Abstract_8txt.html

This snippet demonstrates common JavaScript patterns used in web-based documentation for initializing UI elements and search functionality. It includes document ready handlers and search box configurations.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);

$(document).ready(function() { searchBox.OnSelectItem(0); });

var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

--------------------------------

### Install vcpkg and Paho MQTT on Windows

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/README.md

Clones the vcpkg repository, checks out a specific commit, bootstraps it, and then installs the curl (with winssl), cmocka, and paho-mqtt libraries for Windows. Update the triplet per your system configuration.

```powershell
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
git checkout <vcpkg commit> # Checkout the vcpkg commit per vcpkg-commit.txt above.
.\bootstrap-vcpkg.bat
.\vcpkg.exe install --triplet x64-windows-static curl[winssl] cmocka paho-mqtt # Update triplet per your system.
```

--------------------------------

### SPI Driver Initialization and Usage Example

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Driver/html/group__spi__interface__gr.html

This C code example illustrates the initialization and basic usage of the ARM SPI driver. It shows how to get driver version, check capabilities, initialize the driver with a callback, and prepare for data transfer.

```c
/* SPI Driver */
extern ARM_DRIVER_SPI Driver_SPI0;

/* Test data buffers */
const uint8_t testdata_out[8] = { 0, 1, 2, 3, 4, 5, 6, 7 };
uint8_t testdata_in [8];

void mySPI_Thread(void const* arg)
{
    ARM_DRIVER_SPI* SPIdrv = &Driver_SPI0;
    osEvent evt;

#ifdef DEBUG
    ARM_DRIVER_VERSION version;
    ARM_SPI_CAPABILITIES drv_capabilities;

    version = SPIdrv->GetVersion();
    if (version.api < 0x200) /* requires at minimum API version 2.00 or higher */
    {
        /* error handling */
        return;
    }

    drv_capabilities = SPIdrv->GetCapabilities();
    /* Check capabilities like master/slave mode, data bits, etc. */
#endif

    /* Initialize SPI driver with event callback */
    int32_t ret = SPIdrv->Initialize(mySPI_callback);
    if (ret != ARM_DRIVER_OK) {
        /* Handle initialization error */
        return;
    }

    /* Power up the SPI peripheral */
    ret = SPIdrv->PowerControl(ARM_POWER_FULL);
    if (ret != ARM_DRIVER_OK) {
        /* Handle power control error */
        return;
    }

    /* Configure SPI parameters (e.g., mode, clock, data bits) */
    /* Example: Set to Master mode, 8 data bits, SPI mode 0 */
    ret = SPIdrv->Control(ARM_SPI_MODE_MASTER | ARM_SPI_DATA_BITS(8) | ARM_SPI_MODE_SPI,
                          1000000); /* Example clock frequency: 1 MHz */
    if (ret != ARM_DRIVER_OK) {
        /* Handle control error */
        return;
    }

    /* Start a transfer (e.g., send and receive 8 bytes) */
    ret = SPIdrv->Transfer(testdata_out, testdata_in, 8);
    if (ret != ARM_DRIVER_OK) {
        /* Handle transfer error */
        return;
    }

    /* Wait for transfer completion signal */
    evt = osSignalWait(0x01, osWaitForever);
    if (evt.value.v == 0x01) {
        /* Transfer completed successfully, process testdata_in */
    }
}
```

--------------------------------

### JavaScript Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/Driver/html/globals_n.html

Contains common JavaScript code used for document ready events, search box initialization, and navigation tree setup within the documentation.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() { searchBox.OnSelectItem(0); });
var searchBox = new SearchBox("searchBox", "search",false,'Search');
$(document).ready(function(){initNavTree('globals_n.html','');});
```

--------------------------------

### JavaScript Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/arm__fir__example_2ARMCM4__FP__config_8txt.html

This snippet includes common JavaScript patterns for document ready events, search box initialization, and navigation tree setup, typical in web-based documentation generated by tools like Doxygen.

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
$(document).ready(function() {
  searchBox.OnSelectItem(0);
});
$(document).ready(function(){
  initNavTree('arm__fir__example_2ARMCM4__FP__config_8txt.html','');
});
$(document).ready(initResizable);
$(window).load(resizeHeight);
```

--------------------------------

### Device Twin Properties Example

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/docs/how_to_iot_hub_samples_vxworks.md

An example JSON structure illustrating device twin properties, including connection state, authentication type, and desired/reported properties for an IoT device.

```json
{
     "connectionState": "Connected",
     "lastActivityTime": "2021-09-06T08:49:54.8803577Z",
     "cloudToDeviceMessageCount": 0,
     "authenticationType": "sas",
     "x509Thumbprint": {
         "primaryThumbprint": null,
         "secondaryThumbprint": null
     },
     "modelId": "",
     "version": 11,
     "properties": {
         "desired": {
             "device_count": 100,
             "$metadata": {
                 "$lastUpdated": "2021-09-06T08:52:44.9300429Z",
                 "$lastUpdatedVersion": 4,
                 "device_count": {
                     "$lastUpdated": "2021-09-06T08:52:44.9300429Z",
                     "$lastUpdatedVersion": 4
                 }
             },
             "$version": 4
         },
         "reported": {
             "device_count": 100,
             "$metadata": {
                 "$lastUpdated": "2021-09-06T08:52:44.9962991Z",
                 "device_count": {
                     "$lastUpdated": "2021-09-06T08:52:44.9962991Z"
                 }
             },
             "$version": 7
         }
     },
     "capabilities": {
         "iotEdge": false
     }
  }
```

--------------------------------

### Install CMake on Ubuntu 18.04/20.04

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/docs/how_to_iot_hub_samples_linux.md

Installs the CMake build system using the apt package manager for specific Ubuntu versions (18.04 or 20.04). CMake is a cross-platform build system generator.

```bash
sudo apt-get install cmake
```

--------------------------------

### Page Initialization and Search Setup

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/globals_func_s.html

Initializes the document ready state, sets up search functionality, and handles window resizing for responsive layout. This script is crucial for the interactive elements of the documentation website.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() { searchBox.OnSelectItem(0); });
```

--------------------------------

### IoT Hub Client MQTT Integration Example

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/docs/iot/coding_patterns.md

Demonstrates how to integrate a custom MQTT stack with the Azure IoT Hub Client SDK. This example guides users through initializing the client, obtaining connection details, subscribing to topics, connecting, sending telemetry, and handling incoming messages. Note that this is a simplified example and may require adjustments for compilation and full functionality.

```C
#include <az/az_core.h>
#include <az/az_iot.h>

az_iot_hub_client my_client;
static az_span my_iothub_hostname = AZ_SPAN_LITERAL_FROM_STR("<your hub fqdn here>");
static az_span my_device_id = AZ_SPAN_LITERAL_FROM_STR("<your device id here>");

//Make sure the buffer is large enough to fit the user name (100 is an example)
static char my_mqtt_user_name[100];

//Make sure the buffer is large enough to fit the client id (16 is an example)
static char my_mqtt_client_id[16];

//This assumes an X509 Cert. SAS keys may also be used.
static const char my_device_cert[] = "-----BEGIN CERTIFICATE-----abcdefg-----END CERTIFICATE-----";

static char telemetry_topic[128];
static char telemetry_payload[] = "Hello World";

void handle_iot_message(mqtt_client_message* msg);
void send_telemetry_message(void);

int main(void)
{
  //Get the default IoT Hub options
  az_iot_hub_client_options options = az_iot_hub_client_options_default();

  //Initialize the client with hostname, device id, and options
  az_iot_hub_client_init(&my_client, my_iothub_hostname, my_device_id, &options);

  //Get the MQTT user name to connect
  az_iot_hub_client_get_user_name(&my_client, my_mqtt_user_name,
                sizeof(my_mqtt_user_name), NULL);

  //Get the MQTT client id to connect
  az_iot_hub_client_get_client_id(&my_client, my_mqtt_client_id,
                sizeof(my_mqtt_client_id), NULL);

  //Initialize MQTT client with necessary parameters (example params shown)
  mqtt_client my_mqtt_client;
  mqtt_client_init(&my_mqtt_client, my_iothub_hostname, my_mqtt_client_id);

  //Subscribe to c2d messages
  mqtt_client_subscribe(&my_mqtt_client, AZ_IOT_HUB_CLIENT_C2D_SUBSCRIBE_TOPIC);

  //Subscribe to device methods
  mqtt_client_subscribe(&my_mqtt_client, AZ_IOT_HUB_CLIENT_METHODS_SUBSCRIBE_TOPIC);

  //Subscribe to twin patch topic
  mqtt_client_subscribe(&my_mqtt_client, AZ_IOT_HUB_CLIENT_TWIN_PATCH_SUBSCRIBE_TOPIC);

  //Subscribe to twin response topic
  mqtt_client_subscribe(&my_mqtt_client, AZ_IOT_HUB_CLIENT_TWIN_RESPONSE_SUBSCRIBE_TOPIC);

  //Connect to the IoT Hub with your chosen mqtt stack
  mqtt_client_connect(&my_mqtt_client, my_mqtt_user_name, my_device_cert);

  //This example would run to receive any incoming message and send a telemetry message five times
  int iterations = 0;
  mqtt_client_message msg;
  while(iterations++ < 5)
  {
    if(mqtt_client_receive(&msg))
    {
      handle_iot_message(&msg);
    }

    send_telemetry_message();
  }

  //Disconnect from the IoT Hub
  mqtt_client_disconnect(&my_mqtt_client);

  //Destroy the mqtt client
  mqtt_client_destroy(&my_mqtt_client);
}

void send_telemetry_message(void)
{
  //Get the topic to send a telemetry message
  az_iot_hub_client_telemetry_get_publish_topic(&my_client, NULL, telemetry_topic, sizeof(telemetry_topic), NULL);

  //Send the telemetry message with the MQTT client
  mqtt_client_publish(telemetry_topic, telemetry_payload, AZ_HUB_CLIENT_DEFAULT_MQTT_TELEMETRY_QOS);
}

void handle_iot_message(mqtt_client_message* msg)
{
  //Initialize the incoming topic to a span
  az_span incoming_topic = az_span_create(msg->topic, msg->topic_len);

  //The message could be for three features so parse the topic to see which it is for
  az_iot_hub_client_method_request method_request;
  az_iot_hub_client_c2d_request c2d_request;
  az_iot_hub_client_twin_response twin_response;
  if (az_result_succeeded(az_iot_hub_client_methods_parse_received_topic(&my_client, incoming_topic, &method_request)))
  {
    //Handle the method request
  }
  else if (az_result_succeeded(az_iot_hub_client_c2d_parse_received_topic(&my_client, incoming_topic, &c2d_request)))
  {
    //Handle the c2d message
  }
  else if (az_result_succeeded(az_iot_hub_client_twin_parse_received_topic(&my_client, incoming_topic, &twin_response)))
  {
    //Handle the twin message
  }
}

```

--------------------------------

### Website Initialization and Search Functionality

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/DSP/html/SupportFunctions_8c.html

JavaScript code snippets used for initializing the documentation website's layout and search functionality. These are standard patterns for interactive web documentation.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
```

```javascript
$(document).ready(function() { searchBox.OnSelectItem(0); });
```

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

--------------------------------

### JavaScript for Page Initialization and Search

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/NN/html/globals_d.html

This snippet includes common JavaScript functions used in web documentation frameworks like Doxygen for initializing page elements, handling window resizing, and managing search functionality.

```javascript
$(document).ready(initResizable);
$(window).load(resizeHeight);
$(document).ready(function() { searchBox.OnSelectItem(0); });
```

```javascript
var searchBox = new SearchBox("searchBox", "search",false,'Search');
```

```javascript
$(document).ready(function(){initNavTree('globals_d.html','');});
```

--------------------------------

### Install vcpkg and Paho MQTT

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/docs/how_to_iot_hub_samples_windows.md

Installs the vcpkg package manager and the Eclipse Paho MQTT C client using PowerShell. This process may take a significant amount of time. Ensure you checkout the correct vcpkg commit as specified.

```powershell
PS C:\> git clone https://github.com/Microsoft/vcpkg.git
PS C:\> cd vcpkg
PS C:\vcpkg> git checkout <vcpkg commit> # Checkout the vcpkg commit per vcpkg-commit.txt above.
PS C:\vcpkg> .\bootstrap-vcpkg.bat
PS C:\vcpkg> .\vcpkg.exe install --triplet x64-windows-static curl[winssl] cmocka paho-mqtt # Update triplet per your system.
PS C:\vcpkg> cd ..
```

--------------------------------

### Application Threads and Initialization

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Projects/STM32H7S78-DK/Applications/NetXDuo/Nx_MQTT_Client_wifi/README.md

Describes the initialization of NetX/NetXDuo resources and the creation of application threads with specific priorities and start flags.

```c
/* NetX resources allocation */
NX_PACKET_POOL packet_pool;
NX_IP ip_instance;

/* Enable protocols */
nx_ip_enable(&ip_instance, nx_nx_driver_eth0_hardware_interface_send, nx_nx_driver_eth0_hardware_interface_packet_receive);
nx_arp_enable(&ip_instance);
nx_icmp_enable(&ip_instance);
nx_udp_enable(&ip_instance);
nx_tcp_enable(&ip_instance);

/* DHCP client creation */
NX_DHCP_CLIENT dhcp_client;
nx_dhcp_create(&ip_instance, "dhcp_client", &dhcp_client);

/* Thread creation */
tx_thread_create(&nx_app_thread, "NxAppThread", nx_app_thread_entry, 0, 
                 nx_app_thread_stack, TX_APP_THREAD_STACK_SIZE, 10, 10, TX_NO_TIME_SLICE, TX_AUTO_START);

tx_thread_create(&app_mqtt_client_thread, "AppMQTTClientThread", app_mqtt_client_thread_entry, 0, 
                 app_mqtt_client_thread_stack, APP_MQTT_CLIENT_THREAD_STACK_SIZE, 3, 3, TX_NO_TIME_SLICE, TX_DONT_START);

tx_thread_create(&app_sntp_thread, "AppSNTPThread", app_sntp_thread_entry, 0, 
                 app_sntp_thread_stack, APP_SNTP_THREAD_STACK_SIZE, 5, 5, TX_NO_TIME_SLICE, TX_DONT_START);
```

--------------------------------

### Start Application Thread Creation Example

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Drivers/CMSIS/Documentation/RTOS/html/group__CMSIS__RTOS__Mail.html

This C function, StartApplication, is responsible for initializing the application by creating a mail queue and then spawning two threads: a send thread and the receive thread. It uses osMailCreate to set up the mail queue and osThreadCreate to start the execution of the respective threads.

```C
void StartApplication (void) {
    mail = osMailCreate(osMailQ(mail), NULL); // create mail queue
    tid_thread1 = osThreadCreate(osThread(send_thread), NULL);
    tid_thread2 = osThreadCreate(osThread(recv_thread), NULL);
}
```

--------------------------------

### Install CMake on Ubuntu 16.04

Source: https://github.com/stmicroelectronics/x-cube-azrtos-h7rs/blob/main/Middlewares/ST/netxduo/addons/azure_iot/azure-sdk-for-c/sdk/samples/iot/docs/how_to_iot_hub_samples_linux.md

Downloads, makes executable, and installs a specific version of CMake from a script for older Ubuntu versions like 16.04. This ensures compatibility when the system's default CMake version is insufficient.

```bash
~$ wget https://cmake.org/files/v3.18/cmake-3.18.3-Linux-x86_64.sh # Use latest version.
~$ sudo chmod 777 cmake-3.18.3-Linux-x86_64.sh # Update permissions to execute script.
~$ sudo ./cmake-3.18.3-Linux-x86_64.sh --prefix=/usr
```
Tokens:
Raw