Cellular: Refine API usage guidelines #1176
Conversation
| @AnttiKauppila please review. |
| @kjbracey-arm |
| | ||
| This document provides guidelines how to make a cellular device adaptation for Mbed OS. | ||
| | ||
| **Note:** Application developers should use only the `API` folder where Cellular public API is defined. All other Cellular APIs are considered as internal APIs and can change in between any release. If modem vendors want their drivers to be maintained for internal API changes, they need to contribute their drivers to mbed-os/master. |
There was a problem hiding this comment.
I note this would mean that the proposed get_at_handler()->get_file_handle() in the proposed deprecation of CellularDevice::get_file_handle() would be a redirection to a non-public API.
There was a problem hiding this comment.
Good point, ATHandler should probably be part of public API.
Update note formatting, and shorten text for brevity.
| Is this content in addition to a blog post or in place of a blog post? I couldn't tell from the |
@AriParkkila @kjbracey-arm are either of you able to answer Amanda's question ? |
| Sorry, no idea. Concept itself is plausible, and I approve of it, but I don't if this is otherwise being communicated. It would make sense to be in the 5.15 release notes, at least. |
5 participants
No description provided.