add readme & switch to production build

2022-04-02 04:03:55 +02:00
parent 01a18ef9cb
commit 08dc4e3c9e
2 changed files with 33 additions and 1 deletions
@@ -24,7 +24,7 @@ TARGET = bluepill-i2c-gw
 # debug build?
 DEBUG = 1
 # optimization
-OPT = -Og
+OPT = -Os


 #######################################
@@ -0,0 +1,32 @@
+# Bluepill USB-I2C gateway
+
+## Hardware
+
+This is a firmware for STM32F103R8T6 Bluepill.
+
+## Customization
+
+The project can be customized using STM32CubeMX.
+
+there's some changes in the i2c HAL driver, careful!
+
+line 6364
+
+```
+  // HACK - ignore HAL_I2C_ERROR_AF
+  if (hi2c->ErrorCode != HAL_I2C_ERROR_NONE && hi2c->ErrorCode != HAL_I2C_ERROR_AF)
+```
+
+this allows receiving frames of unknown length
+
+## Building & programming
+
+use the makefile and flash using a st-link dongle.
+
+Requires: Make, arm-none-eabi-gcc, st-flash
+
+```
+make -j
+make flash
+```
+