Merge pull request #383 from adafruit/refactor-button

Refactor button

Author: hathach

AGENTS.md

@@ -0,0 +1,25 @@
+# Agent Instructions
+
+## Style
+- Follow the repo `.clang-format` when making changes.
+
+## Build / Verify
+- Prefer CMake for testing/verification.
+- Always build both boards during verification:
+  - `feather_nrf52832`
+  - `feather_nrf52840_express`
+
+### CMake (preferred)
+```bash
+cmake -S . -B cmake-build-feather_nrf52832 -DBOARD=feather_nrf52832
+cmake --build cmake-build-feather_nrf52832
+
+cmake -S . -B cmake-build-feather_nrf52840_express -DBOARD=feather_nrf52840_express
+cmake --build cmake-build-feather_nrf52840_express
+```
+
+### Make (alternate)
+```bash
+make BOARD=feather_nrf52832 all
+make BOARD=feather_nrf52840_express all
+```

README.md

@@ -24,7 +24,8 @@ Officially supported boards are:
 - Adafruit Metro nRF52840 Express
 - [Raytac MDBT50Q-RX Dongle](https://www.adafruit.com/product/5199)
 
-In addition, there is also lots of other 3rd-party boards which are added by other makers, users and community. Check out the [complete list of all boards here](/src/boards).
+In addition, there is also lots of other 3rd-party boards which are added by other makers, users and community. Check
+out the [complete list of all boards here](/supported_boards.md).
 
 ## Features
 

src/boards/adm_b_nrf52840_1/board.h

@@ -25,43 +25,40 @@
 #ifndef ADM_B_NRF52840_1_H
 #define ADM_B_NRF52840_1_H
 
-#define _PINNUM(port, pin)    ((port)*32 + (pin))
-
 /*------------------------------------------------------------------*/
 /* LED
  *------------------------------------------------------------------*/
-#define LEDS_NUMBER       1
-#define LED_PRIMARY_PIN   _PINNUM(0, 19) // Red
-//#define LED_SECONDARY_PIN 12 // Blue
-#define LED_STATE_ON      0
+#define LEDS_NUMBER     1
+#define LED_PRIMARY_PIN PINNUM(0, 19) // Red
+// #define LED_SECONDARY_PIN 12 // Blue
+#define LED_STATE_ON 0
 
 /*------------------------------------------------------------------*/
 /* BUTTON
  *------------------------------------------------------------------*/
-#define BUTTONS_NUMBER  2
 
-#define BUTTON_1       _PINNUM(0, 11)
-#define BUTTON_2       _PINNUM(0, 12)
+#define BUTTON_DFU     PINNUM(0, 11)
+#define BUTTON_DFU_OTA PINNUM(0, 12)
 #define BUTTON_PULL    NRF_GPIO_PIN_PULLUP
 
 //--------------------------------------------------------------------+
 // BLE OTA
 //--------------------------------------------------------------------+
-#define BLEDIS_MANUFACTURER  "Atelier-Du-Maker"
-#define BLEDIS_MODEL         "ADM_B_NRF52840_1"
+#define BLEDIS_MANUFACTURER "Atelier-Du-Maker"
+#define BLEDIS_MODEL        "ADM_B_NRF52840_1"
 
 //--------------------------------------------------------------------+
 // USB
 //--------------------------------------------------------------------+
 
-#define USB_DESC_VID           0x239A
-#define USB_DESC_UF2_PID       0x009F
-#define USB_DESC_CDC_ONLY_PID  0x009F
+#define USB_DESC_VID          0x239A
+#define USB_DESC_UF2_PID      0x009F
+#define USB_DESC_CDC_ONLY_PID 0x009F
 
 //------------- UF2 -------------//
-#define UF2_PRODUCT_NAME  "AtelierDuMaker NRF52840 Breakout"
-#define UF2_VOLUME_LABEL   "ADM840BOOT"
-#define UF2_BOARD_ID      "ADM_B_NRF52840_1"
-#define UF2_INDEX_URL     "https://github.com/Atelier-Du-Maker/HolyIoT_NRF52840"
+#define UF2_PRODUCT_NAME "AtelierDuMaker NRF52840 Breakout"
+#define UF2_VOLUME_LABEL "ADM840BOOT"
+#define UF2_BOARD_ID     "ADM_B_NRF52840_1"
+#define UF2_INDEX_URL    "https://github.com/Atelier-Du-Maker/HolyIoT_NRF52840"
 
 #endif // ADM_B_NRF52840_1_H

src/boards/ae_bl652_bo/board.h

@@ -28,27 +28,26 @@
 /*------------------------------------------------------------------*/
 /* LED
  *------------------------------------------------------------------*/
-#define LEDS_NUMBER        2
-#define LED_PRIMARY_PIN    17 // LED1
-#define LED_SECONDARY_PIN  19 // LED2
-#define LED_STATE_ON       1
+#define LEDS_NUMBER       2
+#define LED_PRIMARY_PIN   17 // LED1
+#define LED_SECONDARY_PIN 19 // LED2
+#define LED_STATE_ON      1
 
 /*------------------------------------------------------------------*/
 /* BUTTON
  *------------------------------------------------------------------*/
-#define BUTTONS_NUMBER     2
-#define BUTTON_1           11 // BTN1
-#define BUTTON_2           15 // BTN2
-#define BUTTON_PULL        NRF_GPIO_PIN_PULLUP
+#define BUTTON_DFU     11 // BTN1
+#define BUTTON_DFU_OTA 15 // BTN2
+#define BUTTON_PULL    NRF_GPIO_PIN_PULLUP
 
 /*------------------------------------------------------------------*/
 /* UART (only used by nRF52832)
  *------------------------------------------------------------------*/
-#define RX_PIN_NUMBER      8
-#define TX_PIN_NUMBER      6
-#define CTS_PIN_NUMBER     0
-#define RTS_PIN_NUMBER     0
-#define HWFC               false
+#define RX_PIN_NUMBER  8
+#define TX_PIN_NUMBER  6
+#define CTS_PIN_NUMBER 0
+#define RTS_PIN_NUMBER 0
+#define HWFC           false
 
 //--------------------------------------------------------------------+
 // BLE OTA

src/boards/aramcon2_badge/board.h

@@ -25,41 +25,38 @@
 #ifndef _ARAMCON2_BADGE_H
 #define _ARAMCON2_BADGE_H
 
-#define _PINNUM(port, pin)    ((port)*32 + (pin))
-
 /*------------------------------------------------------------------*/
 /* LED
  *------------------------------------------------------------------*/
-#define LEDS_NUMBER           1
-#define LED_PRIMARY_PIN       _PINNUM(1, 11) // Red
+#define LEDS_NUMBER          1
+#define LED_PRIMARY_PIN      PINNUM(1, 11) // Red
 
-#define LED_NEOPIXEL          _PINNUM(0, 8)
-#define NEOPIXELS_NUMBER      2
-#define BOARD_RGB_BRIGHTNESS  0x040404
+#define LED_NEOPIXEL         PINNUM(0, 8)
+#define NEOPIXELS_NUMBER     2
+#define BOARD_RGB_BRIGHTNESS 0x040404
 
 /*------------------------------------------------------------------*/
 /* BUTTON
  *------------------------------------------------------------------*/
-#define BUTTONS_NUMBER        2
-#define BUTTON_1              _PINNUM(0, 2) // left Button
-#define BUTTON_2              _PINNUM(0, 29) // middle button
-#define BUTTON_PULL           NRF_GPIO_PIN_PULLUP
+#define BUTTON_DFU     PINNUM(0, 2)  // left Button
+#define BUTTON_DFU_OTA PINNUM(0, 29) // middle button
+#define BUTTON_PULL    NRF_GPIO_PIN_PULLUP
 
 // Used as model string in OTA mode
-#define BLEDIS_MANUFACTURER   "ARAMCON Badge Team"
-#define BLEDIS_MODEL          "ARAMCON2 Badge"
+#define BLEDIS_MANUFACTURER "ARAMCON Badge Team"
+#define BLEDIS_MODEL        "ARAMCON2 Badge"
 
 //--------------------------------------------------------------------+
 // USB
 //--------------------------------------------------------------------+
-#define USB_DESC_VID           0x239A
-#define USB_DESC_UF2_PID       0x007B
-#define USB_DESC_CDC_ONLY_PID  0x007B
+#define USB_DESC_VID          0x239A
+#define USB_DESC_UF2_PID      0x007B
+#define USB_DESC_CDC_ONLY_PID 0x007B
 
 //------------- UF2 -------------//
-#define UF2_PRODUCT_NAME   "ARAMCON2 Badge"
-#define UF2_VOLUME_LABEL   "ARAMBOOT"
-#define UF2_BOARD_ID       "nrf52840-ARAMCON2-Badge"
-#define UF2_INDEX_URL      "https://github.com/aramcon-badge"
+#define UF2_PRODUCT_NAME "ARAMCON2 Badge"
+#define UF2_VOLUME_LABEL "ARAMBOOT"
+#define UF2_BOARD_ID     "nrf52840-ARAMCON2-Badge"
+#define UF2_INDEX_URL    "https://github.com/aramcon-badge"
 
 #endif // _ARAMCON2_BADGE_H

src/boards/aramcon_badge_2019/board.h

@@ -26,43 +26,40 @@
 #ifndef _ARAMCON_BADGE_2019_H
 #define _ARAMCON_BADGE_2019_H
 
-#define _PINNUM(port, pin)    ((port)*32 + (pin))
-
 /*------------------------------------------------------------------*/
 /* LED
  *------------------------------------------------------------------*/
-#define LEDS_NUMBER           1
-#define LED_PRIMARY_PIN       _PINNUM(1, 11) // Red
+#define LEDS_NUMBER          1
+#define LED_PRIMARY_PIN      PINNUM(1, 11) // Red
 
-#define LED_NEOPIXEL          _PINNUM(0, 8)
-#define NEOPIXELS_NUMBER      4
-#define BOARD_RGB_BRIGHTNESS  0x040404
+#define LED_NEOPIXEL         PINNUM(0, 8)
+#define NEOPIXELS_NUMBER     4
+#define BOARD_RGB_BRIGHTNESS 0x040404
 
 /*------------------------------------------------------------------*/
 /* BUTTON
  *------------------------------------------------------------------*/
-#define BUTTONS_NUMBER        2
-#define BUTTON_1              _PINNUM(0, 2) // left Button
-#define BUTTON_2              _PINNUM(0, 29) // middle button
-#define BUTTON_PULL           NRF_GPIO_PIN_PULLUP
+#define BUTTON_DFU     PINNUM(0, 2)  // left Button
+#define BUTTON_DFU_OTA PINNUM(0, 29) // middle button
+#define BUTTON_PULL    NRF_GPIO_PIN_PULLUP
 
 //--------------------------------------------------------------------+
 // BLE OTA
 //--------------------------------------------------------------------+
-#define BLEDIS_MANUFACTURER   "ARAMCON Badge Team"
-#define BLEDIS_MODEL          "ARAMCON Badge 2019"
+#define BLEDIS_MANUFACTURER "ARAMCON Badge Team"
+#define BLEDIS_MODEL        "ARAMCON Badge 2019"
 
 //--------------------------------------------------------------------+
 // USB
 //--------------------------------------------------------------------+
-#define USB_DESC_VID           0x239A
-#define USB_DESC_UF2_PID       0x0079
-#define USB_DESC_CDC_ONLY_PID  0x0079
+#define USB_DESC_VID          0x239A
+#define USB_DESC_UF2_PID      0x0079
+#define USB_DESC_CDC_ONLY_PID 0x0079
 
 //------------- UF2 -------------//
-#define UF2_PRODUCT_NAME   "ARAMCON Badge 2019"
-#define UF2_VOLUME_LABEL   "ARAMBOOT"
-#define UF2_BOARD_ID       "nrf52840-ARAMCON-Badge-2019"
-#define UF2_INDEX_URL      "https://github.com/aramcon-badge"
+#define UF2_PRODUCT_NAME "ARAMCON Badge 2019"
+#define UF2_VOLUME_LABEL "ARAMBOOT"
+#define UF2_BOARD_ID     "nrf52840-ARAMCON-Badge-2019"
+#define UF2_INDEX_URL    "https://github.com/aramcon-badge"
 
 #endif // _ARAMCON_BADGE_2019_H