(r10) MecrispCubeKatydid < MecrispCube

Tags: view all tags
%DASHBOARD{ section="dashboard_start" }%
%DASHBOARD{ section="banner"
 image="%PUBURLPATH%/MecrispCube/MecrispCubeKatydid/header.jpg"
 title="Mecrisp-Cube for the Katydid Wearable BLE Sensor Board"
 titlestyle="color:#F00000;"
}%
%DASHBOARD{ section="box_start" title="Intro" width="485" height="300"}%
Unfortunately the !STM32WB Feather Development Board is no longer available. 
But there is a very good substitute the [[https://www.tindie.com/products/tleracorp/firefly-ble-development-board/][Firefly]] designed by Tlera Corp. 
The pinout is very similar to Arduino UNO but with the size of an Arduino Nano. The GPIOs are very carefully selected. JTAG SWD is on the pin header too! 

Instant real-time programming with Forth.

Sources on [[https://github.com/spyren/Mecrisp-Cube/tree/katydid][GitHub]] (Katydid branch on Mecrisp-Cube)

%IMAGE{"%PUBURLPATH%/MecrispCube/MecrispCubeKatydid/firefly2.jpg" type="thumb" caption=""}%
%DASHBOARD{ section="box_end" }%
%DASHBOARD{ section="box_start" title="Contents" width="460" height="300"}%
%TOC%
%DASHBOARD{ section="box_end" }%
%DASHBOARD{ section="box_start"  width="992" height="600" }%
---+ Features

   * 61 !KiB RAM dictionary 
   * 128 !KiB Flash dictionary
   * Forth as CMSIS-RTOS thread. [[MecrispCube/CmsisRtos#CMSIS_RTOS_API][CMSIS-RTOS API]] to use [[https://en.wikipedia.org/wiki/FreeRTOS][FreeRTOS]] within Forth. 
   * Buffered [[TerminalIO][terminal I/O]] (5 !KiB buffer for UART Rx). Interrupt driven and RTOS aware, =key= and =emit= block the calling thread. !USART1: D0 RX, D1 TX
   * [[TerminalIO#USB_CDC_Serial_Communication_API][USB-CDC]] for serial communication via USB. Redirect console I/O like =cdc-emit=, =cdc-key= 
   * [[MicroSdBlocks][microSD]] and internal [[MicroSdBlocks#STM32WB_Feather][serial Flash mass storage]] for blocks and FAT filesystem. 
      * Internal Flash drive 0:, 384 !KiB Flash
      * microSD drive 1: (needs adaptor)
      * [[MicroSdBlocks#Filesystem_API][Filesystem API]]
      * [[MicroSdBlocks#UNIX_like_Shell_Commands][UNIX like Shell commands]]
   * Digital and analog pins
      * LEDs: LED1 (blue), Neopixel (D8, optional)
      * Digital port pins: D0 to D15 (some ports are shared)
      * Analog port pins: A0 to A4  (can also be used as digital port pins D16 to D20)
      * PWM: D0 (!TIM1CH3), D1 (!TIM1CH2), A4 (!TIM1CH1) 
      * Input capture A1 (!TIM2CH2) 
      * Output compare D13=13 (!TIM2CH1), A2=18 (!TIM2CH3), A3=19 (!TIM1CH4) 
      * EXTI: D2, D4, D7, and D10
   * UART: D0 RX, D1 TX
   * SPI: D11 SCK, D12 MISO, D13 MOSI (e.g. for display, memory, CS for SD-Card is D10)
   * !I2C: D14 SDA, D15 SCL (external peripherals e.g. pressure sensor, OLED)
   * [[EditorVi][vi Editor]] origin in !BusyBox tiny vi. Workflow development: =begin Edit EVALUATE while !SaveFile repeat= 
   * [[RealTimeClock][Real Time Clock]] (32 bit UNIX time stamp, valid times are from 1.1.2000 to 31.12.2099 because of the !STM32WB RTC peripheral) =time!=, =time@=, and =.time= (YYYY-MM-DDTHH:MM:SS ISO 8601). 

   * [[OledDisplay][OLED]] [[https://www.adafruit.com/product/2900][FeatherWing]] 128x32 
      * Switches: SW1 (button A, D9), SW2 (button B, D6), SW3 (button C, D5)
      * !I2C: D14 SDA, D15 SCL 
   * CharlieWing 
   * NeoPixelWing 
   * DotStarWing
   * QuadAlphanumeric !FeatherWing Display

   * [[MarkdownManual][Markdown manual pages]] 

For more BSP details see BoardSupportPackageKatydid.

%DASHBOARD{ section="box_end" }%

%DASHBOARD{ section="box_start"  width="992" height="600" }%
---+  Getting Started

These instructions will get you a copy of the project up and running on your local 
machine (!STM32WB Katydid Wearable BLE Sensor Board) for development and testing purposes. 

---++ Prerequisites

   * [[https://www.reclaimerlabs.com/stm32wb-feather][STM32WB Feather Development Board]] Stackable Feather board with !STM32WB55 MCU (Cortex ARM M4) runs at a 32 MHz (the Bluetooth stack runs on a Cortex ARM M0+ core). If you want to debug C and assembler programs you need an ST-Link debugger/programmer.
   * Terminal emulator application for PC, e.g.: 
      * [[http://www.putty.org/][PuTTY]] - Windows and Linux
      * [[http://en.sourceforge.jp/projects/ttssh2/][Tera Term]] - Windows
      * [[http://realterm.sourceforge.net/][Realterm]] - Windows
      * minicom, microcom, screen - Linux
      * Use the built in Eclipse console (but no LF)
 
Flash the Mecrisp-Cube [[https://github.com/spyren/Mecrisp-Cube/raw/katydid/Release/MecrispCubeKatydid.bin][binary]] (=MecrispCubeKatydid.bin=) or the [[https://github.com/spyren/Mecrisp-Cube/raw/katydid/sdcard/boot/MecrispCubeUtil.bin][util-binary]] (=MecrispCubeUtil.bin=, everything included e.g. internal flash drive and Forth tools) to the Katydid Board.

   1. Connect the Katydid Board USB to the PC
   2. Hold the BTN button (BOOTP Pin), push the nRST button, release the nRST button
   3. Program the binary (=MecrispCubeKatydid.bin= or =MecrispCubeUtil.bin=) with the !STMCubeProgrammer (select USB Device) 
   4. Reset or power cycle the Katydid board 

Start the terminal emulator application on the PC. 
Check for the serial communication port (e.g. for Linux =/dev/ttyACM0=).
I set the putty terminal configuration to 

   * Implicit CR in every LF 
   * Local echo: Auto
   * Local line editing: Auto
   * Keyboard Backspace: Control-H
   * Keyboard Function: Keys VT100
   * Remote character set: CP850

<pre>
Mecrisp-Stellaris RA 2.5.4 by Matthias Koch.

Mecrisp-Cube 1.4.5 for STM32WB Nucleo, 63/128  KiB RAM/FLASH dictionary (C) 2022 peter@spyr.ch
  * Firmware Package STM32Cube FW_WB V1.14.1, USB-CDC, BLE Stack 5.3 (C) 2022 STMicroelectronics
  * CMSIS-RTOS V2 FreeRTOS wrapper, FreeRTOS Kernel V10.3.1 (C) 2020 Amazon.com
  * FatFs for internal flash and microSD - Generic FAT fs module  R0.12c (C) 2017 ChaN
  * tiny vi - part of BusyBox (C) 2000, 2001 Sterling Huxley

include 0:/etc/rc.local
<b>23 5 / .[CR]</b> 4  ok.
<b>: hello ." World" ;[CR]</b>  ok.
<b>hello[CR]</b> World ok.
</pre>

---++ Special Functions on Startup 
[[TerminalIO#USB_CDC_Serial_Communication_API][USB-CDC]] is the default console.
   $ *Button BTN*: start STM bootloader
   $ *blue LED*: the LED lights up during the initialization phase

---++ Neopixel as Status Indicator
The optional NeoPixel displays the status
   $ *dimmed Green*: USB enumeration successfull
   $ *dimmed Blue*: BLE connected
   $ *flashing Red*: "disk" (serial flash or SD) write operation
   $ *flashing Yellow*: "disk" (serial flash or SD) read operation


---++ Additional Tools and Local Filesystem
Populate a microSD with the contents of [[https://github.com/spyren/Mecrisp-Cube/tree/katydid/sdcard][sdcard]]. Put the microSD into the uSD Card slot and reset or power cycle the board.

The directory should look like this:
<pre>
<b>ls -l 1:[CR]</b>
drw-         0 2021-04-18T18:12:38 boot
drw-         0 2021-03-21T18:47:52 etc
drw-         0 2021-03-21T18:47:54 fsr
drw-         0 2021-03-21T18:47:54 home
drw-         0 2021-03-21T18:47:56 man
-rwa      7219 2021-01-08T19:42:36 README.md
ok.
</pre>

You can use the local CLI commands like =mkfs=, =mkdir= and =cp= to create a filesystem on the serial flash and fill it with files and folders. But this is tedious job because I haven't yet implemented a recursive copy for !MecrispCube. But there is prepared disk image 
(for details see MicroSdBlocks#Serial_Flash) on microSD and the tool =dd=. You can copy the disk image to the drive 0: (this takes about 8 Minutes):
<pre>
<b>dd 1:/boot/fd-16MiB.img 0:[CR]</b>
 ok.
<b>mount 0:[CR]</b>
 ok.
<b>ls 0:[CR]</b>
man                     fsr                     README.md               boot
etc                     home
 ok.
</pre>

The Mecrisp have some tools bundled in its distribution e.g. assembler, disassembler, dump, float. I put those tools and some more into the folder =/fsr=. With the "init.fs script" I compile my favorite ones into the flash directory (if you use the [[https://github.com/spyren/Mecrisp-Cube/raw/WBfeather/sdcard/boot/MecrispCubeWBfeatherUtil.bin][util-binary]] binary, these tools are already compiled in):
<pre>
<b>compiletoflash[CR]</b>  ok.
<b>include /etc/init.fs[CR]</b>
init.fs Loading started
RAM Dictionary: 392991 KiB
utils.fs loading ...
conditional.fs loading ...
dump.fs loading ...
disassembler-m3.fs loading ...
float.fs loading ...
threads.fs loading ...
RAM Dictionary: 392981 KiB
init.fs finished  ok.
</pre>

For example, the word disassember is available now:
<pre>
<b>see dump[CR]</b>
080405F0: B500  push { lr }
080405F2: F7C2  bl  08002A3E  --> cr
080405F4: FA24
080405F6: CF08  ldmia r7 { r3 }
080405F8: F013  ands r2 r3 #F
080405FA: 020F
080405FC: F847  str r3 [ r7 #-4 ]!
080405FE: 3D04
08040600: 2A00  cmp r2 #0
08040602: D000  beq 08040606
08040604: 3610  adds r6 #10
08040606: CF08  ldmia r7 { r3 }
08040608: F847  str r6 [ r7 #-4 ]!
</pre>


---++ Installing

A step by step series of examples that tell you how to get a development env running

Install the IDE [[https://www.st.com/en/development-tools/stm32cubeide.html][STM32CubeIDE]], 
it is Eclipse and GCC based. 
[[https://www.st.com/en/development-tools/stm32cubemx.html][STM32CubeMX]]
is included in the IDE, you need a stand alone installation only if 
you do not want to use the !STM32CubeIDE.  

Get the sources from github:

<pre>
psi@homer:~> <b>git clone --branch katydid https://github.com/spyren/Mecrisp-Cube</b>
Klone nach 'Mecrisp-Cube' ...
remote: Enumerating objects: 1157, done.
remote: Counting objects: 100% (1157/1157), done.
remote: Compressing objects: 100% (620/620), done.
remote: Total 3183 (delta 720), reused 934 (delta 525), pack-reused 2026
Empfange Objekte: 100% (3183/3183), 41.60 MiB | 6.96 MiB/s, Fertig.
Löse Unterschiede auf: 100% (2100/2100), Fertig.
</pre>

Import the project into the IDE:

<pre>
File -> Import -> General -> Existing Projects into Workspace -> Select root directory
Copy project into workspace
Browse to Mecrisp-Cube directory
</pre>

Generate code from the !STM32CubeMX =MecrispCubeKatydid.ioc= file:
<pre>
Project -> Generate Code 
</pre>

Restore changed source files
<pre>
$ git status
{list of changed files}
$ git restore {files to restore} 
</pre>
or instead of =git restore=
<pre>
$ git stash
$ git stash drop
</pre>

Select the Build Configuration (Debug if you want to debug the project) and Build the project:
<pre>
Project -> Build Configurations -> Set Active -> Debug/Release 
Project -> Build Project
</pre>


%DASHBOARD{ section="box_end" }%


%DASHBOARD{ section="dashboard_end" }%


-- %USERSIG{PeterSchmid - 2021-07-01}%

<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work by <a xmlns:cc="http://creativecommons.org/ns#" href="http://spyr.ch" property="cc:attributionName" rel="cc:attributionURL">Peter Schmid</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
Attachments
Topic attachments
I	Attachment	History	Action	Size	Date	Who
jpg	firefly2.jpg	r1	manage	662.4 K	2022-08-29 - 19:43	PeterSchmid
jpg	header.jpg	r1	manage	51.7 K	2022-08-29 - 19:52	PeterSchmid
jpg	wbfeather.jpg	r1	manage	697.5 K	2021-07-01 - 20:38	PeterSchmid
Topic revision: r10 - 2022-09-04 - PeterSchmid