Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renaming prior to the delivery of the work about "NFC Commissioning". #36555

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

OlivierGre
Copy link

In current code, "NFC Commissioning" was used for Onboarding data put into an NFC Tag. This naming will create confusion with the new "NFC Commissioning" feature where NFC is used for all the first phase of the commissioning.

We propose to use the folllowing names:

  • "NFC onboarding" when an NFC Tag is used to store the onboarding data (as an alternate solution to QRCode)
  • "NFC commissioning" when an NFC Tag is used to perform the first commissioning phase (as an alternate solution to BLE)

Defines, variables and files have been renamed to reflect this. The following renaming have been done:

  • CHIP_DEVICE_CONFIG_ENABLE_NFC -> CHIP_DEVICE_CONFIG_ENABLE_NFC_ONBOARDING
  • CONFIG_CHIP_NFC_COMMISSIONING -> CONFIG_CHIP_NFC_ONBOARDING
  • chip_enable_nfc -> chip_enable_nfc_onboarding
  • NFCManager -> NFCOnboardingManager
  • NFCManagerImpl -> NFCOnboardingManagerImpl
  • NFCMgr -> NFCOnboardingMgr
  • NFCMgrImpl -> NFCOnboardingMgrImpl

The following files have been renamed :

  • NFCManagerImpl.cpp -> NFCOnboardingManagerImpl.cpp
  • NFCManagerImpl.h -> NFCOnboardingManagerImpl.h
  • NFCManager.h -> NFCOnboardingManager.h

for the platforms:

  • Zephyr,
  • nrfconnect,
  • nxp/k32w0
  • telink

In current code, "NFC Commissioning" was used for Onboarding data put into an NFC Tag.
This naming will create confusion with the new "NFC Commissioning" feature
where NFC is used for all the first phase of the commissioning.

We propose to use the folllowing names:
- "NFC onboarding" when an NFC Tag is used to store the onboarding data
(as an alternate solution to QRCode)
- "NFC commissioning" when an NFC Tag is used to perform the first commissioning phase
(as an alternate solution to BLE)

Defines, variables and files have been renamed to reflect this.
The following renaming have been done:
- CHIP_DEVICE_CONFIG_ENABLE_NFC -> CHIP_DEVICE_CONFIG_ENABLE_NFC_ONBOARDING
- CONFIG_CHIP_NFC_COMMISSIONING -> CONFIG_CHIP_NFC_ONBOARDING
- chip_enable_nfc -> chip_enable_nfc_onboarding
- NFCManager -> NFCOnboardingManager
- NFCManagerImpl -> NFCOnboardingManagerImpl
- NFCMgr -> NFCOnboardingMgr
- NFCMgrImpl -> NFCOnboardingMgrImpl

The following files have been renamed for the platforms Zephyr, nrfconnect, nxp/k32w0 and telink:
NFCManagerImpl.cpp -> NFCOnboardingManagerImpl.cpp
NFCManagerImpl.h -> NFCOnboardingManagerImpl.h
NFCManager.h -> NFCOnboardingManager.h
@OlivierGre OlivierGre requested review from a team as code owners November 19, 2024 13:50
Copy link

Review changes with  SemanticDiff

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

PR #36555: Size comparison from 649c19f to 8ce9992

Full report (3 builds for cc32xx, stm32)
platform target config section 649c19f 8ce9992 change % change
cc32xx air-purifier CC3235SF_LAUNCHXL FLASH 628662 628662 0 0.0
RAM 205792 205792 0 0.0
lock CC3235SF_LAUNCHXL FLASH 667242 667242 0 0.0
RAM 205936 205936 0 0.0
stm32 light STM32WB5MM-DK FLASH 482944 482944 0 0.0
RAM 144848 144848 0 0.0

@OlivierGre OlivierGre marked this pull request as draft November 19, 2024 14:55
Copy link

github-actions bot commented Nov 19, 2024

PR #36555: Size comparison from 649c19f to 4f46422

Full report (80 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
platform target config section 649c19f 4f46422 change % change
bl602 lighting-app bl602+mfd+littlefs+rpc FLASH 1349448 1349448 0 0.0
RAM 104080 104080 0 0.0
bl702 lighting-app bl702+eth FLASH 649334 649334 0 0.0
RAM 25329 25329 0 0.0
bl702+wifi FLASH 826914 826914 0 0.0
RAM 14069 14069 0 0.0
bl706+mfd+rpc+littlefs FLASH 1055112 1055112 0 0.0
RAM 23909 23909 0 0.0
bl702l lighting-app bl702l+mfd+littlefs FLASH 976486 976486 0 0.0
RAM 16556 16556 0 0.0
cc13x4_26x4 lighting-app LP_EM_CC1354P10_6 FLASH 837852 837852 0 0.0
RAM 123632 123632 0 0.0
lock-ftd LP_EM_CC1354P10_6 FLASH 823768 823768 0 0.0
RAM 125520 125520 0 0.0
pump-app LP_EM_CC1354P10_6 FLASH 770492 770492 0 0.0
RAM 113988 113988 0 0.0
pump-controller-app LP_EM_CC1354P10_6 FLASH 754704 754704 0 0.0
RAM 114196 114196 0 0.0
cc32xx air-purifier CC3235SF_LAUNCHXL FLASH 628662 628662 0 0.0
RAM 205792 205792 0 0.0
lock CC3235SF_LAUNCHXL FLASH 667242 667242 0 0.0
RAM 205936 205936 0 0.0
cyw30739 light CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 679489 679489 0 0.0
RAM 78692 78692 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 699333 699333 0 0.0
RAM 81324 81324 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 699333 699333 0 0.0
RAM 81324 81324 0 0.0
CYW930739M2EVB-02 unknown 2040 2040 0 0.0
FLASH 656277 656277 0 0.0
RAM 73760 73760 0 0.0
light-switch CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 616345 616345 0 0.0
RAM 71644 71644 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 635973 635973 0 0.0
RAM 74196 74196 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 635973 635973 0 0.0
RAM 74196 74196 0 0.0
lock CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 635801 635801 0 0.0
RAM 74692 74692 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 655509 655509 0 0.0
RAM 77244 77244 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 655509 655509 0 0.0
RAM 77244 77244 0 0.0
thermostat CYW30739B2-P5-EVK-01 unknown 2040 2040 0 0.0
FLASH 612285 612285 0 0.0
RAM 68780 68780 0 0.0
CYW30739B2-P5-EVK-02 unknown 2040 2040 0 0.0
FLASH 632137 632137 0 0.0
RAM 71412 71412 0 0.0
CYW30739B2-P5-EVK-03 unknown 2040 2040 0 0.0
FLASH 632137 632137 0 0.0
RAM 71412 71412 0 0.0
efr32 lock-app BRD4187C FLASH 927596 927596 0 0.0
RAM 160164 160164 0 0.0
BRD4338a FLASH 743696 743688 -8 -0.0
RAM 233296 233296 0 0.0
window-app BRD4187C FLASH 1018816 1018808 -8 -0.0
RAM 128264 128264 0 0.0
esp32 all-clusters-app c3devkit DRAM 95344 95344 0 0.0
FLASH 1541124 1541124 0 0.0
IRAM 82542 82542 0 0.0
m5stack DRAM 116264 116264 0 0.0
FLASH 1549766 1549766 0 0.0
IRAM 117039 117039 0 0.0
linux air-purifier-app debug unknown 4712 4712 0 0.0
FLASH 2702165 2702165 0 0.0
RAM 129736 129736 0 0.0
all-clusters-app debug unknown 5552 5552 0 0.0
FLASH 5993394 5993394 0 0.0
RAM 523464 523464 0 0.0
all-clusters-minimal-app debug unknown 5448 5448 0 0.0
FLASH 5331522 5331522 0 0.0
RAM 242520 242520 0 0.0
bridge-app debug unknown 5432 5432 0 0.0
FLASH 4671272 4671272 0 0.0
RAM 218464 218464 0 0.0
chip-tool debug unknown 5984 5984 0 0.0
FLASH 12830462 12830462 0 0.0
RAM 582226 582226 0 0.0
chip-tool-ipv6only arm64 unknown 21288 21288 0 0.0
FLASH 10966816 10966816 0 0.0
RAM 633144 633144 0 0.0
fabric-admin debug unknown 5808 5808 0 0.0
FLASH 11239405 11239405 0 0.0
RAM 582610 582610 0 0.0
fabric-bridge-app debug unknown 4688 4688 0 0.0
FLASH 4495542 4495542 0 0.0
RAM 205424 205424 0 0.0
fabric-sync debug unknown 4896 4896 0 0.0
FLASH 5529749 5529749 0 0.0
RAM 471232 471232 0 0.0
lighting-app debug+rpc+ui unknown 6096 6096 0 0.0
FLASH 5607217 5607217 0 0.0
RAM 228616 228616 0 0.0
lock-app debug unknown 5368 5368 0 0.0
FLASH 4720694 4720694 0 0.0
RAM 204632 204632 0 0.0
ota-provider-app debug unknown 4744 4744 0 0.0
FLASH 4346146 4346146 0 0.0
RAM 198304 198304 0 0.0
ota-requestor-app debug unknown 4680 4680 0 0.0
FLASH 4484580 4484580 0 0.0
RAM 202888 202888 0 0.0
shell debug unknown 4240 4240 0 0.0
FLASH 3016589 3016589 0 0.0
RAM 160368 160368 0 0.0
thermostat-no-ble arm64 unknown 9496 9496 0 0.0
FLASH 4093392 4093392 0 0.0
RAM 242984 242984 0 0.0
tv-app debug unknown 5664 5664 0 0.0
FLASH 5943813 5943813 0 0.0
RAM 595920 595920 0 0.0
tv-casting-app debug unknown 5232 5232 0 0.0
FLASH 11035981 11035981 0 0.0
RAM 691960 691960 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 FLASH 915852 909744 -6108 -0.7
RAM 143292 142988 -304 -0.2
nrf7002dk_nrf5340_cpuapp FLASH 888132 883668 -4464 -0.5
RAM 141479 141175 -304 -0.2
all-clusters-minimal-app nrf52840dk_nrf52840 FLASH 850048 844496 -5552 -0.7
RAM 142200 141896 -304 -0.2
light-switch-app nrf52840dk_nrf52840 FLASH 793452 787340 -6112 -0.8
RAM 132267 131963 -304 -0.2
nrf7002dk_nrf5340_cpuapp FLASH 937804 931468 -6336 -0.7
RAM 130840 130536 -304 -0.2
lighting-app nrf52840dk_nrf52840+rpc FLASH 885392 879288 -6104 -0.7
RAM 146685 146381 -304 -0.2
nrf52840dongle_nrf52840 FLASH 825244 819416 -5828 -0.7
RAM 154547 154243 -304 -0.2
nrf5340dk_nrf5340_cpuapp FLASH 781504 775168 -6336 -0.8
RAM 145695 145391 -304 -0.2
nrf7002dk_nrf5340_cpuapp FLASH 937804 931468 -6336 -0.7
RAM 130840 130536 -304 -0.2
lock-app nrf52840dk_nrf52840 FLASH 808576 802468 -6108 -0.8
RAM 132822 132518 -304 -0.2
nrf5340dk_nrf5340_cpuapp FLASH 734124 727792 -6332 -0.9
RAM 132952 132648 -304 -0.2
nrf7002dk_nrf5340_cpuapp FLASH 953864 947528 -6336 -0.7
RAM 131395 131091 -304 -0.2
pump-app nrf52840dk_nrf52840 FLASH 761512 755400 -6112 -0.8
RAM 131613 131309 -304 -0.2
pump-controller-app nrf52840dk_nrf52840 FLASH 746652 740540 -6112 -0.8
RAM 131372 131068 -304 -0.2
nxp contact k32w0+release FLASH 584112 584112 0 0.0
RAM 71048 71048 0 0.0
mcxw71+release FLASH 598640 598640 0 0.0
RAM 63144 63144 0 0.0
light k32w0+release FLASH 611172 611172 0 0.0
RAM 70440 70440 0 0.0
k32w1+release FLASH 684976 684976 0 0.0
RAM 48776 48776 0 0.0
lock mcxw71+release FLASH 748512 748512 0 0.0
RAM 67300 67300 0 0.0
psoc6 all-clusters cy8ckit_062s2_43012 FLASH 1643604 1643604 0 0.0
RAM 212072 212072 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 FLASH 1551596 1551596 0 0.0
RAM 208872 208872 0 0.0
light cy8ckit_062s2_43012 FLASH 1466620 1466620 0 0.0
RAM 200848 200848 0 0.0
lock cy8ckit_062s2_43012 FLASH 1464812 1464812 0 0.0
RAM 225208 225208 0 0.0
qpg lighting-app qpg6105+debug FLASH 662136 662136 0 0.0
RAM 105384 105384 0 0.0
lock-app qpg6105+debug FLASH 620244 620244 0 0.0
RAM 99836 99836 0 0.0
stm32 light STM32WB5MM-DK FLASH 482944 482944 0 0.0
RAM 144848 144848 0 0.0
telink bridge-app tlsr9258a FLASH 681264 681264 0 0.0
RAM 91200 91200 0 0.0
contact-sensor-app tlsr9528a_retention FLASH 619276 619276 0 0.0
RAM 50256 50256 0 0.0
light-app-ota-compress-lzma-shell-factory-data tl3218x FLASH 762558 762558 0 0.0
RAM 50208 50208 0 0.0
light-switch-app-ota-compress-lzma-shell-factory-data tlsr9528a FLASH 707200 707200 0 0.0
RAM 73476 73476 0 0.0
lighting-app-ota-factory-data tlsr9118bdk40d FLASH 625542 625542 0 0.0
RAM 142132 142132 0 0.0
lighting-app-ota-rpc-factory-data-4mb tlsr9518adk80d FLASH 811454 811454 0 0.0
RAM 99676 99676 0 0.0
tizen all-clusters-app arm unknown 4968 4968 0 0.0
FLASH 1723852 1723852 0 0.0
RAM 90640 90640 0 0.0
chip-tool-ubsan arm unknown 10776 10776 0 0.0
FLASH 17939086 17939086 0 0.0
RAM 7825976 7825976 0 0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants