Silicon Labs CircuitPython Applications v1.0.0

Author: silabs-DanielN

README.md

@@ -1,2 +1,69 @@
-# circuitpython_applications
-Application examples for CircuitPython
+<table border="0">
+  <tr>
+    <td align="left" valign="middle">
+    <h1>EFR32 CircuitPython Application Examples</h1>
+  </td>
+  <td align="left" valign="middle">
+    <a href="https://www.silabs.com/wireless/bluetooth">
+      <img src="http://pages.silabs.com/rs/634-SLU-379/images/WGX-transparent.png"  title="Silicon Labs Wireless Gecko MCUs" alt="EFM32 32-bit Microcontrollers" width="250"/>
+    </a>
+  </td>
+  </tr>
+</table>
+
+# Silicon Labs CircuitPython Applications #
+
+[![Version Badge](https://img.shields.io/badge/-v1.0.0-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)
+
+This repository contains example projects that demonstrate various applications using CircuitPython on Silicon Labs Development Kits.
+All examples in this repository are considered to be EXPERIMENTAL QUALITY, which implies that the code provided in the repository has not been formally tested and is provided as-is. It is not suitable for production environments.
+
+## Examples ##
+
+| No | Example name | Link to example |
+|:--:|:-------------|:---------------:|
+|  1 | CircuitPython - Bluetooth - Distance Monitor (VL53L1X) | [Click Here](./cp_bluetooth_distance_monitor)|
+|  2 | CircuitPython - Bluetooth - Environmental Sensing (CCS811/BME280) | [Click Here](./cp_bluetooth_environmental_sensing) |
+|  3 | CircuitPython - Non-Wireless Display Demo (IS31FL3741) | [Click Here](./cp_non_wireless_display_demo) |
+|  4 | CircuitPython - RGB Display Drawing (ILI9341) | [Click Here](./cp_rgb_display_drawing_ili9341) |
+|  5 | CircuitPython - Temperature and Humidity Monitor with LED Matrix Display (SI2071/IS31FL3741) | [Click Here](./cp_temperature_and_humidty_monitor) |
+|  6 | CircuitPython - xG24 Dev Kit Sensors (ILI9341) | [Click Here](./cp_xg24_dev_kit_sensors) |
+
+
+## Get CircuitPython firmware ##
+
+Official binaries for all Silicon Labs supported boards are available through
+[circuitpython.org/downloads](https://circuitpython.org/downloads?q=silabs). The site includes stable, unstable and
+continuous builds. Full release notes are available through
+[GitHub releases](https://github.com/adafruit/circuitpython/releases) as well.
+
+
+> **_NOTE:_** The examples in this repository require CircuitPython v8.2.0 or higher.
+
+
+## Project structure
+
+* **bin**
+  * The bin folder contains binary files required by the project. (e.g.: fonts, pictures)
+* **lib**
+  * The lib folder contains precompiled libraries provided by Adafruit, this folder provides the application logic related files too. These libraries and files are required to run the project.
+* **src**
+  * The src folder provides the code.py named file, this file is the entry point of the example project.
+
+The files from the src and bin folders should be copied into the root of the target board's file system. 
+
+Libraries and other application modules should be copied from the lib folder into the lib named folder on the target board.
+
+## Documentation ##
+
+Getting started with [CircuitPython on EFR32 boards](doc/running_circuitpython.md).
+
+For more information, visit the [Developer documentation](https://docs.silabs.com/application-examples/latest/) portal of Silicon Laboratories.
+
+## Reporting Bugs/Issues and Posting Questions and Comments ##
+
+To report bugs in the Application Examples projects, please create a new "Issue" in the "Issues" section of this repo. Please reference the board, project, and source files associated with the bug, and reference line numbers. If you are proposing a fix, also include information on the proposed fix. Since these examples are provided as-is, there is no guarantee that these examples will be updated to fix these issues.
+
+Questions and comments related to these examples should be made by creating a new "Issue" in the "Issues" section of this repo.

cp_bluetooth_distance_monitor/README.md

@@ -0,0 +1,79 @@
+# CircuitPython - Bluetooth - Distance Monitor (VL53L1X) #
+
+## Overview ##
+
+This project shows a demonstration of a Bluetooth Low Energy distance monitor system using SparkFun Thing Plus Matter - MGM240P development kit and the integrated CircuitPython BLE Stack.
+
+The block diagram of this application is shown in the image below:
+
+![overview](docs/overview.png)
+
+## Hardware Required ##
+
+- [SparkFun Thing Plus Matter - MGM240P](https://www.sparkfun.com/products/20270)
+
+- [SparkFun Distance Sensor Breakout - 4 Meter, VL53L1X (Qwiic)](https://www.sparkfun.com/products/14722)
+
+- [OLED Display - SSD1306](https://www.sparkfun.com/products/14532)
+
+## Connections Required ##
+
+The sensor and OLED display can easily connected with Sparkfun Thing Plus for Matter - MGM240 development kits via Qwiic connector.
+
+## 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](https://circuitpython.org/) to download the binary.
+
+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.
+
+    | Library           | Version           |
+    |:----------------- |:------------------|
+    | adafruit_framebuf |       1.6.1       |
+    | adafruit_ssd1306  |       2.12.2      |
+    | adafruit_vl53l1x  |       1.1.10      |
+
+3. Upload all the libraries of the lib folder to the CircuitPython device. The binary files should not be uploaded to lib folder in the device, they should have the same hierarchy as the code.py file.
+
+4. Copy the content of the code.py and paste it to the code.py file on the CircuitPython device.
+
+5. Run the scripts on the board.
+
+
+## How it Works ##
+
+- ### Initialization ###
+
+    ![Initialization](docs/init.png).
+
+- ### Runtime operation ###
+
+    ![Runtime operation](docs/run_time.png).
+
+- ### GATT database ###
+
+  - [Service] Distance Monitor
+    - [Char] Lower Threshold Value - threshold_value_lower
+      - [R] Get lower threshold value (mm)
+      - [W] Set lower threshold value (mm)
+    - [Char] Upper Threshold Value - threshold_value_upper
+      - [R] Get upper threshold value (mm)
+      - [W] Set upper threshold value (mm)
+    - [Char] Threshold Mode - threshold_mode
+      - [R] Get threshold mode (0-2)
+      - [W] Set threshold mode (0-2)
+    - [Char] Range Mode - range_mode
+      - [R] Get configured range mode (0-1)
+      - [W] Set range mode (0-1)
+    - [Char] Notification Status - notification_status
+      - [R] Get configured notification status (0-2)
+      - [W] Set notification status (0-2)
+
+## Output  ##
+
+Run the **code.py** file, monitor the OLED, and try to place your hand beyond the sensor you will see the result below.
+
+![result](docs/result.GIF)

cp_bluetooth_distance_monitor/bin/font4x6.bin

@@ -0,0 +1,76 @@
+"""
+*****************************************************************************
+Copyright 2023 Silicon Laboratories Inc. www.silabs.com
+*****************************************************************************
+SPDX-License-Identifier: Zlib
+
+The licensor of this software is Silicon Laboratories Inc.
+
+This software is provided \'as-is\', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.
+
+*****************************************************************************
+# EXPERIMENTAL QUALITY
+This code has not been formally tested and is provided as-is. It is not
+suitable for production environments. In addition, this code will not be
+maintained and there may be no bug maintenance planned for these resources.
+Silicon Labs may update projects from time to time.
+******************************************************************************
+"""
+
+
+class Configuration:
+    def __init__(
+        self,
+        lower_threshold,
+        upper_threshold,
+        threshold_mode,
+        range_mode,
+        notification_status,
+    ) -> None:
+        self.lower_threshold = lower_threshold
+        self.upper_threshold = upper_threshold
+        self.threshold_mode = threshold_mode
+        self.range_mode = range_mode
+        self.notification_status = notification_status
+
+    @staticmethod
+    def check_change(a, b):
+        return b if a != b else None
+
+    def changes(self, __value: object):
+        changes = {
+            "lower_threshold": self.check_change(
+                self.lower_threshold, __value.lower_threshold
+            ),
+            "upper_threshold": self.check_change(
+                self.upper_threshold, __value.upper_threshold
+            ),
+            "threshold_mode": self.check_change(
+                self.threshold_mode, __value.threshold_mode
+            ),
+            "range_mode": self.check_change(self.range_mode, __value.range_mode),
+            "notification_status": self.check_change(
+                self.notification_status, __value.notification_status
+            ),
+        }
+        return {k: v for k, v in changes.items() if v is not None}
+
+    def update(self, key: str, value) -> None:
+        setattr(self, key, value)
+
+    def __eq__(self, __value: object) -> bool:
+        return not bool(self.changes(__value))