-
Notifications
You must be signed in to change notification settings - Fork 3k
Renaming Ublox library for mbed cellular framework #6402
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
Conversation
Fine with the new name, but I think you should probably retain a typedef or simple inheritance with deprecation tag for the |
Agree with @kjbracey-arm on inheritance with current device name. @mudassar-ublox If you like, you could add a deprecation warning to the old name targeting 5.9. |
(cherry picked from commit 737609736591d12ea369d5b364d132e7a6367ae2)
1e673c8
to
eb806b6
Compare
@cmonr deprecated warnings have been added |
@@ -35,6 +35,11 @@ class UBLOX_LISA_U_CellularPower : public AT_CellularPower | |||
virtual nsapi_error_t off(); | |||
}; | |||
|
|||
class UBLOX_LISA_U_CellularPower : public UBLOX_PPP_CellularPower | |||
{ | |||
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, Use UBLOX_PPP_CellularPower instead of UBLOX_LISA_U_CellularPower."); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello, this isn't the correct way to mark a class as deprecated.
The deprecated attribute needs to be before the class:
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, Use UBLOX_PPP_CellularPower instead of UBLOX_LISA_U_CellularPower.")
class UBLOX_LISA_U_CellularPower : public UBLOX_PPP_CellularPower
{
blablabla
Otherwise this won't compile on GCC or ARM.
https://github.com/ARMmbed/mbed-os/blob/master/platform/mbed_toolchain.h#L297
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, I put a semi colon at the end of the deprecated warning and it compiled successfully.
Thanks for the correction. I have modified the code now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh that's interesting. Although the deprecated message still won't show up.
Thanks for fixing this 👍
/morph build |
Build : SUCCESSBuild number : 1586 Triggering tests/morph test |
Test : SUCCESSBuild number : 1375 |
Exporter Build : FAILUREBuild number : 1225 |
ARM license network issue. Will rebuild once CI gap is available. |
/morph export-build |
/morph mbed2-build |
@0xc0170 Might need you to restart these. Looks like GitHub is ignoring me again.. |
/morph export-build |
Exporter Build : SUCCESSBuild number : 1237 |
@kjbracey-arm @AnttiKauppila or @TeemuKultala @juhoeskeli please review |
Still holding for reviews. |
This is a valid change, but still UBLOX_PPP is not a very good name either...
I want to raise another relating concern here... Ublox-C027 (and ublox-C030) may have different cellular modules like LISA-C200, LISA-U200 or SARA-G350. From AT command point of view u-blox cellular module variation comes from type codes C (CDMA), U (UMTS) and G (GPRS) and associated platform version such as U2 or G3, so I think good naming could be something like "UBLOX_U2". Mbed OS detects at compile-time only board target ublox-C027 (mbedls target_id) and it does not know which cellular module type is actually mounted on the board. The problem is that we can't detect automatically at compile-time which cellular device type is mounted on the board. Is there any? |
@RobMeades please comment |
@AriParkkila: the plan is that u-blox will maintain a PPP-mode driver, which will work with all our of modems that support PPP mode, and one or more AT-mode driver, which will support these modems and others which have no PPP interface. The first driver will be Is there a reason why the above would not work? |
If cellular module variation can be handled at runtime then this is good. |
@AriParkkila @AnttiKauppila Can you approve/request changes please? |
Description
Renaming UBLOX target library form "UBLOX_LISA_U" to "UBLOX_PPP" for mbed cellular framework.
LISA is not a cellular technology, it is the physical shape of module. Technology used for cellular test is PPP, So changing name from LISA_U to PPP as suggested by @kjbracey-arm (Kevin Bracey).
Pull request type