Merge pull request #13 from arduino-libraries/devel

0.4.0 rc1

Author: gbr1

README.md

@@ -1,4 +1,24 @@
 # Arduino_AlvikCarrier
 
 
-W.I.P.
+This library is used to build the firmware required for Arduino® Alvik Carrier.
+
+To use the library, [stm32duino](https://github.com/stm32duino/Arduino_Core_STM32) is required.
+
+<br>
+<br>
+
+## Build parameters
+```
+Board: Generic STM32F4
+Board part number: Generic F411RCTx
+```
+
+To flash the firmware use the Arduino® Alvik documentation.
+
+<br>
+<br>
+
+## Useful links
+- [Product page](https://store.arduino.cc/pages/alvik)
+- [Micropython](https://github.com/arduino/arduino-alvik-mpy)

examples/firmware/firmware.ino

@@ -9,7 +9,7 @@
     
 */
 
-// WIP -> preliminary firmware
+// This is the stock firmware of Arduino Alvik robot.
 
 
 #include "Arduino_AlvikCarrier.h"
@@ -61,7 +61,6 @@ uint8_t version[3];
 
 
 void setup(){
-  Serial.begin(115200);
   alvik.begin();
   alvik.disableIlluminator();
   alvik.setLeds(COLOR_ORANGE);

examples/imu/imu.ino

@@ -20,32 +20,31 @@ unsigned long time_imu_update=0;
 Arduino_AlvikCarrier alvik;
 
 void setup(){
-    Serial.begin(115200);
     alvik.begin();
     time_imu_update=millis();
 }
 
 void loop(){
     if (millis()-time_imu_update>100){
         alvik.updateImu();
-        Serial.print("\t");
-        Serial.print(alvik.getAccelerationX());
-        Serial.print("\t");
-        Serial.print(alvik.getAccelerationY()); 
-        Serial.print("\t");
-        Serial.print(alvik.getAccelerationZ()); 
-        Serial.print("\t");
-        Serial.print(alvik.getAngularVelocityX());
-        Serial.print("\t");
-        Serial.print(alvik.getAngularVelocityY()); 
-        Serial.print("\t");
-        Serial.print(alvik.getAngularVelocityZ()); 
-        Serial.print("\t");
-        Serial.print(alvik.getRoll());
-        Serial.print("\t");
-        Serial.print(alvik.getPitch());  
-        Serial.print("\t");
-        Serial.println(alvik.getYaw()); 
+        alvik.serial->print("\t");
+        alvik.serial->print(alvik.getAccelerationX());
+        alvik.serial->print("\t");
+        alvik.serial->print(alvik.getAccelerationY()); 
+        alvik.serial->print("\t");
+        alvik.serial->print(alvik.getAccelerationZ()); 
+        alvik.serial->print("\t");
+        alvik.serial->print(alvik.getAngularVelocityX());
+        alvik.serial->print("\t");
+        alvik.serial->print(alvik.getAngularVelocityY()); 
+        alvik.serial->print("\t");
+        alvik.serial->print(alvik.getAngularVelocityZ()); 
+        alvik.serial->print("\t");
+        alvik.serial->print(alvik.getRoll());
+        alvik.serial->print("\t");
+        alvik.serial->print(alvik.getPitch());  
+        alvik.serial->print("\t");
+        alvik.serial->println(alvik.getYaw()); 
     }
     delay(1);
 }

examples/kinematics/kinematics.ino

@@ -22,7 +22,6 @@ uint8_t task=0;
 bool led_value = false;
 
 void setup() {
-  Serial.begin(115200);
   alvik.begin();
   ttask=millis();
   tmotor=millis();
@@ -35,17 +34,17 @@ void loop() {
     tmotor=millis();
     alvik.updateMotors();
     alvik.updateKinematics();
-    Serial.print("\t");
-    Serial.print(alvik.getLinearVelocity());
-    Serial.print("\t");
-    Serial.print(alvik.getAngularVelocity());
-    Serial.print("\t");
-    Serial.print(alvik.getX());
-    Serial.print("\t");
-    Serial.print(alvik.getY());
-    Serial.print("\t");
-    Serial.print(alvik.getTheta());
-    Serial.print("\n");
+    alvik.serial->print("\t");
+    alvik.serial->print(alvik.getLinearVelocity());
+    alvik.serial->print("\t");
+    alvik.serial->print(alvik.getAngularVelocity());
+    alvik.serial->print("\t");
+    alvik.serial->print(alvik.getX());
+    alvik.serial->print("\t");
+    alvik.serial->print(alvik.getY());
+    alvik.serial->print("\t");
+    alvik.serial->print(alvik.getTheta());
+    alvik.serial->print("\n");
   }
 
   if ((millis()-ttask>5000)||alvik.isTargetReached()){

examples/motor/motor.ino

@@ -9,6 +9,8 @@
     
 */
 
+// This example shows how wheels velocity control can be used
+
 
 #include "Arduino_AlvikCarrier.h"
 
@@ -21,15 +23,10 @@ int status=0;
 float reference = 0.0;
 
 void setup(){ 
-  Serial.begin(115200);
   alvik.begin();
   t=millis();
   t_change=millis();
   alvik.setRpm(reference,reference);
-
-  Serial.print("reference");
-  Serial.print(" ");
-  Serial.println("measure");
 }
 
 void loop(){
@@ -64,11 +61,5 @@ void loop(){
   if (millis()-t>20){
     t=millis();
     alvik.updateMotors();
-    
-    Serial.print(reference);
-    Serial.print(" ");
-    Serial.print(alvik.getRpmRight());
-    Serial.print(" ");
-    Serial.println(alvik.getRpmLeft());
   }
 }

examples/position/position.ino

@@ -9,6 +9,8 @@
     
 */
 
+// This example shows how left wheel position control can be used
+
 
 #include "Arduino_AlvikCarrier.h"
 
@@ -20,7 +22,6 @@ uint8_t task=0;
 float reference;
 
 void setup() {
-  Serial.begin(115200);
   alvik.begin();
   task = 0;
   reference = 0;
@@ -32,10 +33,6 @@ void loop() {
   if (millis()-tmotor>20){
     tmotor = millis();
     alvik.updateMotors();
-    Serial.print(reference);
-    Serial.print("\t");
-    Serial.print(alvik.getPositionLeft());
-    Serial.print("\n");
   }
 
   if (millis()-ttask>5000){

library.properties

@@ -1,5 +1,5 @@
 name=Arduino_AlvikCarrier
-version=0.3.4
+version=0.4.0
 author=Arduino, Giovanni di Dio Bruno, Lucio Rossi
 maintainer=Arduino <[email protected]>
 sentence=Library and firmware for Arduino Alvik Carrier board

src/definitions/robot_definitions.h

@@ -87,8 +87,8 @@ const float MOTION_FX_PERIOD = (1000U / MOTION_FX_FREQ);
 
 // Library version
 #define VERSION_BYTE_HIGH 0
-#define VERSION_BYTE_MID 3
-#define VERSION_BYTE_LOW 4
+#define VERSION_BYTE_MID 4
+#define VERSION_BYTE_LOW 0