Renaming prior to the delivery of the work about "NFC Commissioning". #36555
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
|
Review changes with |
|
|
github-actions
bot
added
documentation
|
PR #36555: Size comparison from 649c19f to 8ce9992 Full report (3 builds for cc32xx, stm32)
|
|
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)
|
Damian-Nordic
approved these changes
Nov 19, 2024
|
PR #36555: Size comparison from 88148b5 to dff6d07 Full report (80 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
|
As discussed in Slack I would also prefer using the term Tag instead of Onboarding. |
|
I have done a new PR replacing this one: #36801 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Defines, variables and files have been renamed to reflect this. The following renaming have been done:
The following files have been renamed :
for the platforms: