Silicon Labs CircuitPython Applications v1.0.1 - Update documentation

silabs-DanielN · web-flow · commit cf3cedfd12f1 · 2023-06-20T15:43:29.000+02:00
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 
 # Silicon Labs CircuitPython Applications #
 
-[![Version Badge](https://img.shields.io/badge/-v1.0.0-green)](https://github.com/SiliconLabs/circuitpython_applications/releases)
+[![Version Badge](https://img.shields.io/badge/-v1.0.1-green)](https://github.com/SiliconLabs/circuitpython_applications/releases)
 [![CircuitPython](https://img.shields.io/badge/CircuitPython-v8.2.0+-green)](https://circuitpython.org/downloads?q=silabs)
 ![License badge](https://img.shields.io/badge/License-Zlib-green)
 
diff --git a/cp_bluetooth_distance_monitor/README.md b/cp_bluetooth_distance_monitor/README.md
@@ -20,13 +20,17 @@ The block diagram of this application is shown in the image below:
 
 The sensor and OLED display can easily connected with Sparkfun Thing Plus for Matter - MGM240 development kits via Qwiic connector.
 
+## Prerequisites ##
+
+Getting started with [CircuitPython on EFR32 boards](../doc/running_circuitpython.md).
+
 ## Setup ##
 
 To run the example you need to install **Thonny** editor and then follow the steps below:
 
-To run the example you need to install **Thonny** editor and then follow the steps below:
+1. Flash the corresponding CircuitPython binary for your board. You can visit [circuitpython.org/downloads](https://circuitpython.org/downloads?q=silabs) to download the binary.
 
-1. Flash the corresponding CircuitPython binary for your board. You can visit [circuitpython.org](https://circuitpython.org/) to download the binary.
+> **_NOTE:_** The examples in this repository require CircuitPython v8.2.0 or higher.
 
 2. Install the necessary libraries from Adafruit CircuitPython bundle. You can download the bundle from [here](https://circuitpython.org/libraries). The libraries that used in this project and their version are list in this table below.
 
diff --git a/cp_bluetooth_environmental_sensing/README.md b/cp_bluetooth_environmental_sensing/README.md
@@ -36,11 +36,17 @@ Note: Any other BLE-capable device can be a client device, for instance a simple
 
 The environmental combo, OLED display and SparkFun Thing Plus Matter board can easily connect to each other via Qwiic I2C connector.
 
+## Prerequisites ##
+
+Getting started with [CircuitPython on EFR32 boards](../doc/running_circuitpython.md).
+
 ## Setup ##
 
 To run the example you need to install **Thonny** editor and then follow the steps below:
 
-1. Flash the corresponding CircuitPython binary for your board. You can visit [circuitpython.org](https://circuitpython.org/) to download the binary.
+1. Flash the corresponding CircuitPython binary for your board. You can visit [circuitpython.org/downloads](https://circuitpython.org/downloads?q=silabs) to download the binary.
+
+> **_NOTE:_** The examples in this repository require CircuitPython v8.2.0 or higher.
 
 2. Install the necessary libraries from Adafruit CircuitPython bundle. You can download the bundle from [here](https://circuitpython.org/libraries). The libraries that used in this project and their version are list in this table below.
     - Sensor device
diff --git a/cp_non_wireless_display_demo/README.md b/cp_non_wireless_display_demo/README.md
@@ -18,11 +18,17 @@ This example can be used as a learning tool for developers who want to work with
 
 The RGB LED Matrix can easily connected with Sparkfun Thing Plus for Matter - MGM240 development kits via Qwiic connector.
 
+## Prerequisites ##
+
+Getting started with [CircuitPython on EFR32 boards](../doc/running_circuitpython.md).
+
 ## Setup ##
 
 To run the example you need to install **Thonny** editor and then follow the steps below:
 
-1. Flash the corresponding CircuitPython binary for your board. You can visit [circuitpython.org](https://circuitpython.org) to download the binary.
+1. Flash the corresponding CircuitPython binary for your board. You can visit [circuitpython.org/downloads](https://circuitpython.org/downloads?q=silabs) to download the binary.
+
+> **_NOTE:_** The examples in this repository require CircuitPython v8.2.0 or higher.
 
 2. Install the necessary libraries from Adafruit CircuitPython bundle. You can download the bundle from [here](https://circuitpython.org/libraries).
 
diff --git a/cp_rgb_display_drawing_ili9341/README.md b/cp_rgb_display_drawing_ili9341/README.md
@@ -36,6 +36,10 @@ Listed below are the port and pin mappings for working with this example.
     | PB0 | YM(Y-) | AN |
     | PB1 | XM(Y+) | AN |
 
+## Prerequisites ##
+
+Getting started with [CircuitPython on EFR32 boards](../doc/running_circuitpython.md).
+
 ## Setup ##
 
 To run the example you need to install **Thonny** editor and then follow the steps below:
@@ -48,7 +52,9 @@ To run the example you need to install **Thonny** editor and then follow the ste
 
 4. Run the scripts on the board.
 
-**Note:** Make sure that you have flashed the corresponding CircuitPython firmware for your board. You can visit [circuitpython.org](https://circuitpython.org/) to download the firmware.
+**Note:** Make sure that you have flashed the corresponding CircuitPython firmware for your board. You can visit [circuitpython.org/downloads](https://circuitpython.org/downloads?q=silabs) to download the firmware.
+
+> **_NOTE:_** The examples in this repository require CircuitPython v8.2.0 or higher.
 
 ## How it Works ##
 
diff --git a/cp_temperature_and_humidty_monitor/README.md b/cp_temperature_and_humidty_monitor/README.md
@@ -19,11 +19,17 @@ The block diagram of this application is shown in the image below:
 The RGB LED Matrix display can easily connect with Silicon Labs
 EFR32xG24 Dev Kit via a Qwiic connector.
 
+## Prerequisites ##
+
+Getting started with [CircuitPython on EFR32 boards](../doc/running_circuitpython.md).
+
 ## Setup ##
 
 To run the example you need to install **Thonny** editor and then follow the steps below:
 
-1. Flash the corresponding CircuitPython binary for your board. You can visit [circuitpython.org](https://circuitpython.org/) to download the binary.
+1. Flash the corresponding CircuitPython binary for your board. You can visit [circuitpython.org/downloads](https://circuitpython.org/downloads?q=silabs) to download the binary.
+
+> **_NOTE:_** The examples in this repository require CircuitPython v8.2.0 or higher.
 
 2. Install the necessary libraries from the Adafruit CircuitPython bundle. You can download the bundle from [here](https://circuitpython.org/libraries). The libraries that were used in this project and their version are listed in the table below.
 
diff --git a/cp_xg24_dev_kit_sensors/README.md b/cp_xg24_dev_kit_sensors/README.md
@@ -29,6 +29,9 @@ The xG24 Dev Kit and TFT display can connect via SPI interface. You can make the
 |  9 (PB0)  |  CS  |
 |  3 (PB2)  |  D/C  |
 
+## Prerequisites ##
+
+Getting started with [CircuitPython on EFR32 boards](../doc/running_circuitpython.md).
 
 ## Setup ##
 
@@ -46,6 +49,8 @@ To run the example you need to install Thonny editor, then follow the below step
 
 - Make sure that you have flashed the corresponding CircuitPython firmware for your board. You can visit [circuitpython.org](https://circuitpython.org/board/silabs_devkit_xg24_brd2601b/) to download the firmware.
 
+> **_NOTE:_** The examples in this repository require CircuitPython v8.2.0 or higher.
+
 ## How it works ##
 
 This project demonstrates the use of the CircuitPython IL9341 RGB Display driver with the Silicon Labs xG24 Dev Kit.
diff --git a/doc/running_circuitpython.md b/doc/running_circuitpython.md
@@ -5,10 +5,12 @@ Official binaries for all supported boards are available through [circuitpython.
 
 If you want to make changes, you might clone and re-build the source and firmware.bin file can be found in the build folder corresponding to the appropriate board, such as build-sparkfun_thingplus_matter_mgm240p_brd2704a
 
+> **_NOTE:_** The examples in this repository require CircuitPython v8.2.0 or higher.
+
 ## Flash firmware
 
 To flash the firmware file into the board, you need to use Simplicity Commander.
-You can install Simplicity Commander using Simplicity Studio or downloading standalone versions by following [UG162: Simplicity Commander Reference Guide](https://www.silabs.com/documents/public/user-guides/ug162-simplicity-commander-reference-guide.pdf).
+You can install Simplicity Commander using Simplicity Studio or downloading standalone version by following [this Knowledge Article](https://community.silabs.com/s/article/simplicity-commander?language=en_US).
 
 To flash the firmware into the xG24 kit using Simplicity Commander, follow these simple steps:
 
