readme

Author: gbr1

README.md

@@ -1,2 +1,42 @@
 # Arduino_Alvik
-Arduino Alvik library, code with your Alvik
+Arduino Alvik library, code your Alvik
+
+## Information
+
+To use this library, you need an [Arduino® Alvik](https://store.arduino.cc/pages/alvik) robot.
+
+Once the Arduino® Nano ESP32 of the robot is attached to the computer, select `Arduino Nano ESP32` from Arduino IDE 2 to program it.
+
+<br>
+
+## Color Calibration
+
+Flash the sketch into Arduino Nano ESP32 mounted on Alvik and follow the instructions on serial monitor.
+
+The white and black values will be written into ESP32 EEPROM. 
+
+<br>
+
+## How to update firmware of Arduino Alvik Carrier
+
+Since this [issue](https://github.com/stm32duino/Arduino_Core_STM32/issues/2292), Arduino® Alvik Carrier is not integrated yet into STM32duino's boards.
+
+<br>
+
+At the moment, it is possible to:
+- flash `bridge_firmware_updater` example into Arduino Nano ESP32 mounted on Alvik
+- use [STM32CubeProgrammer](https://www.st.com/en/development-tools/stm32cubeprog.html) to flash the new firmware.
+
+<br>
+
+
+In particular these settings are needed:
+- UART communication with DTR setted to 1 in STM32CubeProgrammer
+- robot must be turned on.
+
+
+## Useful links
+
+- [arduino-alvik-mpy](https://github.com/arduino/arduino-alvik-mpy), micropython version of the library
+- [Arduino_AlvikCarrier](https://github.com/arduino-libraries/Arduino_AlvikCarrier), arduino library required to build the firmware
+

examples/bridge_firmware_updater/bridge_firmware_updater

@@ -15,6 +15,7 @@
   This allows to flash firmware into the Arduino Alvik Carrier via Arduino Nano ESP32.
 
   Please refer to Arduino_AlvikCarrier library available at https://github.com/arduino-libraries/Arduino_AlvikCarrier
+
 */
 
 
@@ -60,9 +61,6 @@ void setup() {
   digitalWrite(RESET_STM32,LOW);
   delay(1000);
   digitalWrite(RESET_STM32,HIGH);
-
-
-
 }
 
 void loop() {

library.properties

@@ -1,5 +1,5 @@
 name=Arduino_Alvik
-version=0.3.0
+version=0.4.0
 author=Arduino, Giovanni di Dio Bruno, Lucio Rossi
 maintainer=Arduino <[email protected]>
 sentence=Library to code Arduino Alvik robot