Merge branch 'release/0.2.1'

Author: corneliusmunz

README.md

@@ -1,22 +1,27 @@
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/legoinochat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 # Legoino
 Arduino Library for controlling Powered UP and Boost controllers
 
 *Disclaimer*: LEGO® is a trademark of the LEGO Group of companies which does not sponsor, authorize or endorse this project.
 
-Simple Train example
+Simple Train example (just click the image to see the video)
 
 [![Legoino TrainHub example](http://img.youtube.com/vi/o1hgZQz3go4/0.jpg)](http://www.youtube.com/watch?v=o1hgZQz3go4 "Legoino TrainHub example")
 
-Simple Boost movement example
+Simple Boost movement example (just click the image to see the video)
 
 [![Legoino BoostHub simple movements example](http://img.youtube.com/vi/VgWObhyUmi0/0.jpg)](http://www.youtube.com/watch?v=VgWObhyUmi0 "Legoino BoostHub simple movements example")
 
 Up to now the Library is only teseted for a Powered Up Train controllers and Boost controllers. You can connect to your HUB, set the LED color, set the Hub name, control the motors (speed, port, movements) and shut down the HUB via a Arduino command. Up to now the notifications of the hub and the reading of the sensors are not supported. But this feature will come in the next release.
 
+# Examples
+You can find 3 Examples called "BasicHub.ino", "BoostHub.ino" and "TrainHub.ino" in the "examples" folder. You can select the examples in your Arduino IDE via the Menu "File->Examples". 
+
 # Setup and Usage
-Just install the Libray via the Arduino Library Manager.
+Just install the Library via the Arduino Library Manager.
 
-The usage is dependent on your hub type. Some basic commands are shared for the hubs and are covered in the Lpf2Hub library. Some other commands ar hub specific (e.g. Boost movement). The hub dependent usage is described below.
+The usage is dependent on your hub type. Some basic commands are shared for the hubs and are covered in the Lpf2Hub library. Some other commands ar hub specific (e.g. Boost movement).
 
 ## Boost Hub
 Add the follwoing include in your *.ino sketch
@@ -45,7 +50,7 @@ In the main ```loop``` just add the following connection flow
   }
 ```
 
-Now you are ready to control your actuators or your Hub
+Now you are ready to control your actuators on your Hub
 
 ### Hub control
 You can define the display name of the Hub (e.g. displayed in the PoweredUp Apps) with the following command. 
@@ -165,7 +170,7 @@ In the main ```loop``` just add the following connection flow
     }
   }
 ```
-Now you are ready to control your actuators or your Hub
+Now you are ready to control your actuators on your Hub
 
 ### Hub control
 You can define the display name of the Hub (e.g. displayed in the PoweredUp Apps) with the following command. 
@@ -208,23 +213,20 @@ myTrainHub.stopMotor(A); // Stop motor on Port A
 myTrainHub.stopMotor(); // Stop all motors (Port A and Port B)
 ```
 
-# Examples
-You can find 3 Examples called "BasicHub.ino", "BoostHub.ino" and "TrainHub.ino" in the "examples" folder. You can select the examples in your Arduino IDE via the Menu "File->Examples". 
-
 # Arduino Hardware
 The library is implemented for the ESP32 Boards and does use the ESP32_BLE_Arduino Library.
 
 # Credits
 Hands up to Lego, that they have recently open-sourced the Specification
 https://github.com/LEGO/lego-ble-wireless-protocol-docs
 
-Thanks to JorgePe and all contributors for the reverse engenieering part
+Thanks to [@JorgePe](https://github.com/JorgePe) and all contributors for the reverse engenieering part
 https://github.com/JorgePe/BOOSTreveng
 
-Thanks to jakorten for his SWIFT iOS App
+Thanks to [@jakorten](https://github.com/jakorten) for his SWIFT iOS App
 https://github.com/jakorten/UpControl
 
-Thanks Nathan Kellenicki for his brilliant structured node module
+Thanks [@nathankellenicki](https://github.com/nathankellenicki) for his brilliant structured node module
 https://github.com/nathankellenicki/node-poweredup
 
 # Remarks

src/BoostHub.cpp

@@ -27,7 +27,7 @@ void BoostHub::setMotorSpeed(Port port, int speed)
  * @param [in] time Time value in ms of the acceleration from 0-100% speed/Power
  * @param [in] profileNumber Number for which the acceleration profile is stored
  */
-void BoostHub::setAccelerationProfile(Port port, int16_t time, int8_t profileNumber) 
+void BoostHub::setAccelerationProfile(Port port, int16_t time, int8_t profileNumber)
 {
     byte *timeBytes = Int16ToByteArray(time);
     byte setMotorCommand[7] = {0x81, port, 0x10, 0x05, timeBytes[0], timeBytes[1], profileNumber};
@@ -40,7 +40,7 @@ void BoostHub::setAccelerationProfile(Port port, int16_t time, int8_t profileNum
  * @param [in] time Time value in ms of the deceleration from 100-0% speed/Power
  * @param [in] profileNumber Number for which the deceleration profile is stored
  */
-void BoostHub::setDecelerationProfile(Port port, int16_t time, int8_t profileNumber) 
+void BoostHub::setDecelerationProfile(Port port, int16_t time, int8_t profileNumber)
 {
     byte *timeBytes = Int16ToByteArray(time);
     byte setMotorCommand[7] = {0x81, port, 0x10, 0x06, timeBytes[0], timeBytes[1], profileNumber};
@@ -103,76 +103,90 @@ void BoostHub::stopMotor(Port port = AB)
  * @brief Move forward (Port AB) with the default speed and stop after the number of steps
  * @param [in] steps Number of steps (Boost grid)
  */
-void BoostHub::moveForward(int steps) {
+void BoostHub::moveForward(int steps)
+{
     Port port = AB;
     Port portA = A;
     Port portB = B;
     setDecelerationProfile(portA, 1000, 0);
     setDecelerationProfile(portB, 1000, 0);
-    setMotorSpeedForDegrees(port, 50, steps*360*2);
+    setMotorSpeedForDegrees(port, 50, steps * 360 * 2);
 }
 
 /**
  * @brief Move back (Port AB) with the default speed and stop after the number of steps
  * @param [in] steps Number of steps (Boost grid)
  */
-void BoostHub::moveBack(int steps) {
+void BoostHub::moveBack(int steps)
+{
     Port port = AB;
-    setMotorSpeedForDegrees(port, -50, steps*360*2);
+    setMotorSpeedForDegrees(port, -50, steps * 360 * 2);
 }
 
 /**
  * @brief rotate (Port AB) with the default speed and stop after the degrees
  * @param [in] degrees (negative: left, positive: right)
  */
-void BoostHub::rotate(int degrees) {
-    if (degrees > 0) {
+void BoostHub::rotate(int degrees)
+{
+    if (degrees > 0)
+    {
         // right
-        setMotorSpeedsForDegrees(-50, 50, degrees*4.5);
-    } else {
+        setMotorSpeedsForDegrees(-50, 50, degrees * 4.5);
+    }
+    else
+    {
         // left
-        setMotorSpeedsForDegrees(50, -50, degrees*4.5);
+        setMotorSpeedsForDegrees(50, -50, degrees * 4.5);
     }
 }
 
 /**
  * @brief rotate left (Port AB) with the default speed and stop after degrees (default 90)
  * @param [in] degrees (default 90)
  */
-void BoostHub::rotateLeft(int degrees = 90) {
+void BoostHub::rotateLeft(int degrees = 90)
+{
     rotate(-degrees);
 }
 
 /**
  * @brief rotate right (Port AB) with the default speed and stop after degrees (default 90)
  * @param [in] degrees (default 90)
  */
-void BoostHub::rotateRight(int degrees = 90) {
+void BoostHub::rotateRight(int degrees = 90)
+{
     rotate(degrees);
 }
 
 /**
  * @brief move an arc (Port AB) with the default speed and stop after degrees
  * @param [in] degrees (negative: left, positive: right)
  */
-void BoostHub::moveArc(int degrees) {
-    if (degrees > 0) {
+void BoostHub::moveArc(int degrees)
+{
+    if (degrees > 0)
+    {
         // right
-        setMotorSpeedsForDegrees(60, 20, degrees*12);
-    } else {
+        setMotorSpeedsForDegrees(60, 20, degrees * 12);
+    }
+    else
+    {
         // left
-        setMotorSpeedsForDegrees(20, 60, degrees*12);
+        setMotorSpeedsForDegrees(20, 60, degrees * 12);
     }
 }
 
 /**
  * @brief move an arc left (Port AB) with the default speed and stop after degrees (default 90)
  * @param [in] degrees (default 90)
  */
-void BoostHub::moveArcLeft(int degrees = 90) {
+void BoostHub::moveArcLeft(int degrees = 90)
+{
     moveArc(-degrees);
 }
 
-void BoostHub::moveArcRight(int degrees= 90) {
+void BoostHub::moveArcRight(int degrees = 90)
+{
     moveArc(degrees);
 }

src/BoostHub.h

@@ -16,8 +16,7 @@
 class BoostHub : public Lpf2Hub
 {
 public:
-  
-  //Port definitions specific to Boost Hubs
+    //Port definitions specific to Boost Hubs
   enum Port
   {
     A = 0x37,

src/Lpf2Hub.cpp

@@ -13,9 +13,11 @@
  */
 class Lpf2HubAdvertisedDeviceCallbacks : public BLEAdvertisedDeviceCallbacks
 {
-    Lpf2Hub* _lpf2Hub;
-public:
-    Lpf2HubAdvertisedDeviceCallbacks(Lpf2Hub* lpf2Hub) : BLEAdvertisedDeviceCallbacks() {
+    Lpf2Hub *_lpf2Hub;
+
+  public:
+    Lpf2HubAdvertisedDeviceCallbacks(Lpf2Hub *lpf2Hub) : BLEAdvertisedDeviceCallbacks()
+    {
         _lpf2Hub = lpf2Hub;
     }
 
@@ -36,18 +38,19 @@ class Lpf2HubAdvertisedDeviceCallbacks : public BLEAdvertisedDeviceCallbacks
  * @param [in] command byte array which contains the ble command
  * @param [in] size length of the command byte array
  */
-void Lpf2Hub::WriteValue(byte command[], int size) { 
-    byte commandWithCommonHeader[size+2] = {size+2, 0x00};
-    memcpy(commandWithCommonHeader+2, command, size);
+void Lpf2Hub::WriteValue(byte command[], int size)
+{
+    byte commandWithCommonHeader[size + 2] = {size + 2, 0x00};
+    memcpy(commandWithCommonHeader + 2, command, size);
     _pRemoteCharacteristic->writeValue(commandWithCommonHeader, sizeof(commandWithCommonHeader), false);
 }
 
-
 /**
  * @brief Map speed from -100..100 to the 8bit internal value
  * @param [in] speed -100..100
  */
-byte Lpf2Hub::MapSpeed(int speed) {
+byte Lpf2Hub::MapSpeed(int speed)
+{
     byte rawSpeed;
     if (speed == 0)
     {
@@ -64,19 +67,21 @@ byte Lpf2Hub::MapSpeed(int speed) {
     return rawSpeed;
 }
 
-byte* Lpf2Hub::Int16ToByteArray(int16_t x) {
+byte *Lpf2Hub::Int16ToByteArray(int16_t x)
+{
     static byte y[2];
-    y[0] = (byte) (x & 0xff);
-    y[1] = (byte) ((x >> 8) & 0xff);
+    y[0] = (byte)(x & 0xff);
+    y[1] = (byte)((x >> 8) & 0xff);
     return y;
 }
 
-byte* Lpf2Hub::Int32ToByteArray(int32_t x) {
+byte *Lpf2Hub::Int32ToByteArray(int32_t x)
+{
     static byte y[4];
-    y[0] = (byte) (x & 0xff);
-    y[1] = (byte) ((x >> 8) & 0xff);
-    y[2] = (byte) ((x >> 16) & 0xff);
-    y[3] = (byte) ((x >> 24) & 0xff);
+    y[0] = (byte)(x & 0xff);
+    y[1] = (byte)((x >> 8) & 0xff);
+    y[2] = (byte)((x >> 16) & 0xff);
+    y[3] = (byte)((x >> 24) & 0xff);
     return y;
 }
 
@@ -241,7 +246,6 @@ void Lpf2Hub::parsePortMessage(uint8_t *pData)
     {
         Serial.print(" is not connected");
     }
-
 }
 
 /**
@@ -352,17 +356,15 @@ void Lpf2Hub::notifyCallback(
     }
 }
 
-
-
 Lpf2Hub::Lpf2Hub(){};
 
 /**
  * @brief Init function set the UUIDs and scan for the Hub
  */
 void Lpf2Hub::init()
 {
-    _isConnected=false;
-    _isConnecting=false;
+    _isConnected = false;
+    _isConnecting = false;
     _bleUuid = BLEUUID(LPF2_UUID);
     _charachteristicUuid = BLEUUID(LPF2_CHARACHTERISTIC);
     _hubType = BOOST_MOVE_HUB;
@@ -374,7 +376,6 @@ void Lpf2Hub::init()
 
     pBLEScan->setActiveScan(true);
     pBLEScan->start(30);
-
 }
 
 /**
@@ -437,11 +438,10 @@ void Lpf2Hub::setHubName(char name[])
     int arraySize = offset + nameLength;
     byte setNameCommand[arraySize] = {0x01, 0x01, 0x01};
 
-    memcpy(setNameCommand+offset, name, nameLength);
+    memcpy(setNameCommand + offset, name, nameLength);
     WriteValue(setNameCommand, arraySize);
 }
 
-
 void Lpf2Hub::activateHubUpdates()
 {
     // Activate reports
@@ -462,10 +462,10 @@ void Lpf2Hub::activateHubUpdates()
 
     byte setFWCommand[3] = {0x01, 0x03, 0x02};
     WriteValue(setFWCommand, 3);
-    
+
     byte setHWCommand[3] = {0x01, 0x04, 0x02};
     WriteValue(setHWCommand, 3);
-    
+
     byte setBatteryType[3] = {0x01, 0x07, 0x02};
     WriteValue(setBatteryType, 3);
 }
@@ -485,15 +485,15 @@ bool Lpf2Hub::connectHub()
     BLERemoteService *pRemoteService = pClient->getService(_bleUuid);
     if (pRemoteService == nullptr)
     {
-            Serial.println("get pClient failed");
+        Serial.println("get pClient failed");
         return false;
     }
-        Serial.println("get pRemoteService");
+    Serial.println("get pRemoteService");
 
     _pRemoteCharacteristic = pRemoteService->getCharacteristic(_charachteristicUuid);
     if (_pRemoteCharacteristic == nullptr)
     {
-            Serial.println("get pRemoteService failed");
+        Serial.println("get pRemoteService failed");
 
         return false;
     }