chore(doc) : Update the README with correct informations about STeaMi

- Remove all PNUCLEO references - Remove warning - Update badge - Add a list of implemented feature
letssteam · Oct 8, 2024 · 40b1de6 · 40b1de6
1 parent fd3d0a3
commit 40b1de6
Showing 1 changed file with 56 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,6 @@
-# :warning: THIS README IS FOR **PNUCLEO** NOT **STEAM32**. The target is in early development ! :warning:
+# Codal target for the STeaMi Board[![codal-buildtarget](https://github.com/letssteam/codal-stm32-STEAM32_WB55RG/actions/workflows/codal-buildtarget.yml/badge.svg)](https://github.com/letssteam/codal-stm32-STEAM32_WB55RG/actions/workflows/codal-buildtarget.yml)
 
-# Codal target for the PNUCLEO_WB55RG Board [![codal-stm32-PNUCLEO_WB55RG](https://img.shields.io/github/workflow/status/letssteam/codal-stm32-PNUCLEO_WB55RG/codal-buildtarget?label=codal-stm32-PNUCLEO_WB55RG)](https://github.com/letssteam/codal-stm32-PNUCLEO_WB55RG/actions)
-
-Codal target for the [P-NUCLEO-WB55](https://www.st.com/en/evaluation-tools/p-nucleo-wb55.html). Codal is the core set of drivers, mechanisms and types that make up the runtime for a board in Makecode.
+Codal target for the [STeaMi](https://www.steami.cc/). Codal is the core set of drivers, mechanisms and types that make up the runtime for a board in Makecode.
 
 ## Overview
 
@@ -12,37 +10,42 @@ In addition to supporting development in C/C++, the runtime is also designed spe
 
 Codal-core must be implemented by third party developper to support new hardware target.
 
-## Board Information  
-
-The the [P-NUCLEO-WB55](https://www.st.com/en/evaluation-tools/p-nucleo-wb55.html) allows users to develop applications of BLE 5 device.
+## Board Information
 
-The P-NUCLEO-WB55 pack is a multi-protocol wireless and ultra-low-power device embedding a powerful and ultra-low-power radio compliant with the Bluetooth® Low Energy (BLE) SIG specification v5.0 and with IEEE 802.15.4-2011.
+[STeaMi](https://www.steami.cc/) is a STM32 microcontoller-based programming board tailored for the classroom. STeaMi is designed for projects that use a ton of sensors and they’re all built-in!
 
-The support for Arduino Uno V3 connectivity provides unlimited expansion capabilities with a large choice of specialized add-on boards.
+So you can start exploring your world, measuring, logging and learning. You can transmit data over Bluetooth to a computer or mobile device for data plotting and logging, or save it for later use.
 
-<img src="https://www.st.com/bin/ecommerce/api/image.PF265562.en.feature-description-include-personalized-no-cpn-large.jpg" width="600px" />
+<img src="https://github.com/steamicc/assets/blob/main/Steami.png?raw=true"/>
 
 ## Feature List (and if implemented in codal)
 
-- [ ] Flash memory
-- [ ] Bluetooth® V5 module
-- [ ] USB OTG FS
-- [ ] 2 push-buttons (user and reset)
-- [ ] GPIO
-- [ ] ADC 12 bits
-- [ ] FAT Storage over the flash memory
-- [ ] Expansion connectors:
-  - [ ] Arduino™ Uno V3
+- [x] STM32WB55 Application Processor
+- [x] Bluetooth Wireless Communication
+- [x] Tact momentary push buttons
+- [x] Circular display
+- [x] Motion sensors
+- [x] Environemental sensors
+- [x] Light sensors
+- [x] Distance and gesture sensor
+- [x] Power supply management
+- [x] USB Serial Communications
+- [x] Flash memory
+- [x] Expansion connectors:
+  - [x] micro:bit edge connector
+  - [ ] Jacdac connectors
+  - [x] Qwiic/STEMMA connectors
+  - [x] Additionnal Croc connectors
 
 ## Installation
 
 Before using this target you need to configure your platforms with some software.
-Codal is also a build system to simplify as much as possible the experience of novice users.  
+Codal is also a build system to simplify as much as possible the experience of novice users.
 
 1. Install `git`, ensure it is available on your platforms path.
 2. Install the `arm-none-eabi-*` command line utilities for ARM based devices, ensure they are available on your platforms path.
 3. Install [CMake](https://cmake.org)(Cross platform make), this is the entirety of the build system.
-4. Install `Python 2.7` (if you are unfamiliar with CMake), python scripts are used to simplify the build process.
+4. Install `Python` (if you are unfamiliar with CMake), python scripts are used to simplify the build process.
 5. Clone the repository <https://github.com/lancaster-university/codal>
 
 ## Building
@@ -51,36 +54,36 @@ Codal is also a build system to simplify as much as possible the experience of n
   ```json
   {
     "target": {
-        "name": "codal-stm32-PNUCLEO_WB55RG", 
-        "url": "https://github.com/letssteam/codal-stm32-PNUCLEO_WB55RG", 
-        "branch": "master", 
-        "type": "git", 
-        "test_ignore": true
+      "name": "codal-stm32-STEAM32_WB55RG",
+      "url": "https://github.com/letssteam/codal-stm32-STEAM32_WB55RG",
+      "branch": "master",
+      "type": "git",
+      "test_ignore": true
     }
   }
   ```
-- In the root of this repository type `python build.py` the `-c` option cleans before building.
-- The bin file `PNUCLEO_WB55RG.bin` will be placed at the location specified by `codal.json`, by default this is the root.
-- To test the sample program, you just copy the bin file in the mass storage of the board.
+- In the root of the codal repository type `python build.py -c` the `-c` option cleans before building.
+- The bin file `STM32.bin` will be placed at the location specified by `codal.json`, by default this is the root.
+- To test the sample program, you can just copy the binary file in the mass storage of the board.
 
 ### Advanced use
 
 If you would like to override or define any additional configuration options (`#define's`) that are used by the supporting libraries, the codal build system allows the addition of a config field in `codal.json`:
 
 ```json
 {
-    "target": {
-        "name": "codal-stm32-PNUCLEO_WB55RG", 
-        "url": "https://github.com/letssteam/codal-stm32-PNUCLEO_WB55RG", 
-        "branch": "master", 
-        "type": "git", 
-        "test_ignore": true
-    },
-    "config":{
-        "NUMBER_ONE":1
-    },
-    "application":"source",
-    "output_folder":"."
+  "target": {
+    "name": "codal-stm32-STEAM32_WB55RG",
+    "url": "https://github.com/letssteam/codal-stm32-STEAM32_WB55RG",
+    "branch": "master",
+    "type": "git",
+    "test_ignore": true
+  },
+  "config": {
+    "NUMBER_ONE": 1
+  },
+  "application": "source",
+  "output_folder": "."
 }
 ```
 
@@ -94,17 +97,17 @@ For example, if you want to test the `BLE_TEMPERATURE_ALARM_SAMPLE`, you need to
 
 ```json
 {
-    "target": {
-        "name": "codal-stm32-PNUCLEO_WB55RG", 
-        "url": "https://github.com/letssteam/codal-stm32-PNUCLEO_WB55RG", 
-        "branch": "master", 
-        "type": "git", 
-        "test_ignore": true
-    },
-    "config":{
-        "BLE_TEMPERATURE_ALARM_SAMPLE":1
-    },
-    "application":"source",
-    "output_folder":"."
+  "target": {
+    "name": "codal-stm32-STEAM32_WB55RG",
+    "url": "https://github.com/letssteam/codal-stm32-STEAM32_WB55RG",
+    "branch": "master",
+    "type": "git",
+    "test_ignore": true
+  },
+  "config": {
+    "BLE_TEMPERATURE_ALARM_SAMPLE": 1
+  },
+  "application": "source",
+  "output_folder": "."
 }
 ```