commit d4db0d293462d06ae8ca1b1bbd646e29c000012b Author: Priec Date: Thu Oct 9 10:00:53 2025 +0200 blinky example diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..f345051 --- /dev/null +++ b/flake.lock @@ -0,0 +1,61 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1731533236, + "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1759386674, + "narHash": "sha256-wg1Lz/1FC5Q13R+mM5a2oTV9TA9L/CHHTm3/PiLayfA=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "625ad6366178f03acd79f9e3822606dd7985b657", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixpkgs-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..d8212aa --- /dev/null +++ b/flake.nix @@ -0,0 +1,107 @@ +{ + description = "Mbed OS dev env (STM32U575ZI-Q) using mbed-tools v2 + uv"; + + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; + flake-utils.url = "github:numtide/flake-utils"; + }; + + outputs = { self, nixpkgs, flake-utils }: + flake-utils.lib.eachSystem [ + "x86_64-linux" + "aarch64-linux" + "x86_64-darwin" + "aarch64-darwin" + ] (system: + let + pkgs = import nixpkgs { inherit system; }; + + # ARM Embedded Toolchain + armGcc = + if pkgs ? arm-none-eabi-gcc + then pkgs.arm-none-eabi-gcc + else pkgs.gcc-arm-embedded; + + # Use a Python version that works well with mbed-tools today + pythonPin = "3.12"; + + # Wrapper: mbed-tools via uvx, pin Python and ensure setuptools is present + mbedTools = pkgs.writeShellScriptBin "mbed-tools" '' + exec ${pkgs.uv}/bin/uvx \ + --python ${pythonPin} \ + --with setuptools \ + --from mbed-tools mbed-tools "$@" + ''; + + # Wrapper: pyocd via uvx, pin Python for compatibility + pyOcd = pkgs.writeShellScriptBin "pyocd" '' + exec ${pkgs.uv}/bin/uvx \ + --python ${pythonPin} \ + --from pyocd pyocd "$@" + ''; + in { + devShells.default = pkgs.mkShell { + packages = [ + pkgs.uv + pkgs.python3 + pkgs.git + pkgs.mercurial + pkgs.cmake + pkgs.ninja + armGcc + pkgs.openocd + pkgs.stlink + mbedTools + pyOcd + ]; + + # Make compiler visible for Mbed + MBED_GCC_ARM_PATH = "${armGcc}/bin"; + MBED_TARGET = "NUCLEO_U575ZI_Q"; + + shellHook = '' + export PATH="${armGcc}/bin:$PATH" + export UV_TOOL_DIR="$PWD/.uv-tools" + + echo + echo "✅ Mbed dev shell ready" + echo " - Target : $MBED_TARGET" + echo " - Compiler : ${armGcc}" + echo " - Commands : mbed-tools, pyocd, openocd, st-flash" + echo + ''; + }; + + # nix run .#build-blinky -> builds example + apps.build-blinky = flake-utils.lib.mkApp { + drv = pkgs.writeShellScriptBin "build-blinky" '' + set -euo pipefail + + export PATH="${armGcc}/bin:$PATH" + export MBED_GCC_ARM_PATH="${armGcc}/bin" + export MBED_TARGET="NUCLEO_U575ZI_Q" + + workdir="mbed-os-example-blinky" + if [ ! -d "$workdir" ]; then + git clone --depth 1 \ + https://github.com/ARMmbed/mbed-os-example-blinky "$workdir" + fi + cd "$workdir" + + # Install deps (fetches mbed-os) + ${mbedTools}/bin/mbed-tools deploy + + # Configure + build + ${mbedTools}/bin/mbed-tools configure \ + -m "$MBED_TARGET" -t GCC_ARM + ${mbedTools}/bin/mbed-tools compile \ + -m "$MBED_TARGET" -t GCC_ARM -c + + echo + echo "🎉 Build complete" + echo " Check BUILD/NUCLEO_U575ZI_Q/GCC_ARM/ for binaries" + echo + ''; + }; + }); +} diff --git a/mbed-os-example-blinky/.gitignore b/mbed-os-example-blinky/.gitignore new file mode 100644 index 0000000..c9deafb --- /dev/null +++ b/mbed-os-example-blinky/.gitignore @@ -0,0 +1,22 @@ +.build +.mbed +projectfiles +*.py* + +# Local build directories +cmake_build/ +BUILD/ +mbed-os/ +.mbed/ +.mbedignore +*.elf +*.bin +*.hex +*.map + +# IDE and temporary files +.vscode/ +.idea/ +*.log +*.pyc +__pycache__/ diff --git a/mbed-os-example-blinky/CMakeLists.txt b/mbed-os-example-blinky/CMakeLists.txt new file mode 100644 index 0000000..db75bad --- /dev/null +++ b/mbed-os-example-blinky/CMakeLists.txt @@ -0,0 +1,33 @@ +# Copyright (c) 2020 ARM Limited. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 + +cmake_minimum_required(VERSION 3.19.0 FATAL_ERROR) + +set(MBED_PATH ${CMAKE_CURRENT_SOURCE_DIR}/mbed-os CACHE INTERNAL "") +set(MBED_CONFIG_PATH ${CMAKE_CURRENT_BINARY_DIR} CACHE INTERNAL "") +set(APP_TARGET mbed-os-example-blinky) + +include(${MBED_PATH}/tools/cmake/app.cmake) + +project(${APP_TARGET}) + +add_subdirectory(${MBED_PATH}) + +add_executable(${APP_TARGET}) + +target_sources(${APP_TARGET} + PRIVATE + main.cpp +) + +target_link_libraries(${APP_TARGET} + PRIVATE + mbed-os +) + +mbed_set_post_build(${APP_TARGET}) + +option(VERBOSE_BUILD "Have a verbose build process") +if(VERBOSE_BUILD) + set(CMAKE_VERBOSE_MAKEFILE ON) +endif() diff --git a/mbed-os-example-blinky/CONTRIBUTING.md b/mbed-os-example-blinky/CONTRIBUTING.md new file mode 100644 index 0000000..f433ee4 --- /dev/null +++ b/mbed-os-example-blinky/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributing to Mbed OS + +Mbed OS is an open-source, device software platform for the Internet of Things. Contributions are an important part of the platform, and our goal is to make it as simple as possible to become a contributor. + +To encourage productive collaboration, as well as robust, consistent and maintainable code, we have a set of guidelines for [contributing to Mbed OS](https://os.mbed.com/docs/mbed-os/latest/contributing/index.html). diff --git a/mbed-os-example-blinky/LICENSE b/mbed-os-example-blinky/LICENSE new file mode 100644 index 0000000..59cd3f8 --- /dev/null +++ b/mbed-os-example-blinky/LICENSE @@ -0,0 +1,165 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, "control" means (i) the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising +permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +"Object" form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +"submitted" means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +2. Grant of Copyright License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +3. Grant of Patent License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +You must give any other recipients of the Work or Derivative Works a copy of +this License; and +You must cause any modified files to carry prominent notices stating that You +changed the files; and +You must retain, in the Source form of any Derivative Works that You distribute, +all copyright, patent, trademark, and attribution notices from the Source form +of the Work, excluding those notices that do not pertain to any part of the +Derivative Works; and +If the Work includes a "NOTICE" text file as part of its distribution, then any +Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices +that do not pertain to any part of the Derivative Works, in at least one of the +following places: within a NOTICE text file distributed as part of the +Derivative Works; within the Source form or documentation, if provided along +with the Derivative Works; or, within a display generated by the Derivative +Works, if and wherever such third-party notices normally appear. The contents of +the NOTICE file are for informational purposes only and do not modify the +License. You may add Your own attribution notices within Derivative Works that +You distribute, alongside or as an addendum to the NOTICE text from the Work, +provided that such additional attribution notices cannot be construed as +modifying the License. +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +5. Submission of Contributions. + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +6. Trademarks. + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +8. Limitation of Liability. + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. diff --git a/mbed-os-example-blinky/README.md b/mbed-os-example-blinky/README.md new file mode 100644 index 0000000..d4a9e75 --- /dev/null +++ b/mbed-os-example-blinky/README.md @@ -0,0 +1,73 @@ +![](./resources/official_armmbed_example_badge.png) +# Blinky Mbed OS example + +The example project is part of the [Arm Mbed OS Official Examples](https://os.mbed.com/code/) and is the [getting started example for Mbed OS](https://os.mbed.com/docs/mbed-os/latest/quick-start/index.html). It contains an application that repeatedly blinks an LED on supported [Mbed boards](https://os.mbed.com/platforms/). + +You can build the project with all supported [Mbed OS build tools](https://os.mbed.com/docs/mbed-os/latest/tools/index.html). However, this example project specifically refers to the command-line interface tools, [Arm Mbed CLI 1](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli) and [Mbed CLI 2](https://github.com/ARMmbed/mbed-tools#installation). + +(Note: To see a rendered example you can import into the Arm Online Compiler, please see our [import quick start](https://os.mbed.com/docs/mbed-os/latest/quick-start/online-with-the-online-compiler.html#importing-the-code).) + +## Mbed OS build tools + +### Mbed CLI 2 +Starting with version 6.5, Mbed OS uses Mbed CLI 2. It uses Ninja as a build system, and CMake to generate the build environment and manage the build process in a compiler-independent manner. If you are working with Mbed OS version prior to 6.5 then check the section [Mbed CLI 1](#mbed-cli-1). +1. [Install Mbed CLI 2](https://os.mbed.com/docs/mbed-os/latest/build-tools/install-or-upgrade.html). +1. From the command-line, import the example: `mbed-tools import mbed-os-example-blinky` +1. Change the current directory to where the project was imported. + +### Mbed CLI 1 +1. [Install Mbed CLI 1](https://os.mbed.com/docs/mbed-os/latest/quick-start/offline-with-mbed-cli.html). +1. From the command-line, import the example: `mbed import mbed-os-example-blinky` +1. Change the current directory to where the project was imported. + +## Application functionality + +The `main()` function is the single thread in the application. It toggles the state of a digital output connected to an LED on the board. + +**Note**: This example requires a target with RTOS support, i.e. one with `rtos` declared in `supported_application_profiles` in `targets/targets.json` in [mbed-os](https://github.com/ARMmbed/mbed-os). For non-RTOS targets (usually with small memory sizes), please use [mbed-os-example-blinky-baremetal](https://github.com/ARMmbed/mbed-os-example-blinky-baremetal) instead. + +## Building and running + +1. Connect a USB cable between the USB port on the board and the host computer. +1. Run the following command to build the example project and program the microcontroller flash memory: + + * Mbed CLI 2 + + ```bash + $ mbed-tools compile -m -t --flash + ``` + + * Mbed CLI 1 + + ```bash + $ mbed compile -m -t --flash + ``` + +Your PC may take a few minutes to compile your code. + +The binary is located at: +* **Mbed CLI 2** - `./cmake_build//develop//mbed-os-example-blinky.bin` +* **Mbed CLI 1** - `./BUILD///mbed-os-example-blinky.bin` + +Alternatively, you can manually copy the binary to the board, which you mount on the host computer over USB. + +## Expected output +The LED on your target turns on and off every 500 milliseconds. + + +## Troubleshooting +If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it. + +## Related Links + +* [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html). +* [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html). +* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html). +* [Mbed OS bare metal](https://os.mbed.com/docs/mbed-os/latest/reference/mbed-os-bare-metal.html). +* [Mbed boards](https://os.mbed.com/platforms/). + +### License and contributions + +The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more info. + +This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide. diff --git a/mbed-os-example-blinky/main.cpp b/mbed-os-example-blinky/main.cpp new file mode 100644 index 0000000..647e9bc --- /dev/null +++ b/mbed-os-example-blinky/main.cpp @@ -0,0 +1,26 @@ +/* mbed Microcontroller Library + * Copyright (c) 2019 ARM Limited + * SPDX-License-Identifier: Apache-2.0 + */ + +#include "mbed.h" + + +// Blinking rate in milliseconds +#define BLINKING_RATE 500ms + + +int main() +{ + // Initialise the digital pin LED1 as an output +#ifdef LED1 + DigitalOut led(LED1); +#else + bool led; +#endif + + while (true) { + led = !led; + ThisThread::sleep_for(BLINKING_RATE); + } +} diff --git a/mbed-os-example-blinky/mbed-os.lib b/mbed-os-example-blinky/mbed-os.lib new file mode 100644 index 0000000..144619b --- /dev/null +++ b/mbed-os-example-blinky/mbed-os.lib @@ -0,0 +1 @@ +https://github.com/ARMmbed/mbed-os/#17dc3dc2e6e2817a8bd3df62f38583319f0e4fed diff --git a/mbed-os-example-blinky/resources/official_armmbed_example_badge.png b/mbed-os-example-blinky/resources/official_armmbed_example_badge.png new file mode 100644 index 0000000..42ddce2 Binary files /dev/null and b/mbed-os-example-blinky/resources/official_armmbed_example_badge.png differ