Skip to content

cellular update #433

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

Merged
merged 5 commits into from Mar 12, 2018
Merged

cellular update #433

merged 5 commits into from Mar 12, 2018

Conversation

ghost
Copy link

@ghost ghost commented Mar 6, 2018

No description provided.

@ghost
Copy link
Author

ghost commented Mar 6, 2018

@AnotherButler @AnttiKauppila please review

Copy edit, mostly for active voice and fixing some minor details left in the mesh section previously.
Copy link
Contributor

@AnotherButler AnotherButler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work on this. I left two queries about finding links in Doxygen.

#### Cellular

The [CellularBase](/docs/v5.7/mbed-os-api-doxy/class_cellular_base.html) provides a C++ API for connecting to the internet over a Cellular device.

Arm Mbed OS provides a [reference implementation of CellularBase](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_modem_driver).
Arm Mbed OS provides a [reference implementation of CellularBase](https://github.com/ARMmbed/mbed-os/tree/master/features/cellular/easy_cellular).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query: Does this content exist in Doxyen? If so, I'll link there.

Copy link
Author

@ghost ghost Mar 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AnotherButler Not yet because 5.8 content is not yet available in Doxygen. And is easy_cellular going to be added to a Doxygen website?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TeemuKultala Could you please use https://github.com/ARMmbed/mbed-os/pull/6280/files as an example to be sure the Doxygen generates?

@@ -151,11 +132,30 @@ You can use and extend a cellular interface in various different ways. For examp

<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/Cell_PPP.png)</span>

[`mbed-os-example-cellular`](https://github.com/ARMmbed/mbed-os-example-cellular) uses [a generic modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_modem_driver). In other words, CellularInterface uses PPP. We can summarize this particular design as follows:
[`mbed-os-example-cellular`](https://github.com/ARMmbed/mbed-os-example-cellular) uses [an easy cellular connection](https://github.com/ARMmbed/mbed-os/tree/master/features/cellular/easy_cellular). It depends on the modem whether the application uses PPP or AT mode. We can summarize this particular design as follows:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query: Does this content exist in Doxyen? If so, I'll link there.

Copy link
Author

@ghost ghost Mar 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AnotherButler Not yet because 5.8 content is not yet available in Doxygen. And is easy_cellular going to be added to a Doxygen website?

@AnotherButler AnotherButler merged commit b4320a5 into ARMmbed:new_engine Mar 12, 2018
@ghost ghost deleted the overview_changes branch March 28, 2018 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants