Cellular: update handbook to 5.11 #843
Merged
Conversation
This file contains hidden or 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
AriParkkila
approved these changes
Nov 20, 2018
|
@AnotherButler please review |
|
@ARMmbed/mbed-docs please review as Amanda is out of office. |
|
This will probably have to wait for Amanda. We have a release and an OOB campaign this week for other products. |
|
Is there a code dependency on this PR? |
| @@ -4,13 +4,13 @@ | |||
|
|
|||
| The CellularBase provides a C++ API for connecting to the internet over a Cellular device. | |||
|
|
|||
| Arm Mbed OS provides a [reference implementation of CellularBase](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/_easy_cellular_connection_8h_source.html), which has more information. | |||
| Arm Mbed OS provides a [reference implementation of CellularBase](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/_cellular_context_8h_source.html), which has more information. | |||
There was a problem hiding this comment.
Query: Why do we link to the same Doxy page three times on the same page? Could we get rid of two?
There was a problem hiding this comment.
Good point, removed two links.
| @@ -119,7 +136,7 @@ Consider the following points when selecting PPP or AT mode: | |||
|
|
|||
| ### Optimize for power consumption | |||
|
|
|||
| The `CellularPower` class has methods to optimize power saving. The `set_powerl_level()` offers flexibility to control the reception and transmission power levels. In addition, 3GPP has specified advanced power optimizations that are useful for celluar IoT devices: Power Save Mode (PSM) and extended Discontinuous Reception (eDRX). | |||
| The `CellularPower` class has methods to optimize power saving. The `set_power_level()` offers flexibility to control the reception and transmission power levels. In addition, 3GPP has specified advanced power optimizations that are useful for celluar IoT devices: Power Save Mode (PSM) and extended Discontinuous Reception (eDRX). | |||
Edit file, mostly for active voice.
|
|
||
| Cellular APIs are structured based on main functionalities: | ||
|
|
||
| - `CellularNetwork` for cellular network features, such as preferred operator and APN. | ||
| - `CellularContext` is the main interface for the application. You can use it to connect to the operator's APN. |
There was a problem hiding this comment.
Query: What does APN stand for?
There was a problem hiding this comment.
Access Point Name: https://en.wikipedia.org/wiki/Access_Point_Name
|
Spell out abbreviation to avoid confusion.
AnotherButler
approved these changes
Nov 27, 2018
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.
Updated cellular parts to match current implementation after refactoring.
@AriParkkila please review.