Add consistent button names across targets #4249

kegilbert · 2017-04-28T16:52:42Z

Description

There's currently no standardization across device switch names (as we do with LED names). This change maps currently existing switch mappings to a 1-indexed BUTTON name.

Related to #4032

Migrations

This change does not modify any existing applications, it only provides a new button name option.

Testing

Built without error and tested functionality on a K64F

Concerns

The DELTA_DFCM_NNN40 uses BUTTON0 as its mapped name already so I did not modify that file.

I did not touch all targets, I started with targets that defined switches in some way in PinNames.h through an automated script and may have missed some. Pushing forward with the bulk of what I have.

cc
@mray19027 @bridadan

Revert HRM1017 file source deletion Added in small comment next to additions Added mapping to BTN-labelled switches Added mapping to USER_BUTTON-labelled switches Undo incorrect mapping to SWIO pin in NORDIC target

kegilbert · 2017-04-28T18:03:38Z

targets/TARGET_STM/TARGET_STM32F3/TARGET_STM32F303x8/TARGET_NUCLEO_F303K8/PinNames.h

@@ -104,6 +104,8 @@ typedef enum {
    LED3        = PB_3,
    LED4        = PB_3,
    USER_BUTTON = 0x20, // no user button on the board


This switch is specified as not existing, left the new button map in but could also pull it out since it's not really needed.

@bcostm Is this used in the apps somewhere? I assume as all of ST are defining USER_BUTTON

There is no user button on the small Nucleo 32 pins boards like this one. This definition was probably left by mistake...

bridadan · 2017-04-28T18:05:40Z

This looks great, nice work @kegilbert! I will do a more in depth review in future.

@sg- or @0xc0170 may just want to take a look at this since it touches so many targets. Can't imagine this is too controversial though!

0xc0170

Plenty targets define USER_BUTTON, or USER_BUTTONx. BUTTONx schema sounds fine to me. What is a requirement - a target might not have any button ? How this can be tested?

0xc0170 · 2017-05-02T09:49:32Z

targets/TARGET_STM/TARGET_STM32F3/TARGET_STM32F303x8/TARGET_NUCLEO_F303K8/PinNames.h

@@ -104,6 +104,8 @@ typedef enum {
    LED3        = PB_3,
    LED4        = PB_3,
    USER_BUTTON = 0x20, // no user button on the board


@bcostm Is this used in the apps somewhere? I assume as all of ST are defining USER_BUTTON

bridadan

I caught a few missing definitions, but honestly other than that everything looks good to me!

bridadan · 2017-05-02T14:47:45Z

targets/TARGET_Maxim/TARGET_MAX32620/TARGET_MAX32620HSP/PinNames.h

+    // Standardized button names
+    BUTTON1 = SW1,
+    BUTTON2 = SW2,
+    BUTTON3 = SW3,


This is an interesting one actually, since SW2 and SW3 aren't actually connected. In this case I'd say let's not add any BUTTONx definitions. I'd rather this fail at compile time. What do you think @0xc0170?

bridadan · 2017-05-02T14:48:01Z

targets/TARGET_Maxim/TARGET_MAX32630/TARGET_MAX32630FTHR/PinNames.h

+    // Standardized button names
+    BUTTON1 = SW1,
+    BUTTON2 = SW2,
+    BUTTON3 = SW3,


Same here regarding not connected buttons.

bridadan · 2017-05-02T14:48:38Z

targets/TARGET_ONSEMI/TARGET_NCS36510/PinNames.h

@@ -128,6 +128,8 @@ typedef enum {
    LED_YELLOW  = GPIO6,
    LED_BLUE    = GPIO5,
    USER_BUTTON = GPIO7,  /*NEW connection on NCS36510-RF Rev 1.1 - Alias of SW1 */
+    // Standardized button names
+    BUTTON1 = USER_BUTTON,
    SW1 = GPIO7,  /*NEW connection on NCS36510-RF Rev 1.1 */
    SW2 = GPIO10,   /*NEW connection on NCS36510-RF Rev 1.1 */


Looks like SW2 was missed.

Interesting, that was a failure on my script end I'll add those in. Good catch!

bridadan · 2017-05-02T14:50:48Z

targets/TARGET_STM/TARGET_STM32L4/TARGET_STM32L476xG/TARGET_DISCO_L476VG/PinNames.h

@@ -142,6 +142,8 @@ typedef enum {
    JOYSTICK_UP = PA_3,
    JOYSTICK_DOWN = PA_5,
    USER_BUTTON = JOYSTICK_CENTER,
+    // Standardized button names
+    BUTTON1 = USER_BUTTON,


Huh, had never considered how to handle joysticks! Could potentially even add BUTTON2-5 for each direction, though I think ST could always add that if they wanted to. I think you've handled it nicely here.

… buttons

bridadan · 2017-05-02T18:10:39Z

targets/TARGET_ONSEMI/TARGET_NCS36510/PinNames.h

+
+    // Standardized button names
+    BUTTON1 = USER_BUTTON,
+    BUTTON2 = SW1,


Still not quite right, USER_BUTTON and SW1 both map to GPIO7. I would think the correct definitions would be as follows:

BUTTON1 = SW1, BUTTON2 = SW2,

bridadan · 2017-05-02T18:12:03Z

targets/TARGET_STM/TARGET_STM32L4/TARGET_STM32L476xG/TARGET_DISCO_L476VG/PinNames.h

+    // Standardized button names
+    BUTTON1 = USER_BUTTON,
+    BUTTON2 = JOYSTICK_LEFT,
+    BUTTON3 = JOYSTICK_RIGH,


Travis caught a typo here. This should be BUTTON3 = JOYSTICK_RIGHT,, not BUTTON3 = JOYSTICK_RIGH,. Looks like a T was dropped 😄

0xc0170 · 2017-05-03T14:06:12Z

/morph test

mbed-bot · 2017-05-03T16:22:37Z

Result: SUCCESS

Your command has finished executing! Here's what you wrote!

/morph test

Output

mbed Build Number: 138

All builds and test passed!

theotherjimmy · 2017-05-03T16:26:30Z

Looks good. No outstanding problems. Merging.

sg- · 2017-05-03T19:01:08Z

Seems OK but where are the docs and guidelines so the next 100 boards coming dont skip adding this?

bridadan · 2017-05-03T19:06:41Z

@sg- good point. Where is the appropriate place to put docs/guidelines for mbed OS?

sg- · 2017-05-03T19:19:15Z

How does @geky make the cool ascii shrug character?!?

I'd suggest getting with @AnotherButler to find a place or create one if it doesnt exist. Probably in the porting guide around a section that describes what should be in PinNames.h and if there should be an extension (macros say) where an alias is created. Eventually PinNames needs to be broken apart for MCU and board and I think this could be the tipping point to put together. @theotherjimmy should have thoughts on this with current work around targets and such.

geky · 2017-05-03T19:48:45Z

@sg- ¯\_(ツ)_/¯

theotherjimmy · 2017-05-03T19:50:49Z

Poring guide is a good start. https://docs.mbed.com/docs/mbed-os-handbook/en/latest/advanced/porting_guide/

theotherjimmy · 2017-05-03T19:55:17Z

@sg- that's the /shrug command in slack.

…lwip_broadcast Release mbed OS 5.4.5 and mbed lib v142 Ports for Upcoming Targets Fixes and Changes 4059: [Silicon Labs] Rename targets ARMmbed#4059 4115: Support for Qt Creator Generic project export and associated Makefile ARMmbed#4115 3915: Feature vscode ARMmbed#3915 4205: tests: race test - add not supported for single threaded env ARMmbed#4205 4187: [NCS36510] Reduce default heap size allocated by IAR to 1/4 of RAM ARMmbed#4187 4145: test - add nanostack to examples.json file ARMmbed#4145 4093: Update.py: New feature - update a branch instead of a fork, plus general improvements. ARMmbed#4093 4225: fixed missing device_name for xDot and removed progen ARMmbed#4225 4243: Config: config header file should contain new line ARMmbed#4243 4251: Fix C++11 build error w/ u-blox EVK-ODIN-W2 ARMmbed#4251 4236: STM32 Fixed warning related to __packed redefinition ARMmbed#4236 4224: Add `mbed new .` output to export ARMmbed#4224 4190: LPC4088: Enable LWIP feature ARMmbed#4190 4136: Error when bootloader is specified but does not exist ARMmbed#4136 3881: Remove debug links to printf/exit in NDEBUG builds ARMmbed#3881 4260: Inherit Xadow M0 target from LPC11U35_501 ARMmbed#4260 4249: Add consistent button names across targets ARMmbed#4249 4254: Removed unused variable in TARGET_NXP/lpc17_emac.c ARMmbed#4254

UBLOX_ODIN_EVK_W2 is missing the abstract button definitions originally introduced with PR ARMmbed#4249. Fix two tab to spaces issues on the go as well.

UBLOX_ODIN_EVK_W2 is missing the abstract button definitions originally introduced with PR #4249. Fix two tab to spaces issues on the go as well.

Ports for Upcoming Targets Fixes and Changes 4059: [Silicon Labs] Rename targets ARMmbed/mbed-os#4059 4187: [NCS36510] Reduce default heap size allocated by IAR to 1/4 of RAM ARMmbed/mbed-os#4187 4225: fixed missing device_name for xDot and removed progen ARMmbed/mbed-os#4225 4251: Fix C++11 build error w/ u-blox EVK-ODIN-W2 ARMmbed/mbed-os#4251 4236: STM32 Fixed warning related to __packed redefinition ARMmbed/mbed-os#4236 4190: LPC4088: Enable LWIP feature ARMmbed/mbed-os#4190 4260: Inherit Xadow M0 target from LPC11U35_501 ARMmbed/mbed-os#4260 4249: Add consistent button names across targets ARMmbed/mbed-os#4249

kegilbert added 3 commits April 27, 2017 18:42

Adding consistent button pin mappings

77cc87b

Added mapping to BTN-labelled switches

83a5107

Added mapping to USER_BUTTON-labelled switches

28d1ac5

Revert HRM1017 file source deletion Added in small comment next to additions Added mapping to BTN-labelled switches Added mapping to USER_BUTTON-labelled switches Undo incorrect mapping to SWIO pin in NORDIC target

theotherjimmy added the needs: review label Apr 28, 2017

kegilbert commented Apr 28, 2017

View reviewed changes

bridadan self-assigned this Apr 28, 2017

0xc0170 reviewed May 2, 2017

View reviewed changes

bridadan reviewed May 2, 2017

View reviewed changes

Addressed review comments: fixed unmapped switches and added Hexiware…

418d83b

… buttons

bridadan suggested changes May 2, 2017

View reviewed changes

Fixed typos

0268c85

bridadan approved these changes May 2, 2017

View reviewed changes

0xc0170 approved these changes May 3, 2017

View reviewed changes

0xc0170 added needs: CI and removed needs: review labels May 3, 2017

theotherjimmy merged commit 0c2af26 into ARMmbed:master May 3, 2017

theotherjimmy added release-version: 5.4.5 and removed needs: CI labels May 3, 2017

bridadan mentioned this pull request May 3, 2017

Add a BUTTON PinName (to targets who have buttons) #4032

Closed

kegilbert mentioned this pull request Aug 17, 2017

UBLOX_EVK_ODIN_W2 missing BUTTON1 definition #4880

Closed

JanneKiiskila mentioned this pull request Aug 22, 2017

UBLOX_EVK_ODIN_W2- add BUTTON1/2 definitions #4951

Merged

2 tasks

adbridge pushed a commit that referenced this pull request Sep 12, 2017

UBLOX_ODIN_EVK_W2 - add BUTTON1/2 definitions

09ac9d0

UBLOX_ODIN_EVK_W2 is missing the abstract button definitions originally introduced with PR #4249. Fix two tab to spaces issues on the go as well.

adbridge pushed a commit that referenced this pull request Sep 13, 2017

UBLOX_ODIN_EVK_W2 - add BUTTON1/2 definitions

8ec21de

UBLOX_ODIN_EVK_W2 is missing the abstract button definitions originally introduced with PR #4249. Fix two tab to spaces issues on the go as well.

ruevs mentioned this pull request Nov 27, 2018

Mbed 2 builds are broken (was: ff_lpc546xx: Library name 'platform' is not unique) #5887

Closed

ruevs mentioned this pull request Oct 8, 2019

The online compiler fails to build the Xadow-M0 target with MBED2 rev. 142 and later. #11652

Closed

Add consistent button names across targets #4249

Add consistent button names across targets #4249

Uh oh!

Conversation

kegilbert commented Apr 28, 2017

Description

Migrations

Testing

Concerns

Uh oh!

kegilbert Apr 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xc0170 May 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bridadan commented Apr 28, 2017

Uh oh!

0xc0170 left a comment

Choose a reason for hiding this comment

Uh oh!

0xc0170 May 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bridadan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xc0170 commented May 3, 2017

Uh oh!

mbed-bot commented May 3, 2017

Output

Uh oh!

theotherjimmy commented May 3, 2017

Uh oh!

sg- commented May 3, 2017

Uh oh!

bridadan commented May 3, 2017

Uh oh!

sg- commented May 3, 2017

Uh oh!

geky commented May 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theotherjimmy commented May 3, 2017

Uh oh!

theotherjimmy commented May 3, 2017

Uh oh!

Uh oh!

kegilbert Apr 28, 2017 •

edited

Loading

0xc0170 May 2, 2017 •

edited

Loading

0xc0170 May 2, 2017 •

edited

Loading

geky commented May 3, 2017 •

edited

Loading