Merge branch 'develop' into pr/168

Author: doudar

.github/workflows/pre-commit.yml

@@ -28,4 +28,4 @@ jobs:
         if: steps.filter.outputs.software == 'true'
         uses: docker://kadaan/platformio_esp32:latest
         with:
-          args: run
+          args: --build=release

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: (\.pio|lib/NimBLE-Arduino)/.*
+exclude: (\.pio|lib/NimBLE-Arduino|lib/ArduinoCompat)/.*
 repos:
   - repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.1.9
@@ -31,10 +31,10 @@ repos:
         language: docker_image
         files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
         entry: daverona/pre-commit-cpp:0.8.0 cpplint
-      - id: docker-piocheck
-        name: piocheck
-        description: Run `pio check` against C/C++ source files in Docker container
+      - id: docker-pio
+        name: pio
+        description: Run platformio check, test, and build C/C++ source files in Docker container
         language: docker_image
-        files: \.(c|cc|cpp|cu|c\+\+|cxx|tpp|txx|ino)$
+        files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
         pass_filenames: false
-        entry: kadaan/platformio_esp32:latest check
+        entry: kadaan/platformio_esp32:latest --check --test=native

.vscode/settings.json

@@ -42,7 +42,13 @@
         "cinttypes": "cpp",
         "utility": "cpp",
         "typeinfo": "cpp",
-        "string": "cpp"
+        "string": "cpp",
+        "climits": "cpp",
+        "ble.h": "c",
+        "os_mempool.h": "c",
+        "ble_uuid.h": "c",
+        "ble_hs_priv.h": "c",
+        "nimble_opt.h": "c"
     },
     "C_Cpp.errorSquiggles": "Disabled"
 }

.vscode/tasks.json

@@ -3,19 +3,19 @@
 	"tasks": [
 		{
 			"type": "PlatformIO",
-			"task": "Upload Filesystem Image (esp32doit)",
+			"task": "Upload Filesystem Image (debug)",
 			"problemMatcher": [
 				"$platformio"
 			],
-			"label": "PlatformIO: Upload Filesystem Image (esp32doit)"
+			"label": "PlatformIO: Upload Filesystem Image (debug)"
 		},
 		{
 			"type": "PlatformIO",
-			"task": "Erase Flash (esp32doit)",
+			"task": "Erase Flash (debug)",
 			"problemMatcher": [
 				"$platformio"
 			],
-			"label": "PlatformIO: Erase Flash (esp32doit)"
+			"label": "PlatformIO: Erase Flash (debug)"
 		},
 		{
 			"type": "PlatformIO",

CHANGELOG.md

@@ -5,7 +5,45 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+### Added
+- BLE Custom Characteristic motor driver calls now apply settings received.
+- Motor current now automatically scales if ESP32 temp starts getting too high. 
+- Added comments after compiler #endif Statements to make it easier to see what the partner #if statement is.
+- Added BLE_syncMode to support syncing shifterPosition with bikes that also report their resistance level. 
+- Added git tag to prevent branch from downgrading to the last release. 
+- Added Hardware Version 2.0. 
+- MCWPWM for stepper control.
+- Erg Sensitivity control added.
+- Function to stop motor and release tension if the user stops pedaling in ERG mode.  
+- Received BLE is now buffered and then processed. 
+- Added Fitness Machine supported inclination range characteristic.
+
+### Changed
+- Renamed BLE_stepperPosition to BLE_targetPosition to clarify the variable it controls. 
+- Increased BLE communications task to 3500 stack.
+- Fixed recurring debugging line when driver was at normal temp.
+- Fixed length of returnValue on custom BLE bool read requests. 
+
+## [1.6.19] - 2021-6-19
+
 ### Added
+- Initial implementation of the custom characteristic. 
+- Added additional FTMS characteristics and some refactoring of shared variables
+- Added GZipped jQuery to fix non WAN connected manual updates.
+- Pin arduino-esp32 package to version 1.0.6 to fix build issue
+- Added + - Buttons to sliders. 
+- Added firmware checklist to "~/" for PR and release candidate testing.
+- Added README.md to "~/Hardware/*" that provides help for the files contained within. 
+- Added BakerEchelonStrap to "~/Hardware/Mounts/".
+- Added positive retention clip to "~/Hardware/Mounts".
+- Added Logan clip to "~/Hardware/Mounts".
+- Added experimental rigid mounting strap. * Fixed width to 65mm. 
+- Add images for video links in Wiki Build How To.
+- Added webhook for simulated cadence. 
+- Add image for video link in Build How To
+- Added images for video links in Wiki Build How To
+- Added XL (Extra Long) Mounting strap for Echelon.
 - Added Insert Peloton 7 Flat V2 .sldpart and .stl.
 - Added initial credits file.
 - Added initial changelog.
@@ -16,8 +54,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Filter Flywheel advertisements by name.
 - Added unit tests for CyclePowerData.cpp
 - Add documentation to SensorData class.
+- Enabled native testing.
+- Added logging library which supports levels.
 
 ### Changed
+- Moved Vin to the correct side on the ESP32 connection diagram. 
+- Power Correction Factor minimum value is now .5
+- Made Revmaster insert slightly smaller. 
+- Fixed minor spulling errurs. 
+- Reorganized hardware library into per part subfolders.
+- Updater shifter cover to version 9.
+- Fixed missing strap loops on non-pcb case.
+- Power Correction Factor slider now updates correctly. 
+- Removed unused http onServer calls.
+- Repaired btsimulator.html
+- Shortened HR characteristic to 2 bytes (Polar OH1 format)
 - Increased ShiftStep UI slider range.
 - Replaced DoublePower setting with PowerCorrectionFactor setting.
 - Reverted bytes_to_u16 macro. 
@@ -26,10 +77,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated Echelon Insert
 - Fixed many issues exposed by the addition of cpp-lint, pio check, and clang-format.
 - Fixed merge issues.
-- Fixed Echelon licences.
+- Fixed Echelon licenses.
 - Fix Flywheel power/cadence decoding.
-- Ignore zero heartrate reported from remote FTMS.
+- Ignore zero heart rate reported from remote FTMS.
 - Fix Assimoa Uno stuck cadence.
+- Started extract non-arduino code into a cross-platform library.
+- Changed all logging calls to new logging library.
 
 ### Removed
-- Deleted and ignored .pio folder which had been mistakening commited
+- Deleted and ignored .pio folder which had been mistakenly committed.

CPPLINT.cfg

@@ -17,9 +17,6 @@
 # Don't search for additional CPPLINT.cfg in parent directories.
 set noparent
 
-# Exclude third-party files
-exclude_files=\.pio|lib
-
 # Limit line length.
 linelength=180
 

CustomCharacteristic.md

@@ -0,0 +1,85 @@
+Please use and refer to the following notes for use of the custom characteristic:
+
+Custom Characteristic for userConfig Variable manipulation via BLE
+
+SMARTSPIN2K_SERVICE_UUID        "77776277-7877-7774-4466-896665500000"
+SMARTSPIN2K_CHARACTERISTIC_UUID "77776277-7877-7774-4466-896665500001"
+
+An example follows to read/write 26.3kph to simulatedSpeed:
+
+simulatedSpeed is a float and first needs to be converted to int by *10 for transmission, so convert 26.3kph to 263 (multiply by 10)
+Decimal 263 == hexadecimal 0107 but the data needs to be converted to LSO, MSO to match the rest of the BLE spec so 263 == 0x07, 0x01 (LSO,MSO)
+
+So,
+
+If client wants to write (0x02) int value 263 (0x07 0x01) to simulatedSpeed(0x06):
+
+Client Writes:
+0x02, 0x06, 0x07, 0x01
+(operator, variable, LSO, MSO)
+
+Server will then indicate:
+0x80, 0x06, 0x07, 0x01 
+(success),(simulatedSpeed),(LSO),(MSO)
+
+Example to read (0x01) from simulatedSpeed (0x06)
+
+Client Writes:
+0x01, 0x06
+Server will then indicate:
+0x80, 0x06, 0x07, 0x01 
+(success),(simulatedSpeed),(0x07),(0x01)
+
+Pay special attention to the float values. Since they have to be transmitted as an int, some are converted *100, others are converted *10.
+Refer to BLE_Server.cpp for which conversions to use.
+
+True values are >00. False are 00.
+
+Values in first byte:
+
+Written:
+  uint8_t read        = 0x01;  // value to request read operation
+  uint8_t write       = 0x02;  // Value to request write operation
+  
+Indicated:
+  uint8_t error       = 0xff;  // value server error/unable
+  uint8_t success     = 0x80;  // value for success
+
+From BLE_common.h
+//custom characteristic codes
+| Variable                 |uint8_t| type| Notes                                             |
+|--------------------------|:-----:|-----|---------------------------------------------------|
+|BLE_firmwareUpdateURL     |0x01   |     |Not Implemented                                    |
+|BLE_incline               |0x02   |float|incline from app                                   |
+|BLE_simulatedWatts        |0x03   |int  |simulated or read watts                            |
+|BLE_simulatedHr           |0x04   |int  |simulated or read HR                               |
+|BLE_simulatedCad          |0x05   |float|simulated or read cadence                          |
+|BLE_simulatedSpeed        |0x06   |float|Calculated speed                                   |
+|BLE_deviceName            |0x07   |     |Not Implemented                                    |
+|BLE_shiftStep             |0x08   |int  |Stepper steps per shifter button press             |
+|BLE_stepperPower          |0x09   |int  |Stepper power in ma                                |
+|BLE_stealthchop           |0x0A   |bool |Stepper stealthchop on/off                         |
+|BLE_inclineMultiplier     |0x0B   |float|- multiplied by incline to get steps per % gradient|
+|BLE_powerCorrectionFactor |0x0C   |float|.5 - 2.0 to calibrate power output                 |
+|BLE_simulateHr            |0x0D   |bool |                                                   |
+|BLE_simulateWatts         |0x0E   |bool |                                                   |    
+|BLE_simulateCad           |0x0F   |bool |                                                   |
+|BLE_ERGMode               |0x10   |bool |                                                   |
+|BLE_autoUpdate            |0x11   |bool |updates on (01) or off (00)                        |
+|BLE_ssid                  |0x12   |     |Not Implemented                                    |
+|BLE_password              |0x13   |     |Not Implemented                                    |
+|BLE_foundDevices          |0x14   |     |Not Implemented                                    |
+|BLE_connectedPowerMeter   |0x15   |     |Not Implemented                                    |
+|BLE_connectedHeartMonitor |0x16   |     |Not Implemented                                    |
+|BLE_shifterPosition       |0x17   |int  |That changes when a shift is preformed.            |
+|BLE_saveToSpiffs          |0x18   |bool |01 written will save to spiffs.                    |
+|BLE_targetPosition        |0x19   |int36|Position (in steps) the motor is maintaining.      |
+|BLE_externalControl       |0x1A   |bool |01 disables internal calculation of targetPosition.|
+|BLE_syncMode              |0x1B   |bool |01 stops motor movement for external calibration   |
+
+*syncMode will disable the movement of the stepper motor by forcing stepperPosition = targetPosition prior to the motor control. While this mode is enabled, it allows the client to set parameters like incline and shifterPosition without moving the motor from it's current position. Once the parameters are set, this mode should be turned back off and SS2K will resume normal operation.
+
+
+This characteristic also notifies when a shift is preformed or the button is pressed. 
+
+See code for more references/info in BLE_Server.cpp starting on line 534

Hardware/Bottom_Case.stl

@@ -0,0 +1,5 @@
+Which case do I need?
+
+Use the Bottom_Case for the whole DIY experience. It provides additional mounts inside for the stepper driver and the buck converter. 
+
+The Bottom_Case_PCB is for those that use the pcb from pcbway. It's much simplier and cleaner wiring but requires more parts to be purchased (Components for the PCB). 

Hardware/Case Version1/Cases/Bottom_Case.stl

@@ -0,0 +1,3 @@
+Tall_Cover_w_brace is primarily for shipping but may also provide some added durability as it supports the top of the stepper motor. 
+
+Tall_Cover is slightly more flexible and may provide room for different size stepper motors.