added some more refactor to dos

Author: jpconstantineau

firmware/bluetooth.cpp

@@ -41,6 +41,9 @@ StatePayload  statedata;
 /**************************************************************************************************************************/
 void bt_setup(uint8_t BLEProfile)
 {
+  //TODO review what can be extracted for single boards
+
+  //TODO review what is needed for split boards and provide in separate module
 ble_gap_conn_params_t _ppcp;
   _ppcp = ((ble_gap_conn_params_t) {
     .min_conn_interval = 6,
@@ -88,7 +91,7 @@ sd_ble_gap_ppcp_set(&_ppcp);
   bledis.setModel(DEVICE_MODEL);                                              // Defined in keyboard_config.h
   bledis.begin();
 
- 
+  //TODO Split Battery Reporting Service into separate module.
   // Configure and Start Battery Service
   blebas.begin();
   blebas.write(100); // put the battery level at 100% - until it is updated by the battery monitoring loop.
@@ -98,6 +101,7 @@ sd_ble_gap_ppcp_set(&_ppcp);
   statedata.layer =0;
   statedata.timesync=0;
 
+//TODO Get Peripheral into separate module
 #if BLE_PERIPHERAL == 1      // PERIPHERAL IS THE SLAVE BOARD
 
   Linkdata.keycode[0] =0;  // initialize the slave to master link data...
@@ -152,7 +156,7 @@ sd_ble_gap_ppcp_set(&_ppcp);
    * up to 11.25 ms. Therefore BLEHidAdafruit::begin() will try to set the min and max
    * connection interval to 11.25  ms and 15 ms respectively for best performance.
    */
-   
+  //TODO setup LED feedback for both USB and BLE
 #if BLE_HID == 1
   blehid.begin();
   // Set callback for set LED from central
@@ -164,6 +168,7 @@ sd_ble_gap_ppcp_set(&_ppcp);
    * min = 9*1.25=11.25 ms, max = 12*1.25= 15 ms 
    */
 
+//TODO split central role into separate module.
  #if BLE_CENTRAL == 1                                   // CENTRAL IS THE MASTER BOARD
 
   KBLinkClientService.begin();
@@ -197,6 +202,8 @@ ble_gap_addr_t bt_getMACAddr(void)
 /**************************************************************************************************************************/
 //
 /**************************************************************************************************************************/
+
+//TODO setup advertising setup group of tasks
 void bt_startAdv(void)
 {  
   // Advertising packet

firmware/firmware_config.h

@@ -49,7 +49,7 @@
 #endif
 #endif
 
-
+//todo review if timings are needed and default values.
 #ifndef DEBOUNCETIME 
 #define DEBOUNCETIME 3   // changing this to 1 and you will have problems with the debounce logic - repeated keys perhaps...
 #endif

firmware/firmware_loop.cpp

@@ -8,7 +8,8 @@
 /**************************************************************************************************************************/
 // Keyboard Scanning
 /**************************************************************************************************************************/
-
+//todo get scanning code into separate module
+//todo get generic code scanning module for non-nrf52 boards.
 #if DIODE_DIRECTION == COL2ROW
 #define writeRow(r) digitalWrite(r,LOW)
 #define modeCol(c) pinMode(c, INPUT_PULLUP)
@@ -94,6 +95,7 @@ LOG_LV1("BLEMIC","scanMatrix" );
     }
 #endif
 
+//TODO refactor stringbuffer into HID queues
 void UpdateQueue()
 {
   #ifdef ENABLE_COMBOS
@@ -215,17 +217,17 @@ void sendKeyPresses() {
     KeyScanner::specialfunction = 0; 
   } else if (KeyScanner::consumer > 0)
   {
-    // send consumeer code
+    // TODO send consumeer code
     KeyScanner::consumer = 0; 
   } else if (KeyScanner::mouse > 0)
   {
-    // send mouse code
+    // TODO  send mouse code
     KeyScanner::mouse = 0; 
   }
 
 }
 
-
+//TODO re-implement sleep as module
 void checkforsleep()
 {
 
@@ -312,6 +314,8 @@ void updatebattery()
       keyboardstate.vbat_vdd = batterymonitor.vbat_vdd;
 }
 
+
+//todo Implement LEDs as module
 void updateleds()
 {
     keyboardstate.statusledtimer = keyboardstate.timestamp;

firmware/firmware_setup.cpp

@@ -30,6 +30,7 @@ byte columns[] MATRIX_COL_PINS;     // Contains the GPIO Pin Numbers defined in
  std::vector<HIDKeyboard> reportbuffer; 
 
 /**************************************************************************************************************************/
+//todo setup save to flash as module.
 void setupConfig() {
   InternalFS.begin();
   loadConfig();
@@ -150,12 +151,14 @@ void setuphid()
   bluemicro_hid.begin(); 
 }
 
+//todo: delete setupnrf52 if no longer needed
 void setupnrf52()
 {
   setupGpio();                                                                // checks that NFC functions on GPIOs are disabled.
   setupWDT();
 }
 
+//todo re-install debug CLI as module
 void serialsplash()
 {
   Serial.begin(115200);

firmware/keymap.h

@@ -32,6 +32,7 @@
 #define BIRTHDAY  MC(KC_Z)
 
 #ifdef ENABLE_AUDIO
+//todo re-install audio features as module
 //extern BlueMicro_tone speaker; 
 #endif
 

firmware/keyscanner.cpp

@@ -4,6 +4,7 @@
 
 #include "keyscanner.h"
 
+//todo refactor KeyScanner and split into get/update/send sequences
 
 KeyScanner::KeyScanner(PersistentState* cfg, DynamicState* stat) {    // Constructor
     config=cfg;

firmware/keystate.h

@@ -13,7 +13,7 @@
 
 
 
-
+//todo review default tap/hold tap/doubletap defaullt timings
 #ifndef DOUBLETAP_TIME_LIMIT
   #define DOUBLETAP_TIME_LIMIT 200
 #endif

firmware/nrf52battery.cpp

@@ -4,6 +4,8 @@
 
 #include "nrf52battery.h"
 
+//todo split battery read from battery update
+
 /**************************************************************************************************************************/
   BLEBas blebas;                                                                    // Battery Service
 

firmware/sleep.cpp

@@ -4,6 +4,8 @@
 
 #include "sleep.h"
 
+//todo refactor sleep so that each module can register a pre-sleep command.
+
 extern led_handler statusLEDs; /// Typically a Blue and Red LED
 /**************************************************************************************************************************/
 // Prepare sense pins for waking up from complete shutdown